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 .xml suffix or ?format=xml

HTTP + XML

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

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

<SendTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.GatewayClient.ServiceModel">
  <GatewayTask xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library">
    <LicenseeId xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library.Queuing">00000000-0000-0000-0000-000000000000</LicenseeId>
    <d2p1:ContentStoredExternally>false</d2p1:ContentStoredExternally>
    <d2p1:IsBeingProcessed>false</d2p1:IsBeingProcessed>
    <d2p1:JobTypeId>00000000-0000-0000-0000-000000000000</d2p1:JobTypeId>
    <d2p1:Payload>String</d2p1:Payload>
    <d2p1:ReferenceId>00000000-0000-0000-0000-000000000000</d2p1:ReferenceId>
    <d2p1:ResendRequest>false</d2p1:ResendRequest>
  </GatewayTask>
</SendTask>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewayTaskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library">
  <GatewayTaskResponseStatus>Initiated</GatewayTaskResponseStatus>
  <Payload>String</Payload>
  <ReferenceId>00000000-0000-0000-0000-000000000000</ReferenceId>
</GatewayTaskResponse>