{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"id": "<string>",
"to": "+16315551111",
"text": "Your verification code is 123456.",
"senderId": "Brand",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.0085,
"currency": "USD",
"status": "sent",
"errorCode": "<string>",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-sms",
"bizType": "sms",
"verificationId": "VERIFICATION-ID"
}
]
}List SMS records
Returns a paginated list of SMS messages you’ve previously sent.
{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"id": "<string>",
"to": "+16315551111",
"text": "Your verification code is 123456.",
"senderId": "Brand",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.0085,
"currency": "USD",
"status": "sent",
"errorCode": "<string>",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-sms",
"bizType": "sms",
"verificationId": "VERIFICATION-ID"
}
]
}Authorizations
Query Parameters
Page number of the results to be returned, 1-based.
1 <= x <= 100A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.
1 <= x <= 100Return results inside an object that contains the total result count or not.
Return results where the createTime field is greater than or equal to this value. Default: One day ago from now.
"2022-03-01T12:00:00.000Z"
Return results where the createTime field is less than or equal to this value.
"2022-03-31T12:00:00.000Z"
Unique object ID on our side. Other filter parameters will be ignored if this parameter is present.
Response
Successfully retrieved a paginated list of objects.
Represents a given page of SMS messages.
The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.
x >= 0A limit on the number of items to be returned, between 1 and 100, defaults to 10.
x >= 1The actual number of items in the page.
x >= 0The total number of items. This field is returned only when the request parameter includeTotal is set to true.
x >= 0An array containing SMS objects.
Show child attributes
Show child attributes