sms.template.list

The sms.template.list command is used to obtain a list of SMS message templates.

TR50 Request

{
    "1": {
        "command": "sms.template.list",
        "params": {
            "offset": 0,
            "limit": 20
        }
    }
}

Request Parameters

Name Type Required Description
offset Integer The starting list offset, used for pagination. Defaults to 0 if not specified.
limit Integer Limits the number of results returned. The maximum you can set is 2000. Defaults to 2000.

TR50 Response

If the command is sent successfully a success message and the SMS template are returned. Otherwise, an error and error message will be returned.

{
  "1": {
    "success": true,
    "params": {
      "count": 35,
      "result": [
        {
          "id": "5734a18b53266d30af540f45",
          "orgId": "534c36e53100460721000051",
          "name": "Template 1",
          "message": "Template message",
          "createdBy": "user@example.com",
          "createdOn": "2016-05-12T11:30:19.159-04:00",
          "updatedBy": "user@example.com",
          "updatedOn": "2016-05-12T11:30:19.159-04:00"
        },
        ...
      ]
    }
  }
}

Response Parameters

Name
Type
Description
count Integer The total number of matching things.
result Array The array of thing objects.

Result Array Object

Name Type Description
id String The identifier of the SMS template record.
orgId String The identifier of the org.
name String The name of the SMS template.
message String The SMS template message.
createdBy String The email address of the user who created the SMS template.
createdOn String The date and time that the SMS template was created.
updatedBy String The email address of the user who last updated the SMS template.
updatedOn String The date and time that the SMS template was last updated.