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

Справочник по веб-перехватчикам истории | Документация для разработчиков

история веб-перехватчика ссылка

Обновлено: 12 декабря 2025 г
истории бизнес-аккаунта WhatsApp .
Веб истории используется для синхронизации истории чатов в приложении WhatsApp Business для бизнес-клиентов, подключенных поставщиком решений.

Триггеры

    Поставщик решений синхронизирует историю чатов в приложении WhatsApp Business бизнес-клиента, которого они зарегистрировали с помощью номера телефона, подключенного к приложению WhatsApp Business, и который согласился делиться своей историей чатов.Поставщик решений синхронизирует историю чатов в приложении WhatsApp Business бизнес-клиента, которого они подключили к приложению с помощью номера телефона, указанного в приложении WhatsApp Business, но клиент отказался поделиться своей историей чатов.

    Разрешается делиться историей чата

    Содержимое истории чата

    Если корпоративный клиент уже одобрил обмен историей чата, когда поставщик решения запрашивает это бизнес'бизнес'При просмотре истории чата будет запущена серия веб-хуков, описывающих все сообщения, отправленные или полученные в течение 180 дней с момента подключения компании к Cloud API.
      Сообщения, являющиеся частью группового чата, не будут включены.В медиасообщениях не будут содержаться идентификаторы медиафайлов. Вместо этого дополнительные веб-хуки истории, содержащие идентификаторы медиафайлов сообщений, будут отправляться отдельно, но только для медиасообщений, отправленных в течение 14 дней после регистрации.
      Обратите внимание, что в целях повышения эффективности один веб-хук может содержать тысячи сообщений, поэтому мы рекомендуем сначала получить его содержимое, а затем обработать его асинхронно.

      Фазы и блоки

      Веб-хуки делятся на три этапа истории, где нулевой день обозначает момент подключения компании к Cloud API:
        фаза 0: день 0 – день 1Фаза 1: с 1-го по 90-й деньФаза 2: с 90-го по 180-й день
        На каждом этапе веб-хуки истории чата могут отправляться отдельными блоками, в зависимости от общего количества сообщений, составляющих цепочку.
          Вы можете использовать chunk_order для упорядочивания этих фрагментов в последовательном порядке, поскольку они могут доставляться не последовательно. фазы можно использовать для отслеживания хода выполнения фазы. Значение 2 указывает на завершение текущей фазы. можно использовать progress . Значение 100 означает, что синхронизация завершена.
          Если для данного этапа отсутствует история чата, соответствующие веб-хуки отправляться не будут.

          Синтаксис

          {
          
"object": "whatsapp_business_account",
            "вход": [
              {
                "идентификатор": "<CUSTOMER_WABA_ID>",
                "изменения": [
                  {
                    "ценить": {
                      "messaging_product": "whatsapp",
                      "метаданные": {
                        "display_phone_number": "<НОМЕР ТЕЛЕФОНА ДЛЯ ОТОБРАЖЕНИЯ КЛИЕНТА>",
                        "phone_number_id": "<ИДЕНТИФИКАТОР_НОМЕРА_ТЕЛЕФОНА_КЛИЕНТА>"
                      },
                      "история": [
                        {
                          "метаданные": {
                            "фаза": <ФАЗА>,
                            "chunk_order": <CHUNK_ORDER>,
                            «прогресс» <ПРОГРЕСС>
                          },
                          "нити": [
                            /* Первый объект ветки истории чатаи т. д. */
                            {
                              "идентификатор": "<Номер телефона пользователя WhatsApp>",
                              "сообщения": [
                                /* Первый объект сообщения в tпоток */
                                {
                                  "от": "<НОМЕР ТЕЛЕФОНА ДЛЯ БИЗНЕСА ИЛИ ПОЛЬЗОВАТЕЛЯ WHATSAPP>",
                                  "к": "<Номер телефона пользователя WhatsApp>", // включается только при эхо-сообщении SMB
                                  "идентификатор": "<Идентификатор сообщения WhatsApp>",
                                  "временная метка": "<DEVICE_TIMESTAMP>",
                                  "тип": "<ТИП СООБЩЕНИЯ>",
                                  "<ТИП СООБЩЕНИЯ>": {
          <СОДЕРЖАНИЕ СООБЩЕНИЯ>
                                  },
                                  "исторический_контекст": {
                                    "статус": "<MESSAGE_STATUS>"
                                  }
                                },
                                /* Дополнительный объект сообщенияЕсли таковые будут, то в ветке обсуждения последуют другие сообщения
                              ]
                            },
                            /* Дополнительная история чатаЕсли таковые будут, то последуют другие объекты
                          ]
                        }
                      ]
                    },
                    "поле": "история"
                  }
                ]
              }
            ]
          }
          Параметры
          

          

          



Заполнитель 

Описание 

Пример значения 




          

          <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 .
          

           содержимого сообщений каждого типа см. 
          


          

          {"body":"Вот запрошенная вами информация! https://www.meta.com/quest/quest-3/"}
          



          

          <MESSAGE_STATUS>
          

          Нить
          


          

          Указывает на сообщение'сообщение'Последние статистические данные о доставке. Возможные значения:
          

            ДОСТАВЛЕННЫЙОШИБКАВ ОЖИДАНИИИГРАЛЧИТАТЬОТПРАВИЛ
            


            

            ЧИТАТЬ
            



            

            <MESSAGE_TYPE>
            

            Нить
            


            

            Тип сообщенияОбратите внимание, что этот заполнитель встречается в приведенном выше синтаксисе дважды, поскольку он служит заполнителем для тип свойство'свойство'Значение и соответствующее ему имя свойства. См Пример полезной нагрузки ниже для ветки обсуждения с различными типами сообщений.
            

            Если это значение установлено на медиа_заполнительВ этом случае объект сообщения описывает сообщение, содержащее медиафайл. Содержимое сообщения будет опущено. Вместо этого будет отправлен отдельный веб-перехватчик истории, описывающий содержимое сообщения и идентификатор медиафайла, но только если сообщение было отправлено в течение последних двух недель до вашего запроса. См Примеры полезных нагрузок приведены ниже описание медиа сообщение'сообщение'Содержание.
            


            

            текст
            



            

            <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
              

              

              

              

              Примеры
              

              В этом примере веб-перехватчика описываются два потока сообщений: (1) поток, содержащий текстовое сообщение и видеосообщение, отправленные пользователю WhatsApp, и WhatsApp пользователь'пользователь'ответ и (2) текстовое сообщение, отправленное другому пользователю WhatsApp, с благодарностью за заказ.
              

              Обратите внимание, что средства массовой информации сообщение'сообщение'Содержимое первой ветки обсуждения не описывается. Вместо этого, второй веб-хук запускается, описывая средства массовой информации сообщение'сообщение'Содержание.
              

              

              {
              "объект":
              
"whatsapp_business_account",
              "вход": [
                  {
              "идентификатор": "102290129340398",
              "изменения": [
                      {
              "ценить": {
              "messaging_product": "WhatsApp",
              "метаданные": {
              "display_phone_number": "15550783881",
              "идентификатор_номера_телефона": "106540352242922"
                          },
              «история»: [
                            {
              "метаданные": {
              «фаза»: 0,
              "chunk_order": 1,
              «прогресс»: 55
                              },
              "нити": [
                                {
              "идентификатор": "16505551234",
              "сообщения": [
                                    {
              "от": "15550783881",
              "идентификатор": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0N0FCNjMA",
              "временная метка": "1739230955",
              "тип": "текст",
              "текст": {
              "тело": «Вот запрошенная вами информация! https://www.meta.c»om/quest/quest-3/"
                                      },
              "исторический_контекст": {
              «статус»: "ЧИТАТЬ"
                                      }
                                    },
                                    {
              "от": "15550783881",
              "идентификатор": "wamid.QyNUEHBgLMTY0NjcwNDM1OTUVAgARGBI1Rj3NEYxMzAzMzQ5MkEA",
              "временная метка": "1739230970",
              "тип": "media_placeholder",
              "исторический_контекст": {
              «статус»: "ИГРАНО"
                                      }
                                    },
                                    {
              "от": "16505551234",
              "идентификатор": "wamid.N0FCNjMAHBgLMTY0NjcwNDM1OTUVAgARGBIyNDlBOEI5QUQ4NDc0",
              "временная метка": "1739230970",
              "тип": "текст",
              "текст": {
              "тело": "Спасибо!"
                                      },
              "исторический_контекст": {
              «статус»: "ЧИТАТЬ"
                                      }
                                    }
                                  ]
                                },
                                {
              "идентификатор": "12125557890",
              "сообщения": [
                                    {
              "от": "15550783881",
              "идентификатор": "wamid.BIyNDlBOEI5N0FCNjMAHBgLMTY0NjcwNDM1OTUVAgARGQUQ4NDc0",
              "временная метка": "1739230970",
              "тип": "текст",
              "текст": {
              "тело": Спасибо за ваш заказ! В знак благодарности используйте код TНаберите HANKS30 и получите скидку 30% на следующий заказ
                                      },
              "исторический_контекст": {
              «статус»: "ДОСТАВЛЕННЫЙ"
                                      }
                                    }
                                  ]
                                }
                              ]
                            }
                          ]
                        },
              "поле": «история»
                      }
                    ]
                  }
                ]
              }
              В этом примере веб-перехватчик описывает медиафайл сообщение'сообщение'Содержание.
              

              

              {
              "объект":
              
"whatsapp_business_account",
              "вход":
              
[
              
{
              "идентификатор":
              
"102290129340398",
              "изменения": [
                      {
              "ценить": {
              "messaging_product": "WhatsApp",
              "метаданные": {
              "display_phone_number": "15550783881",
              "идентификатор_номера_телефона": "106540352242922"
                          },
              "сообщения": [
                            {
              "от": "16505551234",
              "идентификатор": "wamid.QyNUEHBgLMTY0NjcwNDM1OTUVAgARGBI1Rj3NEYxMzAzMzQ5MkEA",
              "временная метка": "1738796547",
              "тип": "изображение",
              "изображение": {
              "подпись": «Эхеверия Черного Принца»,
              "mime_type": "image/jpeg",
              "sha256": "3f9d94d399fa61c191bc1d4ca71375a035cd9b9f5b1128e1f0963a415c16b0cc",
              "идентификатор": "24230790383178626"
                              }
                            }
                          ]
                        },
              "поле": «история»
                      }
                    ]
                  }
                ]
              }
              Отклонено предложение делиться историей чата
              

              

              

              Синтаксис
              {
              
"messaging_product": "whatsapp",
                "метаданные": {
                  "display_phone_number": "<НОМЕР ТЕЛЕФОНА ДЛЯ ОТОБРАЖЕНИЯ КЛИЕНТА>",
                  "phone_number_id": "<ИДЕНТИФИКАТОР_НОМЕРА_ТЕЛЕФОНА_КЛИЕНТА>"
                },
                "история": [
                  {
                    "ошибки": [
                      {
                        "код": 2593109,
                        "title": "Синхронизация истории отключена вести бизнес через приложение WhatsApp Business"
                        "сообщение": "Синхронизация истории отключенаРазвивайте свой бизнес с помощью приложения WhatsApp Business
                        "error_data": {
                          «Подробности»: «Обмен историей включен» отстранен от дел
                        }
                      }
                    ]
                  }
                ]
              }
              Параметры
              

              

              



Заполнитель 

Описание 

Пример значения 




              

              <CUSTOMER_DISPLAY_PHONE_NUMBER>
              

              Нить
              


              

              Бизнес клиент'клиент'рабочий номер телефона.
              


              

              15550783881
              



              

              <CUSTOMER_PHONE_NUMBER_ID>
              

              Нить
              


              

              Бизнес клиент'клиент'Идентификатор номера служебного телефона.
              


              

              106540352242922
              Пример
              {
              "messaging_product": "WhatsApp",
              "метаданные": {
              "display_phone_number": "15550783881",
              "идентификатор_номера_телефона": "106540352242922"
                },
              «история»: [
                  {
              "ошибки": [
                      {
              "код": 2593109,
              "заголовок": «Синхронизация истории отключена компанией с момента начала работы»Приложение WhatsApp Business,
              "сообщение": «Синхронизация истории отключена компанией с момента начала работы»Приложение WhatsApp Business,
              "error_data": {
              "подробности": «Компания отключила функцию обмена историей»
                        }
                      }
                    ]
                  }
                ]
              }
              
    
                      
              
    
              

            
              
        
              
    
              

    
              

    
    
              
        
              
             Вернуться наверх