Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string

Pagination start date

end_date
string

Pagination end date

id
string

Filter results by identifier. Message uuid

Example:

"e093fbe0-5bde-11eb-ae93-0242ac130002"

direction
enum<string>

Filter results by direction. Direction (inbound or outbound)

Available options:
INBOUND,
OUTBOUND
Example:

"INBOUND"

profile
string

Filter results by profile. Name of the profile

Example:

"My profile"

cld
string

Filter results by cld. Destination number

Example:

"+15551237654"

cli
string

Filter results by cli. Origination number

Example:

"+15551237654"

status
enum<string>

Filter results by status. Message status

Available options:
GW_TIMEOUT,
DELIVERED,
DLR_UNCONFIRMED,
DLR_TIMEOUT,
RECEIVED,
GW_REJECT,
FAILED
Example:

"DELIVERED"

message_type
enum<string>

Filter results by message type. Type of message

Available options:
SMS,
MMS
Example:

"SMS"

Response

Successful

data
object[]
meta
object