Skip to main content
POST
Group message status

Authorizations

token
string
header
required

Body

application/json
id
string
required

Message ID (full or short).

Example:

"3EB0538DA65A59F6D8A251"

state
enum<string>

Only receipts in this state. Without it, all of them.

Available options:
Delivered,
Read,
Played
limit
integer
default:100

Items per page. Values above 500 use 500.

Required range: 1 <= x <= 500
offset
integer
default:0

Zero-based offset; use the pagination.nextOffset from the previous page.

Required range: x >= 0

Response

Summary and page of receipts, in chronological order.

source
enum<string>
required

Where the response came from: memory (confirmations the API tracked, added to the phone's previous response when there was one) or phone (the account's phone, in this query).

Available options:
memory,
phone
summary
object
required

Participant totals; the same on every page.

receipts
object[]
required
pagination
object
required