Intercom API (unofficial showcase)
GET/messages/status

List WhatsApp message status events

Lists paginated status events for WhatsApp messages sent through the Outbound module. Use ruleset_id to select the set of messages and per_page and starting_after to paginate the results. The API plan must allow access to this operation.

4 parameters
ruleset_idstringrequired
The unique identifier of the set of messages whose status events you want to retrieve.
per_pageintegeroptional
The maximum number of results per page. Must not exceed 100. Defaults to 50 when omitted.
Default:50
starting_afterstringoptional
The cursor to use when retrieving the next page of results.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

5 status codes
200Returns the ruleset identifier, total event count, pagination details, and an array of message status events.
typestringrequired
Allowed:list
ruleset_idstringrequired
The provided ruleset ID
pagesobjectrequired
total_countintegerrequired
Total number of events
eventsarray<object>required
400Returned when the required ruleset identifier is missing.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the API plan restricts this operation.

One documented failure

  • api_plan_restricted

    Active subscription needed.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
500Returned when an internal server error occurs.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the required ruleset_id query parameter is missing. A 401 is returned when the request is unauthorized. A 403 is returned when the API plan restricts this operation. A 500 is returned for an internal server error. per_page must not exceed 100 and defaults to 50 when omitted; use starting_after to continue pagination.