SMS Gateway API

<back to all web services

SendTask

Requires Authentication 
namespace Eros.Saguna.Common.GatewayClient.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type GatewayResponseStatus =
        | Initiated = 0
        | Successful = 1
        | JobError = 2

    [<AllowNullLiteral>]
    type GatewayTaskResponse() = 
        member val ReferenceId:Guid = new Guid() with get,set
        member val GatewayTaskResponseStatus:GatewayResponseStatus = new GatewayResponseStatus() with get,set
        member val Payload:String = null with get,set

    [<AllowNullLiteral>]
    type BaseQueueMessage() = 
        member val LicenseeId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type GatewayTask() = 
        inherit BaseQueueMessage()
        member val ReferenceId:Guid = new Guid() with get,set
        member val JobTypeId:Guid = new Guid() with get,set
        member val IsBeingProcessed:Boolean = new Boolean() with get,set
        member val Payload:String = null with get,set
        member val ContentStoredExternally:Boolean = new Boolean() with get,set
        member val ResendRequest:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SendTask() = 
        member val GatewayTask:GatewayTask = null with get,set

F# 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>