Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
SMS

List SMS records

Returns a paginated list of SMS messages you've previously sent.

get/sms

Query parameters

pageinteger

Page number of the results to be returned, 1-based.

limitinteger

A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.

includeTotalboolean

Return results inside an object that contains the total result count or not.

filter.createTime.gtestring date-time
Example:2022-03-01T12:00:00.000Z

Return results where the createTime field is greater than or equal to this value. Default: One day ago from now.

filter.createTime.ltestring date-time
Example:2022-03-31T12:00:00.000Z

Return results where the createTime field is less than or equal to this value.

filter.idstring

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.

offsetinteger required

The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.

limitinteger required

A limit on the number of items to be returned, between 1 and 100, defaults to 10.

lengthinteger required

The actual number of items in the page.

totalinteger

The total number of items. This field is returned only when the request parameter includeTotal is set to true.

itemsobject[]