Comms API ReferenceMessages

Search Messages

Search for messages based on the specified criteria.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

OR
AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Query parameters

pageTokenstringOptional
The token to retrieve the next page of results.
pageSizeintegerOptional1-1000Defaults to 50
The number of resources to return in a page.

Request

This endpoint expects an object.
operationIdstringOptionalformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"
Filter Messages by Operation ID.
sessionIdstringOptionalformat: "^comms_session_[a-hjkmnpqrstv-z0-9]{26,34}"
Filter Messages by Session ID.
startDatestringOptionalformat: "date-time"
Filter to Messages created after the specified date and time.
endDatestringOptionalformat: "date-time"
Filter to Messages created before the specified date and time.
profilestringOptionalformat: "^mem_profile_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"
Filter Messages sent or received by Profile ID.
addressstringOptional
Filter Messages sent or received from an address.
channelenumOptional
Filter Messages by channel.
Allowed values:
statusenumOptional
Filter Messages by Delivery Status.
tagsmap from strings to stringsOptional
Match messages by one or many tags. If more than one tag is specified, the search will return messages that have all the tags.

Response

OK
messageslist of objects
A list of Messages.
paginationobject
Metadata for paginated results. This object contains two tokens to navigate through paginated results. - Use `next` to retrieve the 'next' page in the result list. - Use `self` to retrieve the same page of the result list again. - Supply the token in the `pageToken` query param.

Errors