| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/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 SendSmsRequest
{
/**
* Messages to be Sent
*/
@ApiMember(Description="Messages to be Sent", IsRequired=true)
public ArrayList<SmsMessage> Messages = new ArrayList<SmsMessage>();
public ArrayList<SmsMessage> getMessages() { return Messages; }
public SendSmsRequest setMessages(ArrayList<SmsMessage> value) { this.Messages = value; return this; }
}
public static class SmsMessage
{
public String channel = null;
public String to = null;
public String content = null;
public String clientMessageId = null;
public String getChannel() { return channel; }
public SmsMessage setChannel(String value) { this.channel = value; return this; }
public String getTo() { return to; }
public SmsMessage setTo(String value) { this.to = value; return this; }
public String getContent() { return content; }
public SmsMessage setContent(String value) { this.content = value; return this; }
public String getClientMessageId() { return clientMessageId; }
public SmsMessage setClientMessageId(String value) { this.clientMessageId = value; return this; }
}
public static class SmsMsgResponse
{
public GrandcomMsgResponse grandcomMsgResponse = null;
public ClickatellMessageResponse clickatellMsgResponse = null;
public SMPPMsgResponse SMPPMsgResponse = null;
public String error = null;
public ResponseStatus ResponseStatus = null;
public GrandcomMsgResponse getGrandcomMsgResponse() { return grandcomMsgResponse; }
public SmsMsgResponse setGrandcomMsgResponse(GrandcomMsgResponse value) { this.grandcomMsgResponse = value; return this; }
public ClickatellMessageResponse getClickatellMsgResponse() { return clickatellMsgResponse; }
public SmsMsgResponse setClickatellMsgResponse(ClickatellMessageResponse value) { this.clickatellMsgResponse = value; return this; }
public SMPPMsgResponse getSmppMsgResponse() { return SMPPMsgResponse; }
public SmsMsgResponse setSmppMsgResponse(SMPPMsgResponse value) { this.SMPPMsgResponse = value; return this; }
public String getError() { return error; }
public SmsMsgResponse setError(String value) { this.error = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SmsMsgResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class GrandcomMsgResponse
{
public ArrayList<GrandcomResponseMsg> messages = null;
public String error = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<GrandcomResponseMsg> getMessages() { return messages; }
public GrandcomMsgResponse setMessages(ArrayList<GrandcomResponseMsg> value) { this.messages = value; return this; }
public String getError() { return error; }
public GrandcomMsgResponse setError(String value) { this.error = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GrandcomMsgResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class GrandcomResponseMsg
{
public String apiMessageId = null;
public Boolean accepted = null;
public String to = null;
public String error = null;
public Boolean hasError = null;
public GrandcomMessage msg = null;
public String getApiMessageId() { return apiMessageId; }
public GrandcomResponseMsg setApiMessageId(String value) { this.apiMessageId = value; return this; }
public Boolean isAccepted() { return accepted; }
public GrandcomResponseMsg setAccepted(Boolean value) { this.accepted = value; return this; }
public String getTo() { return to; }
public GrandcomResponseMsg setTo(String value) { this.to = value; return this; }
public String getError() { return error; }
public GrandcomResponseMsg setError(String value) { this.error = value; return this; }
public Boolean isHasError() { return hasError; }
public GrandcomResponseMsg setHasError(Boolean value) { this.hasError = value; return this; }
public GrandcomMessage getMsg() { return msg; }
public GrandcomResponseMsg setMsg(GrandcomMessage value) { this.msg = value; return this; }
}
public static class GrandcomMessage
{
public String channel = null;
public String to = null;
public String content = null;
public String clientMessageId = null;
public String getChannel() { return channel; }
public GrandcomMessage setChannel(String value) { this.channel = value; return this; }
public String getTo() { return to; }
public GrandcomMessage setTo(String value) { this.to = value; return this; }
public String getContent() { return content; }
public GrandcomMessage setContent(String value) { this.content = value; return this; }
public String getClientMessageId() { return clientMessageId; }
public GrandcomMessage 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; }
}
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 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; }
}
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: 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
{
grandcomMsgResponse:
{
messages:
[
{
apiMessageId: String,
accepted: False,
to: String,
error: String,
hasError: False,
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
}
}
},
clickatellMsgResponse:
{
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
}
}
},
SMPPMsgResponse:
{
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
}
}
},
error: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}