digitaluapi

<back to all web services

SendSmsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/message/smsSends an SMS to phone numbers provided.
"use strict";
export class SmsMessage {
    /** @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 SendSmsRequest {
    /** @param {{Messages?:SmsMessage[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {SmsMessage[]}
     * @description Messages to be Sent */
    Messages = [];
}
export class GrandcomMessage {
    /** @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 GrandcomResponseMsg {
    /** @param {{apiMessageId?:string,accepted?:boolean,to?:string,error?:string,hasError?:boolean,msg?:GrandcomMessage}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    apiMessageId;
    /** @type {boolean} */
    accepted;
    /** @type {string} */
    to;
    /** @type {string} */
    error;
    /** @type {boolean} */
    hasError;
    /** @type {GrandcomMessage} */
    msg;
}
export class GrandcomMsgResponse {
    /** @param {{messages?:GrandcomResponseMsg[],error?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GrandcomResponseMsg[]} */
    messages;
    /** @type {string} */
    error;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ClickatellMessage {
    /** @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 ClickatellResponsesMsg {
    /** @param {{apiMessageId?:string,accepted?:boolean,to?:string,error?:string,msg?:ClickatellMessage}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    apiMessageId;
    /** @type {boolean} */
    accepted;
    /** @type {string} */
    to;
    /** @type {string} */
    error;
    /** @type {ClickatellMessage} */
    msg;
}
export class ClickatellMessageResponse {
    /** @param {{messages?:ClickatellResponsesMsg[],error?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ClickatellResponsesMsg[]} */
    messages;
    /** @type {string} */
    error;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
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 SmsMsgResponse {
    /** @param {{grandcomMsgResponse?:GrandcomMsgResponse,clickatellMsgResponse?:ClickatellMessageResponse,SMPPMsgResponse?:SMPPMsgResponse,error?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GrandcomMsgResponse} */
    grandcomMsgResponse;
    /** @type {ClickatellMessageResponse} */
    clickatellMsgResponse;
    /** @type {SMPPMsgResponse} */
    SMPPMsgResponse;
    /** @type {string} */
    error;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript SendSmsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"grandcomMsgResponse":{"messages":[{"apiMessageId":"String","accepted":false,"to":"String","error":"String","hasError":false,"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"}}},"clickatellMsgResponse":{"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"}}},"SMPPMsgResponse":{"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"}}},"error":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}