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 .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>