SendSms

post

http://mmpeapi.dengage.com/transactional/sendSms

SendSms API sends already-personalized outbound mobile text message content to recipients. Please use SendTemplate API to instanciate a template. This API does not use templates.

Body Params

This API receives already-personalized mobile text (SMS) content from the client with required parameters and relays the content to recipients. This function does not use a template. Please use SendTemplate API to personalize and relay a template to recipients.

content

string

required

Content is a complete mobile text message for the recipient(s).

poolId

integer

Vmta Pool to relay the mobile text message. Please ask the system administrator to have this vmta pool id.

Vmta Pools define the path in mta-core engine group to relay messages. This parameter is optional. If set to null or 0, the system will use your account's default pool for emails.

accountId

integer

Specifies the account on the system for users which have an access to multiple accounts.

This parameter is optional. If set to null, the system will use api user's default account.

messageId

string

The unique message id which will be assigned to the message. If set to null, the system creates and assigns a unique message id to the message.

It may be set to null or may not set at all. Under this condition, the system will assign a unique message id to the message. Please check return message in order to get unique message id. This message id is used to get reports for this specific message.

rcptToList

array of strings

required

RcptTo list - The mobile numbers which will receive text message

It is a required parameter.

rcptToList*

sendId

string

Send id is used to group messages under a tag so that reporting with a single id is possible. Typical example of send id is a campaign id, bulk id in your campaign system.

It may be set to null

params

string

The parameter json having parameters to personalize the messages.

If your html content have a parameters, this json is used to send parameters for replace.

For example, the content may contain {{name}} parameter name is the parameter. While customizing this content, the params may have

{"name":"John"}

JSON so that name parameter will be replaced with John.

**It can be set to null

saveParams

boolean

if set to "true", the params sent by request is saved into the database in order to keep the parameters to customize the content.

It can be set to null or may not set at all.

saveContent

boolean

if set to "true", the whole personalized content is saved into the database.

Please note that this is a huge content saved in the database so the disk size must be arranged accordingly.

It can be set to null.

smsStartTime

string

This parameter sets the start time of a message for the operator to relay.

smsExpireTime

string

This parameter sets the latest time of a message for the operator to relay.

smsTrustDay

integer

TrustDay value for 'OTP' type sms messages.

smsType

string

enum

This parameter sets the type of message and warns the operator to prioritize the message. Default: BULK

Allowed:

smsShortUrl

boolean

This parameter enables the short url service for replacing links in the sms text message.

Headers

Authorization

string

The access token

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Please login again to get new token.

403

Please login again to get new token.

400Bad request. Please check message field.