digitaluapi

SendClickatellSmsRequest

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

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class SendClickatellSmsRequest
    {
        /**
        * Messages to be Sent
        */
        @ApiMember(Description="Messages to be Sent", IsRequired=true)
        public ArrayList<ClickatellMessage> Messages = new ArrayList<ClickatellMessage>();
        
        public ArrayList<ClickatellMessage> getMessages() { return Messages; }
        public SendClickatellSmsRequest setMessages(ArrayList<ClickatellMessage> value) { this.Messages = value; return this; }
    }

    public static class ClickatellMessage
    {
        public String channel = null;
        public String to = null;
        public String content = null;
        public String clientMessageId = null;
        
        public String getChannel() { return channel; }
        public ClickatellMessage setChannel(String value) { this.channel = value; return this; }
        public String getTo() { return to; }
        public ClickatellMessage setTo(String value) { this.to = value; return this; }
        public String getContent() { return content; }
        public ClickatellMessage setContent(String value) { this.content = value; return this; }
        public String getClientMessageId() { return clientMessageId; }
        public ClickatellMessage setClientMessageId(String value) { this.clientMessageId = value; return this; }
    }

    public static class ClickatellMessageResponse
    {
        public ArrayList<ClickatellResponsesMsg> messages = null;
        public String error = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ClickatellResponsesMsg> getMessages() { return messages; }
        public ClickatellMessageResponse setMessages(ArrayList<ClickatellResponsesMsg> value) { this.messages = value; return this; }
        public String getError() { return error; }
        public ClickatellMessageResponse setError(String value) { this.error = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ClickatellMessageResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ClickatellResponsesMsg
    {
        public String apiMessageId = null;
        public Boolean accepted = null;
        public String to = null;
        public String error = null;
        public ClickatellMessage msg = null;
        
        public String getApiMessageId() { return apiMessageId; }
        public ClickatellResponsesMsg setApiMessageId(String value) { this.apiMessageId = value; return this; }
        public Boolean isAccepted() { return accepted; }
        public ClickatellResponsesMsg setAccepted(Boolean value) { this.accepted = value; return this; }
        public String getTo() { return to; }
        public ClickatellResponsesMsg setTo(String value) { this.to = value; return this; }
        public String getError() { return error; }
        public ClickatellResponsesMsg setError(String value) { this.error = value; return this; }
        public ClickatellMessage getMsg() { return msg; }
        public ClickatellResponsesMsg setMsg(ClickatellMessage value) { this.msg = value; return this; }
    }

}

Java SendClickatellSmsRequest 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/clickatell/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<ClickatellMessageResponse 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>
  <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>
</ClickatellMessageResponse>