Create messaging template

post

https://rest-ww.telesign.com/v1/omnichannel/templates

Use this action to create a Telesign Messaging template.

General requirements

Authentication: Basic (easiest to implement) or Digest
Encoding: Accepts only UTF-8 unicode characters as inputs.
Accepts: application/json
Responds with: application/json
Rate limit: Default rate limits by product

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 512

^[a-z_]*

The name of this template. Use only lowercase alpha characters and underscores. For WhatsApp, the name must include "telesign_otp" if you want Telesign to generate the OTP for you. For example: "verofinto_telesign_otp_wa_template". To enable this feature and create SMS templates with the OTP auto-generated by Telesign, contact our Customer Support Team.

type

string

enum

required

Specifies whether the template requires verification by the channel provider or not.

Allowed:

channel

string

enum

required

The channel the template is used with. Each template can only be used with one channel.

Allowed:

category

string

enum

The category name specifying this template's use case. Only required for WhatsApp templates. Do not include any whitespace characters.

Allowed:

language

string

An abbreviation specifying the language of the text in the template. This is required for WhatsApp templates and not supported for other templates. See Messaging - Supported languages for WhatsApp templates for a list of valid abbreviations.

content

array of objects, unique

required

length ≤ 5

Contains properties defining the new template. The array can contain up to one instance of each object type: header, body, footer, suggested_action, and suggested_reply. A body object must be included. To add the first object, select the Add button. To add more objects, scroll past the suggested_reply object and select the Add button again. If you select a different object without using the Add button, it will replace your previous selection with the new one.

content*

Responses

Status code	Text string	Description
3801	Request succesful	This template is being processed by the service. Additional updates on the status of this transaction will be sent to your transaction callback service endpoint.

Status code	Text string	Description
3110	Invalid request	The API request or its JSON payload is improperly formatted. (Final)
3301	Missing parameter channel	The API request does not contain the mandatory parameter `channel`. (Final)
3802	Missing parameter name	The API request does not contain the mandatory parameter `name`. (Final)
3803	Missing parameter type	The API request does not contain the mandatory parameter `type`. (Final)
3815	Missing parameter content	The API request does not contain the mandatory parameter `content`. (Final)
3816	Invalid value for parameter category: {category}	The value of parameter `category` is not one of the supported values. See request schema for a list of supported values. (Final)
3817	Invalid value for parameter category: {language}	The value of parameter `language` is not one of the supported values. See request schema for a list of supported values. (Final)
3819	Invalid value for parameter sample_text	The value for the `sample_text` parameter is missing or the number of values does not match the number of variables in the body or header.
3856	Invalid value for parameter name: {name}	Template name already exists, or it is missing, or it is not valid. (Final)

Status code	Text string	Description
3400	Not authorized	Insufficient permissions to access this resource or authorization failed.
3818	Template Management Product not enabled for Customer ID	Omnichannel product is not enabled. (Final)

Status code	Text string	Description
3204	Rate limit exceeded	Allowed number of requests per second for this product or feature has been exceeded.

Status code	Text string	Description
3500	System Unavailable	The system is currently unavailable. The request should be resubmitted.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json