digitaluapi

ClickatellWebhook

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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ClickatellMesageStatusUpdateObject implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Channel=null,
        /** @var int */
        public int $Timestamp=0,
        /** @var int */
        public int $StatusCode=0,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $MessageId=null,
        /** @var string|null */
        public ?string $ClientMessageId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Channel'])) $this->Channel = $o['Channel'];
        if (isset($o['Timestamp'])) $this->Timestamp = $o['Timestamp'];
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['MessageId'])) $this->MessageId = $o['MessageId'];
        if (isset($o['ClientMessageId'])) $this->ClientMessageId = $o['ClientMessageId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Channel)) $o['Channel'] = $this->Channel;
        if (isset($this->Timestamp)) $o['Timestamp'] = $this->Timestamp;
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->MessageId)) $o['MessageId'] = $this->MessageId;
        if (isset($this->ClientMessageId)) $o['ClientMessageId'] = $this->ClientMessageId;
        return empty($o) ? new class(){} : $o;
    }
}

class ClickatellMesageStatusUpdateEvent implements JsonSerializable
{
    public function __construct(
        /** @var array<ClickatellMesageStatusUpdateObject>|null */
        public ?array $MessageStatusUpdate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['MessageStatusUpdate'])) $this->MessageStatusUpdate = JsonConverters::fromArray('ClickatellMesageStatusUpdateObject', $o['MessageStatusUpdate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->MessageStatusUpdate)) $o['MessageStatusUpdate'] = JsonConverters::toArray('ClickatellMesageStatusUpdateObject', $this->MessageStatusUpdate);
        return empty($o) ? new class(){} : $o;
    }
}

class ClickatellWebhook implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $IntegrationId=null,
        /** @var string|null */
        public ?string $IntegrationName=null,
        /** @var ClickatellMesageStatusUpdateEvent|null */
        public ?ClickatellMesageStatusUpdateEvent $Event=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['IntegrationId'])) $this->IntegrationId = $o['IntegrationId'];
        if (isset($o['IntegrationName'])) $this->IntegrationName = $o['IntegrationName'];
        if (isset($o['Event'])) $this->Event = JsonConverters::from('ClickatellMesageStatusUpdateEvent', $o['Event']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->IntegrationId)) $o['IntegrationId'] = $this->IntegrationId;
        if (isset($this->IntegrationName)) $o['IntegrationName'] = $this->IntegrationName;
        if (isset($this->Event)) $o['Event'] = JsonConverters::to('ClickatellMesageStatusUpdateEvent', $this->Event);
        return empty($o) ? new class(){} : $o;
    }
}

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