digitaluapi

<back to all web services

ClickatellWebhook

The following routes are available for this service:
POST GET/communication/message/clickatell/webhook
"use strict";
export class ClickatellMesageStatusUpdateObject {
    /** @param {{Channel?:string,Timestamp?:number,StatusCode?:number,Status?:string,MessageId?:string,ClientMessageId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Channel;
    /** @type {number} */
    Timestamp;
    /** @type {number} */
    StatusCode;
    /** @type {string} */
    Status;
    /** @type {string} */
    MessageId;
    /** @type {string} */
    ClientMessageId;
}
export class ClickatellMesageStatusUpdateEvent {
    /** @param {{MessageStatusUpdate?:ClickatellMesageStatusUpdateObject[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ClickatellMesageStatusUpdateObject[]} */
    MessageStatusUpdate;
}
export class ClickatellWebhook {
    /** @param {{IntegrationId?:string,IntegrationName?:string,Event?:ClickatellMesageStatusUpdateEvent}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    IntegrationId;
    /** @type {string} */
    IntegrationName;
    /** @type {ClickatellMesageStatusUpdateEvent} */
    Event;
}

JavaScript 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
			}
		]
	}
}