digitaluapi

<back to all web services

ClickatellWebhook

The following routes are available for this service:
POST GET/communication/message/clickatell/webhook

export class ClickatellMesageStatusUpdateObject
{
    public Channel: string;
    public Timestamp: number;
    public StatusCode: number;
    public Status: string;
    public MessageId: string;
    public ClientMessageId: string;

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

export class ClickatellMesageStatusUpdateEvent
{
    public MessageStatusUpdate: ClickatellMesageStatusUpdateObject[];

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

export class ClickatellWebhook
{
    public IntegrationId: string;
    public IntegrationName: string;
    public Event: ClickatellMesageStatusUpdateEvent;

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

TypeScript ClickatellWebhook 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 /communication/message/clickatell/webhook HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IntegrationId: String,
	IntegrationName: String,
	Event: 
	{
		MessageStatusUpdate: 
		[
			{
				Channel: String,
				Timestamp: 0,
				StatusCode: 0,
				Status: String,
				MessageId: String,
				ClientMessageId: String
			}
		]
	}
}