SMS Gateway API

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/SendTask HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"GatewayTask":{"ReferenceId":"00000000000000000000000000000000","JobTypeId":"00000000000000000000000000000000","IsBeingProcessed":false,"Payload":"String","ContentStoredExternally":false,"ResendRequest":false,"LicenseeId":"00000000000000000000000000000000"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ReferenceId":"00000000000000000000000000000000","GatewayTaskResponseStatus":"Initiated","Payload":"String"}