digitaluapi

SendSMPPSmsRequest

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

The following routes are available for this service:
POST	/communication/message/smpp/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 SendSMPPSmsRequest
    {
        /**
        * Messages to be Sent
        */
        @ApiMember(Description="Messages to be Sent", IsRequired=true)
        public ArrayList<SMPPMessage> Messages = new ArrayList<SMPPMessage>();
        
        public ArrayList<SMPPMessage> getMessages() { return Messages; }
        public SendSMPPSmsRequest setMessages(ArrayList<SMPPMessage> value) { this.Messages = value; return this; }
    }

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

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

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

}

Java SendSMPPSmsRequest DTOs

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

HTTP + JSV

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

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

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

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