Filter messages

Use this endpoint to list and filter sent messages.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
int32
date-time

If specified, filters messages which were sent on or before the supplied value. Format: YYYY-MM-DDTHH:mm:ss.sssZ

date-time

If specified, filters messages which were sent on or after the supplied value. Format: YYYY-MM-DDTHH:mm:ss.sssZ

string
int32
int32
≥ 1
Defaults to 1

The page number to return. For example, with 100 results per page, specifying pageNum=2 returns results 101–200.

int32
1 to 100
Defaults to 100

The number of messages to return per page.

sender
array of strings

Filters messages by who sent them. Repeat the parameter to supply both values.

Allowed values:

agent,client

sender
Allowed:
string
enum

Allowed values:

sent,pending

Allowed:
uuid

Filters messages by their token. Must be a valid GUID.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json