SMS Gateway API

<back to all web services

SMSSend

Saves the specified SMS and sends it for background processing

Requires Authentication
The following routes are available for this service:
POST/api/sendmessage
POST/api/sendmessage/immediate
POST/api/send
POST/api/sms/send
POST/api/send/immediate
POST/api/sms/send/immediate
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Saves the specified SMS and sends it for background processing
*/
@Api(Description="Saves the specified SMS and sends it for background processing")
open class SMSSend
{
    open var SMSModel:SMSModel? = null
    open var CreateCommunicationReferencesImmediately:Boolean? = null
}

open class SMSModel : BaseLicenseeEnforcedServiceModel()
{
    open var From:SMSContact? = null
    open var To:ArrayList<SMSContact>? = null
    open var MessageBody:String? = null
    open var ReplyIsAllowed:Boolean? = null
    open var ReplyIsRequired:Boolean? = null
    open var Notes:String? = null
    open var LinkedObjectId:UUID? = null
    open var SuiteId:UUID? = null
}

open class BaseLicenseeEnforcedServiceModel
{
    open var LicenseeId:UUID? = null
}

open class SMSContact
{
    open var Name:String? = null
    open var PhoneNumber:String? = null
    open var ContactId:UUID? = null
}

open class CommResponse
{
    open var CommId:UUID? = null
    open var Reference:String? = null
    open var Status:Boolean? = null
    open var Message:String? = null
}

Kotlin SMSSend 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 /api/sendmessage HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SMSModel":{"From":{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"},"To":[{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"}],"MessageBody":"String","ReplyIsAllowed":false,"ReplyIsRequired":false,"Notes":"String","LinkedObjectId":"00000000000000000000000000000000","SuiteId":"00000000000000000000000000000000","LicenseeId":"00000000000000000000000000000000"},"CreateCommunicationReferencesImmediately":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"CommId":"00000000000000000000000000000000","Reference":"String","Status":false,"Message":"String"}