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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}