WhatsApp Business Account - API для расписаний | Документация для разработчиков
WhatsApp Business Account - API расписаний
Экземпляр для программы магистратуры (LLM)
Версия
API для управления расписанием и настройками расписания в бизнес-аккаунте WhatsApp.
Этот интерфейс позволяет компаниям управлять функциями планирования для своих бизнес-аккаунтов WhatsApp
включая получение существующих расписаний и создание новых конфигураций расписания для автоматической рассылки сообщений
рабочие часы и другие операции, основанные на времени.
GET /{Version}/{WABA-ID}/schedules
Получите все расписания, связанные с бизнес-аккаунтом WhatsApp, включая их
Подробная информация о конфигурации, состоянии и выполнении.
Варианты использования:
Перечислите все расписания в бизнес-аккаунте WhatsApp
Отслеживайте состояние и производительность расписания
Проверьте конфигурацию расписания и детали времени
Получить историю выполнения расписания и метрики
Фильтрация:
Вы можете фильтровать результаты, используя
фильтрации с условиями фильтрации в формате JSON.Поддерживаемые фильтры включают status, schedule_type и is_active.
Сортировка:
Результаты можно отсортировать по времени создания (created_time) или времени обновления (updated_time) в порядке возрастания или убывания.
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные расписания могут кэшироваться на короткие периоды, но информация о состоянии может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка WABA-ID · обязательный
Идентификатор бизнес-аккаунта WhatsApp. Этот идентификатор можно найти в вашем менеджере WhatsApp
или через API-интерфейсы управления бизнес-процессами.
Параметры запроса
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию. Доступные поля: id, name, status,
schedule_type, description, start_time, end_time, timezone, days_of_week,
created_time, updated_time, is_active, recurrence_pattern
строка фильтрации
Массив условий фильтрации в формате JSON. Каждый фильтр должен указывать поле, оператор и значение.
Поддерживаемые поля: status, schedule_type, is_active
sort One of "created_time.asc", "created_time.desc", "updated_time.asc", "updated_time.desc"
Сортировка поля и направления. Формат: field_name.asc или field_name.desc
Поддерживаемые поля: created_time, updated_time
limit integer [min: 1, max: 100]
Максимальное количество расписаний для отображения на странице
после строки
Курсор для постраничной навигации — для просмотра записей, расположенных после этого курсора
перед строкой
Курсор для пагинации — позволяет просмотреть записи, расположенные перед этим курсором
Ответы
Получите все расписания, связанные с бизнес-аккаунтом WhatsApp, включая их
Подробная информация о конфигурации, состоянии и выполнении.
Варианты использования:
Перечислите все расписания в бизнес-аккаунте WhatsApp
Отслеживайте состояние и производительность расписания
Проверьте конфигурацию расписания и детали времени
Получить историю выполнения расписания и метрики
Фильтрация:
Вы можете фильтровать результаты, используя
фильтрации с условиями фильтрации в формате JSON.Поддерживаемые фильтры включают status, schedule_type и is_active.
Сортировка:
Результаты можно отсортировать по времени создания (created_time) или времени обновления (updated_time) в порядке возрастания или убывания.
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные расписания могут кэшироваться на короткие периоды, но информация о состоянии может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
200
Расписание бизнес-аккаунта WhatsApp успешно получено
Тип содержимого: application/json
Схема: WhatsAppBusinessAccountSchedulesConnection
Показать дочерние атрибуты
WhatsAppBusinessAccountSchedulesConnection
массив данных · обязательный
Массив записей расписания
Показать дочерние атрибуты
данные[] WhatsAppBusinessAccountSchedule
Настройка расписания и подробные сведения для бизнес-аккаунта WhatsApp
Показать дочерние атрибуты
строковый идентификатор · обязательный
Уникальный идентификатор расписания
строка имени · обязательный
Удобочитаемое название расписания
статус WhatsAppScheduleStatus · обязательный
Текущий статус расписания
schedule_type WhatsAppScheduleType · required
Тип конфигурации расписания
строка описания
Дополнительное описание цели расписания
start_time string (time)
Запланируйте время начала в формате ЧЧ:ММ
end_time string (time)
Время окончания расписания в формате ЧЧ:ММ
строка часового пояса
Идентификатор часового пояса для расписания
массив days_of_week
Дни недели, когда расписание активно
Показать дочерние атрибуты
days_of_week[] DayOfWeek
День недели
created_time строка (дата-время)
Отметка времени ISO 8601, когда был создан график
updated_time строка (дата-время)
Отметка времени ISO 8601, когда расписание было в последний раз обновлено
is_active логическое значение
Действует ли в данный момент данное расписание?
recurrence_pattern RecurrencePattern
Шаблон для повторяющихся расписаний
Показать дочерние атрибуты
Частота: Один из вариантов: "ЕЖЕДНЕВНО", "ЕЖЕНЕДЕЛЬНО", "ЕЖЕМЕСЯЧНО", "ЕЖЕГОДНО"
интервал целое число [мин: 1]
Интервал между рецидивами
end_date string (date)
Дата окончания повторяющегося цикла
навигация КурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
объект курсоров
Показать дочерние атрибуты
перед строкой
Курсор указывает на начало страницы
после строки
Курсор указывает на конец страницы
предыдущая строка
URL предыдущей страницы результатов
следующая строка
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
Не найдено — идентификатор бизнес-аккаунта WhatsApp не существует или недоступен
Тип содержимого: 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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
POST /{Version}/{WABA-ID}/schedules
Создайте новую конфигурацию расписания в бизнес-аккаунте WhatsApp. Эта конечная точка
позволяет предприятиям настраивать автоматизированное планирование различных операций, таких как рабочее время
Автоматизированные ответы и окна технического обслуживания.
Варианты использования:
Создайте графики рабочего времени для автоматических ответов
Настройте окна технического обслуживания для работы системы
Настройте автоматическую рассылку сообщений с указанием времени
Установите повторяющиеся графики для бизнес-операций
Предварительные требования:
В бизнес-аккаунте WhatsApp должна быть включена функция планирования публикаций
Соответствующие права доступа для управления расписанием
Допустимые параметры часового пояса и формата времени
Компания должна соответствовать требованиям API WhatsApp Business
Технологический процесс:
Предоставьте конфигурацию расписания с указанием времени и периодичности
Система проверяет параметры расписания и выявляет конфликты
Расписание создается и активируется на основе флага is_active
Отслеживайте статус расписания через конечную точку GET
Ограничение скорости запросов:
Создание расписаний ограничено определенным количеством запросов для предотвращения злоупотреблений.
Также действуют стандартные ограничения скорости запросов к Graph API.
Проверка:
Начало должно быть раньше окончания
Часовой пояс должен соответствовать допустимому идентификатору часового пояса IANA
Если указаны дни недели, они должны быть действительными
Схема повторения должна соответствовать типу расписания
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка WABA-ID · обязательный
Идентификатор бизнес-аккаунта WhatsApp, на котором будет создано расписание.
Этот идентификатор можно найти в вашем менеджере WhatsApp или через API управления бизнесом.
Необходимый
Тип содержимого: application/json
Схема: ScheduleCreateRequest
Показать дочерние атрибуты
ScheduleCreateRequest
строка имени · обязательный
Удобочитаемое название расписания
schedule_type WhatsAppScheduleType · required
Тип конфигурации расписания
строка описания
Дополнительное описание цели расписания
start_time строка (время) · обязательный
Запланируйте время начала в формате ЧЧ:ММ
end_time строка (время) · обязательный
Время окончания расписания в формате ЧЧ:ММ
строка часового пояса
Идентификатор часового пояса для расписания
массив days_of_week
Дни недели, когда расписание активно
Показать дочерние атрибуты
days_of_week[] DayOfWeek
День недели
is_active логическое значение
Должен ли график быть активен при создании
recurrence_pattern RecurrencePattern
Шаблон для повторяющихся расписаний
Показать дочерние атрибуты
Частота: Один из вариантов: "ЕЖЕДНЕВНО", "ЕЖЕНЕДЕЛЬНО", "ЕЖЕМЕСЯЧНО", "ЕЖЕГОДНО"
интервал целое число [мин: 1]
Интервал между рецидивами
end_date string (date)
Дата окончания повторяющегося цикла
Ответы
Создайте новую конфигурацию расписания в бизнес-аккаунте WhatsApp. Эта конечная точка
позволяет предприятиям настраивать автоматизированное планирование различных операций, таких как рабочее время
Автоматизированные ответы и окна технического обслуживания.
Варианты использования:
Создайте графики рабочего времени для автоматических ответов
Настройте окна технического обслуживания для работы системы
Настройте автоматическую рассылку сообщений с указанием времени
Установите повторяющиеся графики для бизнес-операций
Предварительные требования:
В бизнес-аккаунте WhatsApp должна быть включена функция планирования публикаций
Соответствующие права доступа для управления расписанием
Допустимые параметры часового пояса и формата времени
Компания должна соответствовать требованиям API WhatsApp Business
Технологический процесс:
Предоставьте конфигурацию расписания с указанием времени и периодичности
Система проверяет параметры расписания и выявляет конфликты
Расписание создается и активируется на основе флага is_active
Отслеживайте статус расписания через конечную точку GET
Ограничение скорости запросов:
Создание расписаний ограничено определенным количеством запросов для предотвращения злоупотреблений.
Также действуют стандартные ограничения скорости запросов к Graph API.
Проверка:
Начало должно быть раньше окончания
Часовой пояс должен соответствовать допустимому идентификатору часового пояса IANA
Если указаны дни недели, они должны быть действительными
Схема повторения должна соответствовать типу расписания
200
Расписание успешно создано
Тип содержимого: application/json
Схема: ScheduleCreateResponse
Показать дочерние атрибуты
ScheduleCreateResponse
строковый идентификатор · обязательный
Уникальный идентификатор для созданного расписания
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
Не найдено — идентификатор бизнес-аккаунта WhatsApp не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
409
Конфликт — название расписания уже существует или конфликт по времени
Тип содержимого: 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
Комментарии отсутствуют
Комментарии отсутствуют