Перейти к основному содержимому

Вебхук Client contact provided

Вебхук для уведомления бота о получении данных клиента на ранее отправленный запрос

Бот может отправить запрос на получение данных клиента (доступно только в канале TELEGRAM). Запрос на получение данных можно выполнить если передать в сообщении быстрый ответ с типом CONTACT:

Пример сообщения с запросом данных клиента​

    {
        "action" : "MESSAGE",
        "threadsClientId" : 1,
        "sessionId": "1",
        "questionId": 43,
        "questionIndex": null,
        "text": "Message",
        "sender": "ThreadsAPI",
        "receivedAt" : "2023-08-15T11:49:02.397Z",
        "quickReplies" : [
            {
              "type" : "CONTACT",
              "text" : "Текст сообщения"
            ,
            {
              "type" : "TEXT",
              "text" : "quick reply 1",
    
        ],
        "settings" : {
          "blockInput" : true,
          "masked" : false

В случае получения данных от клиента на данный вебхук будет отправлено сообщение с предоставленными данными.

Поля тела запроса
ПолеТипОписание

action

boolean (обязательно)

CLIENT_CONTACT

threadsClientId

long (необязательно)

Внутренний ID клиента (подходит как для авторизованных, так и для неавторизованных клиентов)

sessionId

string (необязательно)

Внутренний ID треда

channelInfo

object (обязательно)

Информация о канале, в котором получено сообщение

Поля:
channelType (string) - Тип канала
authorized (boolean) - true - авторизован, false - не авторизован

platform

string (необязательно)

Только для типа канала (channelType) MOBILE: iOS и Android

clientData

dictionary (необязательно)

Данные клиента (см. ???)

receivedAt

string (обязательно)

Время получения сообщения, дата в формате UTC: yyyy-MM-dd’T’HH:mm:ss.SSS’Z'

sender

string (обязательно)

Информация об отправителе, всегда ThreadsAPI

Пример HTTP запроса​

    POST <url for webhook message> HTTP/1.1
    Content-Type: application/json
    
    {
       "action":"CLIENT_CONTACT",
       "threadsClientId":1,
       "sessionId":"1",
       "receivedAt":"2018-11-13T13:13:11.876Z",
       "channelInfo":{
          "channelType":"TELEGRAM",
          "authorized":true
       ,
       "clientData":{
          "phone":"79000000000"
       ,
       "sender":"ThreadsAPI"

В ответ сервис ожидает получение статуса:
200 - обработка запроса прошла успешно
4хх-5хх - обработка запроса завершилась ошибкой.

В случае ошибки причину надо поместить в тело запроса

Последнее обновление