SMS Gateway API

<back to all web services

SendTask

Requires Authentication
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.GatewayClient.ServiceModel;
using Eros.Saguna.Common.Library;
using Eros.Saguna.Common.Library.Queuing;

namespace Eros.Saguna.Common.GatewayClient.ServiceModel
{
    public partial class SendTask
    {
        public virtual GatewayTask GatewayTask { get; set; }
    }

}

namespace Eros.Saguna.Common.Library
{
    public enum GatewayResponseStatus
    {
        Initiated,
        Successful,
        JobError,
    }

    public partial class GatewayTask
        : BaseQueueMessage
    {
        public virtual Guid ReferenceId { get; set; }
        public virtual Guid JobTypeId { get; set; }
        public virtual bool IsBeingProcessed { get; set; }
        public virtual string Payload { get; set; }
        public virtual bool ContentStoredExternally { get; set; }
        public virtual bool ResendRequest { get; set; }
    }

    public partial class GatewayTaskResponse
    {
        public virtual Guid ReferenceId { get; set; }
        public virtual GatewayResponseStatus GatewayTaskResponseStatus { get; set; }
        public virtual string Payload { get; set; }
    }

}

namespace Eros.Saguna.Common.Library.Queuing
{
    public partial class BaseQueueMessage
    {
        public virtual Guid LicenseeId { get; set; }
    }

}

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