digitaluapi

SendGrandcomSmsRequest

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

The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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

{"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"}}}