Skip to main content
GET
List the queue of a line
  • Credential: an API key of the owner of the line. See Reading the limits and the queue.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list, even when the line does not exist.
  • Events: none.
  • Personal data: each item carries the recipient’s number in to and the text in body. Request them only when needed, do not copy them into logs, tickets or other tools, and refer to a contact by an id of your own.
  • Item status: scheduled for a held message. queued for a message that waits for the line’s device, or that the device has and has not confirmed. delivered_to_device for a message whose status is sent: the device confirmed the send, and no delivery receipt has arrived. A delivered_to_device item stays listed until a receipt arrives or iSnap deletes the message, at least 72 hours after it recorded it.
  • Order: by scheduled_for, earliest first. queue_position starts at 1 and counts the items of the earlier pages. Without a status filter, it counts the delivered_to_device items too.
  • Pagination: a cursor, not tied to the status filter. limit is 1 to 100, 50 by default. An item can come back on a later page when iSnap holds its message again with a later scheduled_for: deduplicate on id. See Cursors.
  • Items: a queue item is not a message object: its body is "" where the message has null. Reaction entries are listed too.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Query Parameters

limit
integer
default:50

Number of items per page, from 1 to 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Omit it for the first page. A value that cannot be read restarts the list from the first page.

status
enum<string>

Keep the items of one status: scheduled, queued or delivered_to_device. Omit it for all three.

Available options:
queued,
scheduled,
delivered_to_device

Response

The queue of the line: a summary and one page of items.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The queue of a line: a summary and one page of items.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.