Sms - Templates

Get template by id

get/v4/sms/templates/{id}

Request

  • Base URL: https://api.inmobile.com
  • URL: https://api.inmobile.com/v4/sms/templates/{id}
  • Auth: one of:
    • HTTP basic
    • API key in query parameter apikey

Path parameters

idstring required

Response

A template

idstring

The id of the template.

namestring

The name of the template.

textstring

The template text.

senderNamestring

The sendername to use with this template.

encodingstring

The encoding of the message. Can be either "gsm7" or "ucs2" "gsm7" is the default alphabet for text messages and when using gsm7, a single sms message can contain 160 characters. If the length exceeds 160 characters, the message is actually split up into parts of 153 characters and charged according to this. Please note, that a few, specific characters fill up 2 bytes and count for 2 letters. Ref: https://en.wikipedia.org/wiki/GSM_03.38 "ucs2" allows for more non-roman characters to be used along with smileys. When using this encoding, a single message can consist of 70 characters. If the message exceeds 70 characters, the final message is actually split into parts of 67 characters.

placeholdersstring[]

A list of the placeholders found in the template text.

createdstring

When the template was created e.g. 2001-02-30T14:50:23Z (UTC time).

lastUpdatedstring

When the template was last updated e.g. 2001-02-30T14:50:23Z (UTC time).

Example response

{
  "id": "c7114ec3-8f89-4e26-8048-686585c1da2a",
  "name": "My template",
  "text": "My template text {name} {lastname}",
  "senderName": "My sendername",
  "encoding": "gsm7",
  "placeholders": [
    "{name}",
    "{lastname}"
  ],
  "created": "2001-02-30T14:50:23Z",
  "lastUpdated": "2001-02-30T14:50:23Z",
  "unsubscribeInfo": {
    "unsubscribeMethodDescription": "Sms",
    "unsubscribeText": "Some unsubscribe text"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.