API истории сообщений и событий WhatsApp Business | Документация для разработчиков
API истории сообщений и событий WhatsApp Business
Экземпляр для программы магистратуры (LLM)
Версия
API для получения истории сообщений WhatsApp Business и информации о статусе доставки.
Этот конечный пункт позволяет компаниям получать подробные сведения о статусе доставки сообщений
для конкретных записей истории сообщений, включая переходы статуса доставки,
метки времени и информация о приложении.
GET /{Version}/{Message-History-ID}/events
Получение событий статуса доставки сообщений с постраничной разбивкой для конкретной записи истории сообщений
включая информацию о статусе доставки, временные метки и данные приложения.
Варианты использования:
Отслеживайте подробные события и переходы, связанные со статусом доставки сообщений
Отслеживание временных меток событий, связанных с статусом доставки
Получение информации о приложении для событий доставки
Отладка проблем с доставкой сообщений и изменений статуса
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
События истории сообщений могут кэшироваться на короткие периоды, но события статуса доставки — нет
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
Пагинация:
Этот конечный пункт поддерживает постраничную навигацию с помощью курсора. Используйте курсоры
«после» и «перед».От ответа до навигации по результатам.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка Message-History-ID · обязательный
Идентификатор истории сообщений WhatsApp Business. Этот идентификатор предоставляется при получении истории сообщений
История сообщений доступна через API истории сообщений.
Параметры запроса
status_filter WhatsAppMessageDeliveryStatus
Отфильтруйте результаты по конкретному статусу доставки. Если указан,
Возвращаются только события с таким статусом доставки.
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (курсор, узел {id, delivery_status, occurrence_timestamp}).
Доступные поля: курсор, узел{id, delivery_status, error_description, occurrence_timestamp, status_timestamp, application}
limit integer [min: 1, max: 100]
Максимальное количество событий истории сообщений, возвращаемых на одной странице.
Значение по умолчанию — 25, максимальное — 100.
после строки
Курсор для постраничной навигации. Используйте его, чтобы перейти на следующую страницу результатов.
Это значение берется из
paging.cursors.after в предыдущих ответах.перед строкой
Курсор для постраничной навигации. Используйте его, чтобы перейти на предыдущую страницу результатов.
Это значение берется из
paging.cursors.before в предыдущих ответах.Ответы
Получение событий статуса доставки сообщений с постраничной разбивкой для конкретной записи истории сообщений
включая информацию о статусе доставки, временные метки и данные приложения.
Варианты использования:
Отслеживайте подробные события и переходы, связанные со статусом доставки сообщений
Отслеживание временных меток событий, связанных с статусом доставки
Получение информации о приложении для событий доставки
Отладка проблем с доставкой сообщений и изменений статуса
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
События истории сообщений могут кэшироваться на короткие периоды, но события статуса доставки — нет
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
Пагинация:
Этот конечный пункт поддерживает постраничную навигацию с помощью курсора. Используйте курсоры
«после» и «перед».От ответа до навигации по результатам.
200
История сообщений WhatsApp успешно получена
Тип содержимого: application/json
Схема: MessageHistoryEventsResponse
Показать дочерние атрибуты
История сообщений События Ответ
массив данных
Массив ребер событий истории сообщений
Показать дочерние атрибуты
data[] WhatsAppMessageHistoryEventsEdge
Ребро, содержащее событие, указывающее на статус доставки сообщения, с курсором пагинации
Показать дочерние атрибуты
строка курсора
Курсор постраничной навигации для этой стороны
узел WhatsAppBusinessMessageDeliveryStatusOccurrence · обязательный
Информация о статусе доставки сообщения с подробными сведениями о событии
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор события, определяющего статус доставки сообщения
delivery_status WhatsAppMessageDeliveryStatus · required
Статус доставки сообщения
строка_описания_ошибки
Описание ошибки, если при доставке произошла ошибка
occurrence_timestamp целое число (int64) · обязательно
Unix-метка времени, когда произошло событие, связанное с статусом доставки
status_timestamp integer (int64)
Unix-метка времени, когда был записан статус
приложение ApplicationNode
Мета-приложение, обработавшее событие статуса доставки
Показать дочерние атрибуты
строка идентификатора
Уникальный идентификатор приложения Meta
строка имени
Название приложения Meta
пагинация PaginationInfo
Информация о постраничной навигации для перемещения по результатам поиска
Показать дочерние атрибуты
объект курсоров
Курсоры постраничной навигации
Показать дочерние атрибуты
перед строкой
Наведите курсор на предыдущую страницу результатов
после строки
Наведите курсор для перехода на следующую страницу результатов
предыдущая строка (uri)
URL предыдущей страницы результатов
следующая строка (uri)
URL для следующей страницы результатов
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
404
Не найдено — идентификатор истории сообщений не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют