SMS Gateway API

SendTask


export enum GatewayResponseStatus
{
    Initiated = 'Initiated',
    Successful = 'Successful',
    JobError = 'JobError',
}

export class GatewayTaskResponse
{
    public ReferenceId: string;
    public GatewayTaskResponseStatus: GatewayResponseStatus;
    public Payload: string;

    public constructor(init?: Partial<GatewayTaskResponse>) { (Object as any).assign(this, init); }
}

export class BaseQueueMessage
{
    public LicenseeId: string;

    public constructor(init?: Partial<BaseQueueMessage>) { (Object as any).assign(this, init); }
}

export class GatewayTask extends BaseQueueMessage
{
    public ReferenceId: string;
    public JobTypeId: string;
    public IsBeingProcessed: boolean;
    public Payload: string;
    public ContentStoredExternally: boolean;
    public ResendRequest: boolean;

    public constructor(init?: Partial<GatewayTask>) { super(init); (Object as any).assign(this, init); }
}

export class SendTask
{
    public GatewayTask: GatewayTask;

    public constructor(init?: Partial<SendTask>) { (Object as any).assign(this, init); }
}

TypeScript SendTask DTOs

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

HTTP + JSV

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

POST /jsv/reply/SendTask HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

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