GET /messaging/v1/sms/definitions
The number of records returned by this function is based on the $pageSize
and $page
parameters. It doesn't necessarily return all the records in one call.
Get a list of SMS send definitions.
Name | Type | Description |
---|
$filter | string | Filter by status type. Accepted values are active , inactive , or deleted . Valid operations are eq and neq . |
$pageSize | integer | In the array called definitions , each element is an object representing a send definition. This parameter controls the number of such objects that are returned per page. |
$page | integer | Page number to return. |
$orderBy | string | Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey , name , createdDate , modifiedDate , and status . |
Status | Name | Type | Description |
---|
200 | | | Success |
| requestId | string | The unique identifier of this request. |
| name | string | Name of the definition. |
| definitionKey | string | Unique, user-generated key to access the definition object. |
| status | string | Operational state of the definition: active , inactive , or deleted . A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. |
| createdDate | string | Date the definition was created. |
| modifiedDate | string | Date and time of the most recent definition change. |
Response | Reason |
---|
200 OK | Success. Review example response. |
400 Bad Request | Invalid request |
403 Forbidden | Failed to pass authorization. |
500 Server Error | Internal error |