digitaluapi

<back to all web services

SendClickatellSmsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/message/clickatell/smsSends an SMS to phone numbers provided.
import Foundation
import ServiceStack

public class SendClickatellSmsRequest : Codable
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    public var messages:[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 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(){}
}


Swift SendClickatellSmsRequest DTOs

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

HTTP + OTHER

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

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

{"Messages":[{"channel":"String","to":"String","content":"String","clientMessageId":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}