digitaluapi

SendSMPPSmsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/message/smpp/sms	Sends an SMS to phone numbers provided.

"use strict";
export class SMPPMessage {
    /** @param {{channel?:string,to?:string,content?:string,clientMessageId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    channel;
    /** @type {string} */
    to;
    /** @type {string} */
    content;
    /** @type {string} */
    clientMessageId;
}
export class SMPPResponseMsg {
    /** @param {{apiMessageId?:string,accepted?:boolean,to?:string,error?:string,msg?:SMPPMessage}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    apiMessageId;
    /** @type {boolean} */
    accepted;
    /** @type {string} */
    to;
    /** @type {string} */
    error;
    /** @type {SMPPMessage} */
    msg;
}
export class SMPPMsgResponse {
    /** @param {{messages?:SMPPResponseMsg[],error?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SMPPResponseMsg[]} */
    messages;
    /** @type {string} */
    error;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SendSMPPSmsRequest {
    /** @param {{Messages?:SMPPMessage[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {SMPPMessage[]}
     * @description Messages to be Sent */
    Messages = [];
}

JavaScript SendSMPPSmsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /communication/message/smpp/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Messages: 
	[
		{
			channel: String,
			to: String,
			content: String,
			clientMessageId: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	messages: 
	[
		{
			apiMessageId: String,
			accepted: False,
			to: String,
			error: String,
			msg: 
			{
				channel: String,
				to: String,
				content: String,
				clientMessageId: String
			}
		}
	],
	error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}