Статусы сообщений на WebHook

POST

ВашURL

Все статусы сообщений будут переправлены вам на ваш URL, который вы установлили методом "Установить WebHook - setwebhook"

💡

Для статусов сообщений в отличии от входящих сообщений параметр typeRequest устанавливается в значение status

CHECK

"typeRequest": "status"

TIP

Стутусы сообщений

sent - доставлено до системы WABA
delivered - доставлено до абонента
read - открыто абонентом
undelivered - не доставлено до абонента
failed - ошибка в отправке (не доставлено). WABA отклонила запрос.

*WABA - Платформа whatsapp business api

Request

Header Params

X-API-KEY

string

required

Ваш X-API-KEY который Вы установили через метод SetWebHook

Example:

123

Body Params application/json

typeRequest

string

required

Тип события
status - Статус сообщения (не входящее сообщение)

Example:

status

string

required

ID сообщение, полученный в ответ на отправку сообщения

Example:

FB2B007A-59F5-4C11-996E-2A5DC0296EE1

requestId

string

required

Ваш ID сообщения, если указывали при отпарвке сообщения

Example:

test-001

status

string

required

Статус сообщения
sent - доставлено до системы WABA
delivered - доставлено до абонента
read- открыто абонентом
undelivered - не доставлено до абонента
failed - ошибка в отправке (не доставлено)

Example:

delivered

senttime

string

required

Дата и время отправки

Example:

2024-10-13 14:22:21

receivedtime

string

required

Дата и время согласно событию статуса (delivered,read,undelivered,failed)

Example:

2024-10-13 14:22:29

receiver

string

required

Номер абонента

Example:

77771234567

statuscode

string

required

Цифровой код отправки
Оличный от 200, ошибка, смотрите описание statustext и err

statustext

string

required

Общее описание ошибки, если есть

Example:

send error

err

string

required

Подробная причина ошибки

Example:

Invalid Payload Sent

errorcode

string

required

Код ошибки (см. список кодов ошибок)

conversationId

string

required

ID 24 часовой сессии

conversationExpiresAt

integer

required

Дата и время в формате unix timestamp до которого действует 24 часовая сессия
Часовой пояс GMT+0000
В пределах данного срока вы можете отвечать произвольными сообщениями абоненту

Example:

1734163560

pricingCategory

string

required

Категория сообщения

marketing - маркетинг
authentication - одноразовый код
utility - сервисное сообщение

Example:

authentication

Example

{
    "typeRequest": "status",
    "id": "FB2B007A-59F5-4C11-996E-2A5DC0296EE1",
    "requestId": "test-001",
    "status": "delivered",
    "senttime": "2024-10-13 14:22:21",
    "receivedtime": "2024-10-13 14:22:29",
    "receiver": "77771234567",
    "statuscode": "200",
    "statustext": "Ok",
    "err": "",
    "conversationId": "fcab03114d76d03b03994cf1ad5c7651",
    "conversationExpiresAt": 1734163560,
    "pricingCategory": "authentication"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'ВашURL' \
--header 'X-API-KEY: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeRequest": "status",
    "id": "FB2B007A-59F5-4C11-996E-2A5DC0296EE1",
    "requestId": "test-001",
    "status": "delivered",
    "senttime": "2024-10-13 14:22:21",
    "receivedtime": "2024-10-13 14:22:29",
    "receiver": "77771234567",
    "statuscode": "200",
    "statustext": "Ok",
    "err": "",
    "conversationId": "fcab03114d76d03b03994cf1ad5c7651",
    "conversationExpiresAt": 1734163560,
    "pricingCategory": "authentication"
}'

Responses

🟢200OK

text/html

Body

object {0}

Установить WebHook - setwebhook

HTTP SMS API