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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ClickatellWebhook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Event>
    <MessageStatusUpdate>
      <ClickatellMesageStatusUpdateObject>
        <Channel>String</Channel>
        <ClientMessageId>String</ClientMessageId>
        <MessageId>String</MessageId>
        <Status>String</Status>
        <StatusCode>0</StatusCode>
        <Timestamp>0</Timestamp>
      </ClickatellMesageStatusUpdateObject>
    </MessageStatusUpdate>
  </Event>
  <IntegrationId>String</IntegrationId>
  <IntegrationName>String</IntegrationName>
</ClickatellWebhook>