digitaluapi

<back to all web services

SendSmsRequest

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

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SmsMessage() = 
        member val channel:String = null with get,set
        member val to:String = null with get,set
        member val content:String = null with get,set
        member val clientMessageId:String = null with get,set

    [<AllowNullLiteral>]
    type SendSmsRequest() = 
        ///<summary>
        ///Messages to be Sent
        ///</summary>
        [<ApiMember(Description="Messages to be Sent", IsRequired=true)>]
        member val Messages:ResizeArray<SmsMessage> = null with get,set

    [<AllowNullLiteral>]
    type GrandcomMessage() = 
        member val channel:String = null with get,set
        member val to:String = null with get,set
        member val content:String = null with get,set
        member val clientMessageId:String = null with get,set

    [<AllowNullLiteral>]
    type GrandcomResponseMsg() = 
        member val apiMessageId:String = null with get,set
        member val accepted:Boolean = new Boolean() with get,set
        member val to:String = null with get,set
        member val error:String = null with get,set
        member val hasError:Boolean = new Boolean() with get,set
        member val msg:GrandcomMessage = null with get,set

    [<AllowNullLiteral>]
    type GrandcomMsgResponse() = 
        member val messages:ResizeArray<GrandcomResponseMsg> = null with get,set
        member val error:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ClickatellMessage() = 
        member val channel:String = null with get,set
        member val to:String = null with get,set
        member val content:String = null with get,set
        member val clientMessageId:String = null with get,set

    [<AllowNullLiteral>]
    type ClickatellResponsesMsg() = 
        member val apiMessageId:String = null with get,set
        member val accepted:Boolean = new Boolean() with get,set
        member val to:String = null with get,set
        member val error:String = null with get,set
        member val msg:ClickatellMessage = null with get,set

    [<AllowNullLiteral>]
    type ClickatellMessageResponse() = 
        member val messages:ResizeArray<ClickatellResponsesMsg> = null with get,set
        member val error:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SMPPMessage() = 
        member val channel:String = null with get,set
        member val to:String = null with get,set
        member val content:String = null with get,set
        member val clientMessageId:String = null with get,set

    [<AllowNullLiteral>]
    type SMPPResponseMsg() = 
        member val apiMessageId:String = null with get,set
        member val accepted:Boolean = new Boolean() with get,set
        member val to:String = null with get,set
        member val error:String = null with get,set
        member val msg:SMPPMessage = null with get,set

    [<AllowNullLiteral>]
    type SMPPMsgResponse() = 
        member val messages:ResizeArray<SMPPResponseMsg> = null with get,set
        member val error:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SmsMsgResponse() = 
        member val grandcomMsgResponse:GrandcomMsgResponse = null with get,set
        member val clickatellMsgResponse:ClickatellMessageResponse = null with get,set
        member val SMPPMsgResponse:SMPPMsgResponse = null with get,set
        member val error:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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"}}}