SMS Gateway API

<back to all web services

SendTask

Requires Authentication
import 'package:servicestack/servicestack.dart';

enum GatewayResponseStatus
{
    Initiated,
    Successful,
    JobError,
}

class GatewayTaskResponse implements IConvertible
{
    String? ReferenceId;
    GatewayResponseStatus? GatewayTaskResponseStatus;
    String? Payload;

    GatewayTaskResponse({this.ReferenceId,this.GatewayTaskResponseStatus,this.Payload});
    GatewayTaskResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ReferenceId = json['ReferenceId'];
        GatewayTaskResponseStatus = JsonConverters.fromJson(json['GatewayTaskResponseStatus'],'GatewayResponseStatus',context!);
        Payload = json['Payload'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ReferenceId': ReferenceId,
        'GatewayTaskResponseStatus': JsonConverters.toJson(GatewayTaskResponseStatus,'GatewayResponseStatus',context!),
        'Payload': Payload
    };

    getTypeName() => "GatewayTaskResponse";
    TypeContext? context = _ctx;
}

class BaseQueueMessage implements IConvertible
{
    String? LicenseeId;

    BaseQueueMessage({this.LicenseeId});
    BaseQueueMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LicenseeId = json['LicenseeId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'LicenseeId': LicenseeId
    };

    getTypeName() => "BaseQueueMessage";
    TypeContext? context = _ctx;
}

class GatewayTask extends BaseQueueMessage implements IConvertible
{
    String? ReferenceId;
    String? JobTypeId;
    bool? IsBeingProcessed;
    String? Payload;
    bool? ContentStoredExternally;
    bool? ResendRequest;

    GatewayTask({this.ReferenceId,this.JobTypeId,this.IsBeingProcessed,this.Payload,this.ContentStoredExternally,this.ResendRequest});
    GatewayTask.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ReferenceId = json['ReferenceId'];
        JobTypeId = json['JobTypeId'];
        IsBeingProcessed = json['IsBeingProcessed'];
        Payload = json['Payload'];
        ContentStoredExternally = json['ContentStoredExternally'];
        ResendRequest = json['ResendRequest'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ReferenceId': ReferenceId,
        'JobTypeId': JobTypeId,
        'IsBeingProcessed': IsBeingProcessed,
        'Payload': Payload,
        'ContentStoredExternally': ContentStoredExternally,
        'ResendRequest': ResendRequest
    });

    getTypeName() => "GatewayTask";
    TypeContext? context = _ctx;
}

class SendTask implements IConvertible
{
    GatewayTask? GatewayTask;

    SendTask({this.GatewayTask});
    SendTask.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GatewayTask = JsonConverters.fromJson(json['GatewayTask'],'GatewayTask',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GatewayTask': JsonConverters.toJson(GatewayTask,'GatewayTask',context!)
    };

    getTypeName() => "SendTask";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'production_eros_gateway_api_sms_wa.azurewebsites.net', types: <String, TypeInfo> {
    'GatewayResponseStatus': TypeInfo(TypeOf.Enum, enumValues:GatewayResponseStatus.values),
    'GatewayTaskResponse': TypeInfo(TypeOf.Class, create:() => GatewayTaskResponse()),
    'BaseQueueMessage': TypeInfo(TypeOf.Class, create:() => BaseQueueMessage()),
    'GatewayTask': TypeInfo(TypeOf.Class, create:() => GatewayTask()),
    'SendTask': TypeInfo(TypeOf.Class, create:() => SendTask()),
});

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