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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SendSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Messages>
    <SmsMessage>
      <channel>String</channel>
      <clientMessageId>String</clientMessageId>
      <content>String</content>
      <to>String</to>
    </SmsMessage>
  </Messages>
</SendSmsRequest>

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

<SmsMsgResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SMPPMsgResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <error>String</error>
    <messages>
      <SMPPResponseMsg>
        <accepted>false</accepted>
        <apiMessageId>String</apiMessageId>
        <error>String</error>
        <msg>
          <channel>String</channel>
          <clientMessageId>String</clientMessageId>
          <content>String</content>
          <to>String</to>
        </msg>
        <to>String</to>
      </SMPPResponseMsg>
    </messages>
  </SMPPMsgResponse>
  <clickatellMsgResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <error>String</error>
    <messages>
      <ClickatellResponsesMsg>
        <accepted>false</accepted>
        <apiMessageId>String</apiMessageId>
        <error>String</error>
        <msg>
          <channel>String</channel>
          <clientMessageId>String</clientMessageId>
          <content>String</content>
          <to>String</to>
        </msg>
        <to>String</to>
      </ClickatellResponsesMsg>
    </messages>
  </clickatellMsgResponse>
  <error>String</error>
  <grandcomMsgResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <error>String</error>
    <messages>
      <GrandcomResponseMsg>
        <accepted>false</accepted>
        <apiMessageId>String</apiMessageId>
        <error>String</error>
        <hasError>false</hasError>
        <msg>
          <channel>String</channel>
          <clientMessageId>String</clientMessageId>
          <content>String</content>
          <to>String</to>
        </msg>
        <to>String</to>
      </GrandcomResponseMsg>
    </messages>
  </grandcomMsgResponse>
</SmsMsgResponse>