Справочник по веб-перехватчикам истории | Документация для разработчиков
история веб-перехватчика ссылка
Обновлено: 12 декабря 2025 г
истории бизнес-аккаунта WhatsApp .Веб истории используется для синхронизации истории чатов в приложении WhatsApp Business для бизнес-клиентов, подключенных поставщиком решений.
Триггеры
Разрешается делиться историей чата
Содержимое истории чата
Если корпоративный клиент уже одобрил обмен историей чатов, когда поставщик решения запрашивает историю чатов компании, будет запущена серия веб-хуков истории, описывающих все сообщения, отправленные или полученные в течение 180 дней с момента подключения компании к Cloud API.
Сообщения, являющиеся частью группового чата, не будут включены.В медиасообщениях не будут содержаться идентификаторы медиафайлов. Вместо этого дополнительные веб-хуки истории, содержащие идентификаторы медиафайлов сообщений, будут отправляться отдельно, но только для медиасообщений, отправленных в течение 14 дней после регистрации.
Обратите внимание, что в целях повышения эффективности один веб-хук может содержать тысячи сообщений, поэтому мы рекомендуем сначала получить его содержимое, а затем обработать его асинхронно.
Фазы и блоки
Веб-хуки делятся на три этапа истории, где нулевой день обозначает момент подключения компании к Cloud API:
фаза 0: день 0 – день 1Фаза 1: с 1-го по 90-й деньФаза 2: с 90-го по 180-й день
На каждом этапе веб-хуки истории чата могут отправляться отдельными блоками, в зависимости от общего количества сообщений, составляющих цепочку.
Вы можете использовать chunk_order для упорядочивания этих фрагментов в последовательном порядке, поскольку они могут доставляться не последовательно. фазы можно использовать для отслеживания хода выполнения фазы. Значение 2 указывает на завершение текущей фазы. можно использовать progress . Значение 100 означает, что синхронизация завершена.
Если для данного этапа отсутствует история чата, соответствующие веб-хуки отправляться не будут.
Параметры
| Заполнитель | Описание | Пример значения |
|---|---|---|
<BUSINESS_OR_WHATSAPP_USER_PHONE_NUMBER>Нить |
Номер телефона корпоративного клиента или номер телефона пользователя WhatsApp.
Если значением является номер телефона компании, объект сообщения описывает сообщение, отправленное компанией пользователю WhatsApp.
Если значением является номер телефона пользователя WhatsApp, то объект сообщения описывает сообщение, отправленное пользователем WhatsApp компании. |
15550783881 |
<CHUNK_ORDER>Целое число |
Указывает блока , который можно использовать для упорядочивания наборов веб-хуков в последовательном порядке. |
1 |
<CUSTOMER_WABA_ID>Нить |
Идентификатор бизнес-аккаунта WhatsApp клиента. |
102290129340398 |
<CUSTOMER_DISPLAY_PHONE_NUMBER>Нить |
Рабочий телефонный номер корпоративного клиента. |
15550783881 |
<CUSTOMER_PHONE_NUMBER_ID>Нить |
Идентификатор номера корпоративного телефона клиента. |
106540352242922 |
<DEVICE_TIMESTAMP>Нить |
Метка времени Unix, указывающая, когда сообщение было получено устройством получателя. |
1738796547 |
<MESSAGE_CONTENTS>Объект |
Объект, описывающий содержимое сообщения. Это значение будет меняться в зависимости от типа сообщения, а также от его содержимого.
Например, если компания отправляет
с изображением без подписи, объект не будет содержать caption . содержимого сообщений каждого типа см. |
|
<MESSAGE_STATUS>Нить |
Отображает последние статистические данные о доставке сообщения. Возможные значения: ДОСТАВЛЕННЫЙОШИБКАВ ОЖИДАНИИИГРАЛЧИТАТЬОТПРАВИЛ |
ЧИТАТЬ |
<MESSAGE_TYPE>Нить |
Тип сообщения . Обратите внимание, что этот заполнитель встречается в приведенном выше синтаксисе дважды, поскольку он служит заполнителем для значения свойства
типа пример полезной нагрузки ниже для потока с различными типами сообщений.Если это значение установлено на media_placeholder , объект сообщения описывает сообщение, содержащее медиафайл. В этом случае содержимое сообщения будет опущено. Вместо этого будет отправлен отдельный веб-перехватчик истории, описывающий содержимое сообщения и идентификатор медиафайла, но только если сообщение было отправлено в течение последних двух недель после вашего запроса. См. примеры полезных нагрузок ниже , описывающие содержимое медиасообщения. |
текст |
<PHASE>Целое число |
фазу истории . Возможные значения: 0 - указывает, что сообщения относятся к периоду с 0-го дня (время адаптации нового сотрудника) по 1-й день1 - указывает, что сообщения относятся к периоду с 1-го по 90-й день2 - указывает, что сообщения относятся к периоду с 90-го по 180-й день |
1 |
|
Отображает процент от общего прогресса синхронизации.
Минимум 0 , максимум 100 . |
55 |
<WHATSAPP_MESSAGE_ID>Нить |
Идентификатор сообщения WhatsApp. |
wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA= |
<WHATSAPP_USER_PHONE_NUMBER>Нить |
Номер телефона пользователя WhatsApp.
Свойство `to` включается только в том случае, если объект сообщения представляет собой эхо-сообщение SMB . |
16505551234 |
Отклонено предложение делиться историей чата
Параметры
| Заполнитель | Описание | Пример значения |
|---|---|---|
<CUSTOMER_DISPLAY_PHONE_NUMBER>Нить |
Рабочий телефонный номер корпоративного клиента. |
15550783881 |
<CUSTOMER_PHONE_NUMBER_ID>Нить |
Идентификатор номера корпоративного телефона клиента. |
106540352242922 |
Комментарии отсутствуют
Комментарии отсутствуют