Messages

Push Message

client.queues.messages.push(, , ?): MessagePushResponse { errors, messages, success }

POST/accounts/{account_id}/queues/{queue_id}/messages

Acknowledge + Retry Queue Messages

client.queues.messages.ack(, , ?): MessageAckResponse { ackCount, retryCount, warnings }

POST/accounts/{account_id}/queues/{queue_id}/messages/ack

Pull Queue Messages

client.queues.messages.pull(, , ?): MessagePullResponse { message_backlog_count, messages }

POST/accounts/{account_id}/queues/{queue_id}/messages/pull

Push Message Batch

client.queues.messages.bulkPush(, , ?): MessageBulkPushResponse { errors, messages, success }

POST/accounts/{account_id}/queues/{queue_id}/messages/batch

ModelsExpand Collapse

MessagePushResponse { errors, messages, success }

errors?: Array<ResponseInfo { code, message, documentation_url, source } >

minLength1

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages?: Array<string>

success?: true

Indicates if the API call was successful or not.

MessageAckResponse { ackCount, retryCount, warnings }

ackCount?: number

The number of messages that were succesfully acknowledged.

retryCount?: number

The number of messages that were succesfully retried.

warnings?: Array<string>

MessagePullResponse { message_backlog_count, messages }

message_backlog_count?: number

The number of unacknowledged messages in the queue

messages?: Array<Message>

id?: string

attempts?: number

body?: string

lease_id?: string

An ID that represents an "in-flight" message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message.

metadata?: unknown

timestamp_ms?: number

MessageBulkPushResponse { errors, messages, success }