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.*;

public class dtos
{

    public static class SendTask
    {
        public GatewayTask GatewayTask = null;
        
        public GatewayTask getGatewayTask() { return GatewayTask; }
        public SendTask setGatewayTask(GatewayTask value) { this.GatewayTask = value; return this; }
    }

    public static class GatewayTask extends BaseQueueMessage
    {
        public UUID ReferenceId = null;
        public UUID JobTypeId = null;
        public Boolean IsBeingProcessed = null;
        public String Payload = null;
        public Boolean ContentStoredExternally = null;
        public Boolean ResendRequest = null;
        
        public UUID getReferenceId() { return ReferenceId; }
        public GatewayTask setReferenceId(UUID value) { this.ReferenceId = value; return this; }
        public UUID getJobTypeId() { return JobTypeId; }
        public GatewayTask setJobTypeId(UUID value) { this.JobTypeId = value; return this; }
        public Boolean getIsBeingProcessed() { return IsBeingProcessed; }
        public GatewayTask setIsBeingProcessed(Boolean value) { this.IsBeingProcessed = value; return this; }
        public String getPayload() { return Payload; }
        public GatewayTask setPayload(String value) { this.Payload = value; return this; }
        public Boolean isContentStoredExternally() { return ContentStoredExternally; }
        public GatewayTask setContentStoredExternally(Boolean value) { this.ContentStoredExternally = value; return this; }
        public Boolean isResendRequest() { return ResendRequest; }
        public GatewayTask setResendRequest(Boolean value) { this.ResendRequest = value; return this; }
    }

    public static class BaseQueueMessage
    {
        public UUID LicenseeId = null;
        
        public UUID getLicenseeId() { return LicenseeId; }
        public BaseQueueMessage setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
    }

    public static class GatewayTaskResponse
    {
        public UUID ReferenceId = null;
        public GatewayResponseStatus GatewayTaskResponseStatus = null;
        public String Payload = null;
        
        public UUID getReferenceId() { return ReferenceId; }
        public GatewayTaskResponse setReferenceId(UUID value) { this.ReferenceId = value; return this; }
        public GatewayResponseStatus getGatewayTaskResponseStatus() { return GatewayTaskResponseStatus; }
        public GatewayTaskResponse setGatewayTaskResponseStatus(GatewayResponseStatus value) { this.GatewayTaskResponseStatus = value; return this; }
        public String getPayload() { return Payload; }
        public GatewayTaskResponse setPayload(String value) { this.Payload = value; return this; }
    }

    public static enum GatewayResponseStatus
    {
        Initiated,
        Successful,
        JobError;
    }

}

Java 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
}