SMS Gateway API

<back to all web services

SendTask

Requires Authentication 
"use strict";
/** @typedef {'Initiated'|'Successful'|'JobError'} */
export var GatewayResponseStatus;
(function (GatewayResponseStatus) {
    GatewayResponseStatus["Initiated"] = "Initiated"
    GatewayResponseStatus["Successful"] = "Successful"
    GatewayResponseStatus["JobError"] = "JobError"
})(GatewayResponseStatus || (GatewayResponseStatus = {}));
export class GatewayTaskResponse {
    /** @param {{ReferenceId?:string,GatewayTaskResponseStatus?:GatewayResponseStatus,Payload?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ReferenceId;
    /** @type {GatewayResponseStatus} */
    GatewayTaskResponseStatus;
    /** @type {string} */
    Payload;
}
export class BaseQueueMessage {
    /** @param {{LicenseeId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LicenseeId;
}
export class GatewayTask extends BaseQueueMessage {
    /** @param {{ReferenceId?:string,JobTypeId?:string,IsBeingProcessed?:boolean,Payload?:string,ContentStoredExternally?:boolean,ResendRequest?:boolean,LicenseeId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ReferenceId;
    /** @type {string} */
    JobTypeId;
    /** @type {boolean} */
    IsBeingProcessed;
    /** @type {string} */
    Payload;
    /** @type {boolean} */
    ContentStoredExternally;
    /** @type {boolean} */
    ResendRequest;
}
export class SendTask {
    /** @param {{GatewayTask?:GatewayTask}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GatewayTask} */
    GatewayTask;
}

JavaScript 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>