SMS Gateway API

<back to all web services

SendTask

Requires Authentication
SendTask Parameters:
NameParameterData TypeRequiredDescription
GatewayTaskqueryGatewayTaskNo
GatewayTask Parameters:
NameParameterData TypeRequiredDescription
ReferenceIdformGuidNo
JobTypeIdformGuidNo
IsBeingProcessedformboolNo
PayloadformstringNo
ContentStoredExternallyformboolNo
ResendRequestformboolNo
BaseQueueMessage Parameters:
NameParameterData TypeRequiredDescription
LicenseeIdformGuidNo
GatewayTaskResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceIdformGuidNo
GatewayTaskResponseStatusformGatewayResponseStatusNo
PayloadformstringNo

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
}