digitaluapi

<back to all web services

ClickatellWebhook

The following routes are available for this service:
POST GET/communication/message/clickatell/webhook
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClickatellMesageStatusUpdateObject:
    channel: Optional[str] = None
    timestamp: int = 0
    status_code: int = 0
    status: Optional[str] = None
    message_id: Optional[str] = None
    client_message_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClickatellMesageStatusUpdateEvent:
    message_status_update: Optional[List[ClickatellMesageStatusUpdateObject]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClickatellWebhook:
    integration_id: Optional[str] = None
    integration_name: Optional[str] = None
    event: Optional[ClickatellMesageStatusUpdateEvent] = None

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