Create SMS Template
The Create SMS Template API adds SMS templates into Engagement server.
NOTE: This API will create an SMS Template for both Text as well as Voice SMS.
URL
The HTTP URL for Create SMS Template API is:
http://<host>:<port>/api/v1/templates/smstemplates
Method
POST
Header
The payload's request header includes Content-Type as application/json
Input Parameters
The following fields are input parameters:
Input Parameter | Required | Type | Description |
---|---|---|---|
templatename | Yes | string | The unique name assigned to a template |
template | Yes | string | SMS template details |
Sample Request
{ "templateName": "Amazon Customer Service", "template": " Hello. How we can help you ##Mobile Number##" }
Sample Response
{ "id" : "4", "message" : "Details added successfully" }
Response Status
Code | Description |
---|---|
Status 200 | Details added successfully |
Status 400 | Template already existing with given name Template name is required Template is required |
Status 401 | Unauthorized request |
Status 500 | Server failure to process request |