SMS Gateway API

<back to all web services

SendTask

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SendTask
{
    open var GatewayTask:GatewayTask? = null
}

open class GatewayTask : BaseQueueMessage()
{
    open var ReferenceId:UUID? = null
    open var JobTypeId:UUID? = null
    open var IsBeingProcessed:Boolean? = null
    open var Payload:String? = null
    open var ContentStoredExternally:Boolean? = null
    open var ResendRequest:Boolean? = null
}

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

open class GatewayTaskResponse
{
    open var ReferenceId:UUID? = null
    open var GatewayTaskResponseStatus:GatewayResponseStatus? = null
    open var Payload:String? = null
}

enum class GatewayResponseStatus
{
    Initiated,
    Successful,
    JobError,
}

Kotlin SendTask DTOs

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

HTTP + JSV

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

POST /jsv/reply/SendTask HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GatewayTask: 
	{
		ReferenceId: 00000000000000000000000000000000,
		JobTypeId: 00000000000000000000000000000000,
		IsBeingProcessed: False,
		Payload: String,
		ContentStoredExternally: False,
		ResendRequest: False,
		LicenseeId: 00000000000000000000000000000000
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReferenceId: 00000000000000000000000000000000,
	GatewayTaskResponseStatus: Initiated,
	Payload: String
}