digitaluapi

SendSmsRequest

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

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

import 'package:servicestack/servicestack.dart';
import 'dart:collection';

class SmsMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    SmsMessage({this.channel,this.to,this.content,this.clientMessageId});
    SmsMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "SmsMessage";
    TypeContext? context = _ctx;
}

class SendSmsRequest implements IConvertible
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    List<SmsMessage>? Messages = [];

    SendSmsRequest({this.Messages});
    SendSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Messages = JsonConverters.fromJson(json['Messages'],'List<SmsMessage>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Messages': JsonConverters.toJson(Messages,'List<SmsMessage>',context!)
    };

    getTypeName() => "SendSmsRequest";
    TypeContext? context = _ctx;
}

class GrandcomMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    GrandcomMessage({this.channel,this.to,this.content,this.clientMessageId});
    GrandcomMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "GrandcomMessage";
    TypeContext? context = _ctx;
}

class GrandcomResponseMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    bool? hasError;
    GrandcomMessage? msg;

    GrandcomResponseMsg({this.apiMessageId,this.accepted,this.to,this.error,this.hasError,this.msg});
    GrandcomResponseMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        hasError = json['hasError'];
        msg = JsonConverters.fromJson(json['msg'],'GrandcomMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'hasError': hasError,
        'msg': JsonConverters.toJson(msg,'GrandcomMessage',context!)
    };

    getTypeName() => "GrandcomResponseMsg";
    TypeContext? context = _ctx;
}

class GrandcomMsgResponse implements IConvertible
{
    List<GrandcomResponseMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    GrandcomMsgResponse({this.messages,this.error,this.ResponseStatus});
    GrandcomMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<GrandcomResponseMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<GrandcomResponseMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GrandcomMsgResponse";
    TypeContext? context = _ctx;
}

class ClickatellMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    ClickatellMessage({this.channel,this.to,this.content,this.clientMessageId});
    ClickatellMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "ClickatellMessage";
    TypeContext? context = _ctx;
}

class ClickatellResponsesMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    ClickatellMessage? msg;

    ClickatellResponsesMsg({this.apiMessageId,this.accepted,this.to,this.error,this.msg});
    ClickatellResponsesMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        msg = JsonConverters.fromJson(json['msg'],'ClickatellMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'msg': JsonConverters.toJson(msg,'ClickatellMessage',context!)
    };

    getTypeName() => "ClickatellResponsesMsg";
    TypeContext? context = _ctx;
}

class ClickatellMessageResponse implements IConvertible
{
    List<ClickatellResponsesMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    ClickatellMessageResponse({this.messages,this.error,this.ResponseStatus});
    ClickatellMessageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<ClickatellResponsesMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<ClickatellResponsesMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ClickatellMessageResponse";
    TypeContext? context = _ctx;
}

class SMPPMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    SMPPMessage({this.channel,this.to,this.content,this.clientMessageId});
    SMPPMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "SMPPMessage";
    TypeContext? context = _ctx;
}

class SMPPResponseMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    SMPPMessage? msg;

    SMPPResponseMsg({this.apiMessageId,this.accepted,this.to,this.error,this.msg});
    SMPPResponseMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        msg = JsonConverters.fromJson(json['msg'],'SMPPMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'msg': JsonConverters.toJson(msg,'SMPPMessage',context!)
    };

    getTypeName() => "SMPPResponseMsg";
    TypeContext? context = _ctx;
}

class SMPPMsgResponse implements IConvertible
{
    List<SMPPResponseMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    SMPPMsgResponse({this.messages,this.error,this.ResponseStatus});
    SMPPMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<SMPPResponseMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<SMPPResponseMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SMPPMsgResponse";
    TypeContext? context = _ctx;
}

class SmsMsgResponse implements IConvertible
{
    GrandcomMsgResponse? grandcomMsgResponse;
    ClickatellMessageResponse? clickatellMsgResponse;
    SMPPMsgResponse? SMPPMsgResponse;
    String? error;
    ResponseStatus? ResponseStatus;

    SmsMsgResponse({this.grandcomMsgResponse,this.clickatellMsgResponse,this.SMPPMsgResponse,this.error,this.ResponseStatus});
    SmsMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        grandcomMsgResponse = JsonConverters.fromJson(json['grandcomMsgResponse'],'GrandcomMsgResponse',context!);
        clickatellMsgResponse = JsonConverters.fromJson(json['clickatellMsgResponse'],'ClickatellMessageResponse',context!);
        SMPPMsgResponse = JsonConverters.fromJson(json['SMPPMsgResponse'],'SMPPMsgResponse',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'grandcomMsgResponse': JsonConverters.toJson(grandcomMsgResponse,'GrandcomMsgResponse',context!),
        'clickatellMsgResponse': JsonConverters.toJson(clickatellMsgResponse,'ClickatellMessageResponse',context!),
        'SMPPMsgResponse': JsonConverters.toJson(SMPPMsgResponse,'SMPPMsgResponse',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SmsMsgResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'SmsMessage': TypeInfo(TypeOf.Class, create:() => SmsMessage()),
    'SendSmsRequest': TypeInfo(TypeOf.Class, create:() => SendSmsRequest()),
    'List<SmsMessage>': TypeInfo(TypeOf.Class, create:() => <SmsMessage>[]),
    'GrandcomMessage': TypeInfo(TypeOf.Class, create:() => GrandcomMessage()),
    'GrandcomResponseMsg': TypeInfo(TypeOf.Class, create:() => GrandcomResponseMsg()),
    'GrandcomMsgResponse': TypeInfo(TypeOf.Class, create:() => GrandcomMsgResponse()),
    'List<GrandcomResponseMsg>': TypeInfo(TypeOf.Class, create:() => <GrandcomResponseMsg>[]),
    'ClickatellMessage': TypeInfo(TypeOf.Class, create:() => ClickatellMessage()),
    'ClickatellResponsesMsg': TypeInfo(TypeOf.Class, create:() => ClickatellResponsesMsg()),
    'ClickatellMessageResponse': TypeInfo(TypeOf.Class, create:() => ClickatellMessageResponse()),
    'List<ClickatellResponsesMsg>': TypeInfo(TypeOf.Class, create:() => <ClickatellResponsesMsg>[]),
    'SMPPMessage': TypeInfo(TypeOf.Class, create:() => SMPPMessage()),
    'SMPPResponseMsg': TypeInfo(TypeOf.Class, create:() => SMPPResponseMsg()),
    'SMPPMsgResponse': TypeInfo(TypeOf.Class, create:() => SMPPMsgResponse()),
    'List<SMPPResponseMsg>': TypeInfo(TypeOf.Class, create:() => <SMPPResponseMsg>[]),
    'SmsMsgResponse': TypeInfo(TypeOf.Class, create:() => SmsMsgResponse()),
});

Dart 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>