CreateSms

post

http://mmpeapi.dengage.com/template/sms/create

CreateSms API is used to create SMS templates.

poolId is a pre-configured parameter in the admin panel. You can get this parameter's possible values by calling the configuration/sendParams API.

Body Params

Request body contains all the details of the template is about to be created.

accountId

integer

An api user can be authorized to multiple accounts. If the user which is used to access this api method, have access to multiple accounts, this parameter must be set.

In other words, if this user have only access to a single account, this parameter is optional.

name

string

required

Name of the sms template to easily identify when using admin panel.

body

string

required

This is the message body the text message. There is a limitation to 160 characters per SMS message.

All GSM handsets and network elements support the GSM 7-bit alphabet. The basic GSM charset contains the letters A to Z (uppercase and lowercase), numbers, special symbols and several symbols from the Greek alphabet.

The GSM charset uses 7-bit alphabet encoding, but the escape characters require 14 bits to encode, thus taking up two characters. These symbols are: |, ^, {, }, €, [, ~, ] and .

When your message contains even one character that is not included in the GSM 7-bit alphabet (for example š, ž, –, ´, “), then the message is sent in the 8-bit data encoding. This includes nearly all messages in non-English and non-Western-European languages.

The length of one message is 70 characters for an 8-bit SMS instead of the 160 characters for a 7-bit SMS.

jsonData

string

This fields contains JSON data for preview.

publicId

string

This field is used to set Id which is going to be used to select this template via other api methods. It's optional and if not set, a random unique GUID value will be set and returned.

csvData

string

This fields contains comma-seperated(CSV) format data for preview.

poolId

integer

required

This field is used to set which IP pool is going to be used for SMS delivery.

Headers

Authorization

string

required

The access token from Login function

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Please login again to get new token.

200The requests is accepted. Your template sms template is created.

400Request body has some invalid fields.

401Please login again to get new token.

422