SMS Gateway API

<back to all web services

SendTask

import Foundation
import ServiceStack

public class SendTask : Codable
{
    public var gatewayTask:GatewayTask

    required public init(){}
}

public class GatewayTask : BaseQueueMessage
{
    public var referenceId:String
    public var jobTypeId:String
    public var isBeingProcessed:Bool
    public var payload:String
    public var contentStoredExternally:Bool
    public var resendRequest:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case referenceId
        case jobTypeId
        case isBeingProcessed
        case payload
        case contentStoredExternally
        case resendRequest
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        referenceId = try container.decodeIfPresent(String.self, forKey: .referenceId)
        jobTypeId = try container.decodeIfPresent(String.self, forKey: .jobTypeId)
        isBeingProcessed = try container.decodeIfPresent(Bool.self, forKey: .isBeingProcessed)
        payload = try container.decodeIfPresent(String.self, forKey: .payload)
        contentStoredExternally = try container.decodeIfPresent(Bool.self, forKey: .contentStoredExternally)
        resendRequest = try container.decodeIfPresent(Bool.self, forKey: .resendRequest)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if referenceId != nil { try container.encode(referenceId, forKey: .referenceId) }
        if jobTypeId != nil { try container.encode(jobTypeId, forKey: .jobTypeId) }
        if isBeingProcessed != nil { try container.encode(isBeingProcessed, forKey: .isBeingProcessed) }
        if payload != nil { try container.encode(payload, forKey: .payload) }
        if contentStoredExternally != nil { try container.encode(contentStoredExternally, forKey: .contentStoredExternally) }
        if resendRequest != nil { try container.encode(resendRequest, forKey: .resendRequest) }
    }
}

public class BaseQueueMessage : Codable
{
    public var licenseeId:String

    required public init(){}
}

public class GatewayTaskResponse : Codable
{
    public var referenceId:String
    public var gatewayTaskResponseStatus:GatewayResponseStatus
    public var payload:String

    required public init(){}
}

public enum GatewayResponseStatus : String, Codable
{
    case Initiated
    case Successful
    case JobError
}

Swift SendTask DTOs

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>