digitaluapi

SendSmsRequest

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

The following routes are available for this service:
POST	/communication/message/sms	Sends an SMS to phone numbers provided.

import Foundation
import ServiceStack

public class SendSmsRequest : Codable
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    public var messages:[SmsMessage] = []

    required public init(){}
}

public class SmsMessage : Codable
{
    public var channel:String
    public var to:String
    public var content:String
    public var clientMessageId:String

    required public init(){}
}

public class SmsMsgResponse : Codable
{
    public var grandcomMsgResponse:GrandcomMsgResponse
    public var clickatellMsgResponse:ClickatellMessageResponse
    public var smppMsgResponse:SMPPMsgResponse
    public var error:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class GrandcomMsgResponse : Codable
{
    public var messages:[GrandcomResponseMsg]
    public var error:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class GrandcomResponseMsg : Codable
{
    public var apiMessageId:String
    public var accepted:Bool
    public var to:String
    public var error:String
    public var hasError:Bool
    public var msg:GrandcomMessage

    required public init(){}
}

public class GrandcomMessage : Codable
{
    public var channel:String
    public var to:String
    public var content:String
    public var clientMessageId:String

    required public init(){}
}

public class ClickatellMessageResponse : Codable
{
    public var messages:[ClickatellResponsesMsg]
    public var error:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ClickatellResponsesMsg : Codable
{
    public var apiMessageId:String
    public var accepted:Bool
    public var to:String
    public var error:String
    public var msg:ClickatellMessage

    required public init(){}
}

public class ClickatellMessage : Codable
{
    public var channel:String
    public var to:String
    public var content:String
    public var clientMessageId:String

    required public init(){}
}

public class SMPPMsgResponse : Codable
{
    public var messages:[SMPPResponseMsg]
    public var error:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SMPPResponseMsg : Codable
{
    public var apiMessageId:String
    public var accepted:Bool
    public var to:String
    public var error:String
    public var msg:SMPPMessage

    required public init(){}
}

public class SMPPMessage : Codable
{
    public var channel:String
    public var to:String
    public var content:String
    public var clientMessageId:String

    required public init(){}
}

Swift SendSmsRequest 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/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

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