| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/grandcom/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 SendGrandcomSmsRequest
{
/**
* Messages to be Sent
*/
@ApiMember(Description="Messages to be Sent", IsRequired=true)
public ArrayList<GrandcomMessage> Messages = new ArrayList<GrandcomMessage>();
public ArrayList<GrandcomMessage> getMessages() { return Messages; }
public SendGrandcomSmsRequest setMessages(ArrayList<GrandcomMessage> value) { this.Messages = 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 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; }
}
}
Java SendGrandcomSmsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /communication/message/grandcom/sms HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SendGrandcomSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<Messages>
<GrandcomMessage>
<channel>String</channel>
<clientMessageId>String</clientMessageId>
<content>String</content>
<to>String</to>
</GrandcomMessage>
</Messages>
</SendGrandcomSmsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GrandcomMsgResponse 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>
<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>