Нажатие на кнопку быстрого ответа

POST

https://ВашWebhook

На ваш URL приходит JSON запрос следующего формата.

CAUTION

Для получения статусов и входящих сообщений от абонента, Вам необходимо реализовать "приемщик" (webhook) на своей стороне, разместить на своем сервере и задать его методом SetWebhook

CHECK

"typeRequest": "inboxmsg"
"type": "quick_reply"

Request

Header Params

X-API-KEY

string

required

Ваш X-API-KEY, который вы задали через "Установить WebHook - setwebhook"

Example:

123

Body Params application/json

typeRequest

string

required

Тип запроса. Для входящих сообщений inboxmsg

Example:

inboxmsg

string

required

ID входящего сообщения

Example:

00DDDAC9-9C05-4767-954E-F30D9E14F4F

receivedAt

string

required

Дата и время сообщения

Example:

2024-11-27 13:32:49

channel

string

required

Номер канала на который отправлено сообщение

Example:

7700999999

payload

object

required

type

string

required

Тип входящего сообщения. При нажатии на кнопку быстрого ответа абонентом - quick_reply

Example:

quick_reply

payload

object

required

sender

object

required

phone

string

required

Номер отправителя

Example:

77771234567

name

string

required

Никнейм в системе WhatsApp

Example:

Abai

context

object

required

string

required

ID вашего исходящего сообщения, кнопку в котором нажал абонент

Example:

2DC27650-FCC0-4F9B-8FD5-AEF5F2FD777C

forwarded

string

required

true - абонент переслал вам это сообщение от другого абонента

Example:

false

frequently_forwarded

string

required

true - это часто пересылаемое сообщение

Example:

false

Example

{
    "typeRequest": "inboxmsg",
    "id": "00DDDAC9-9C05-4767-954E-F30D9E14F4F9",
    "receivedAt": "2024-11-27 13:32:49",
    "channel": "7700999999",
    "payload": {
        "type": "quick_reply",
        "payload": {
            "text": "Другое",
            "btn_code": "3"
        }
    },
    "sender": {
        "phone": "77771234567",
        "name": "Abai"
    },
    "context": {
        "id": "2DC27650-FCC0-4F9B-8FD5-AEF5F2FD777C",
        "forwarded": "false",
        "frequently_forwarded": "false"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ВашWebhook' \
--header 'X-API-KEY: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeRequest": "inboxmsg",
    "id": "00DDDAC9-9C05-4767-954E-F30D9E14F4F9",
    "receivedAt": "2024-11-27 13:32:49",
    "channel": "7700999999",
    "payload": {
        "type": "quick_reply",
        "payload": {
            "text": "Другое",
            "btn_code": "3"
        }
    },
    "sender": {
        "phone": "77771234567",
        "name": "Abai"
    },
    "context": {
        "id": "2DC27650-FCC0-4F9B-8FD5-AEF5F2FD777C",
        "forwarded": "false",
        "frequently_forwarded": "false"
    }
}'

Responses

🟠404Record Not Found

text/html

Body

object {0}

Example

Сервис недоступен, попробуйте позднее

Местоположение - входящее сообщение

Нажатие на кнопку из списка (из листа)

Нажатие на кнопку быстрого ответа

На ваш URL приходит JSON запрос следующего формата.#

Request

Request samples

Responses

На ваш URL приходит JSON запрос следующего формата.