WhatsApp Cloud API — API для звонков | Документация для разработчиков
WhatsApp Cloud API - API для звонков
Экземпляр для программы магистратуры (LLM)
Версия
API для бизнес-звонков WhatsApp позволяет инициировать и принимать звонки от пользователей WhatsApp, используя протокол VoIP (голосовая связь через интернет).
GET /{Version}/{Phone-Number-ID}/call_permissions
Проверьте, есть ли у вас разрешение на звонок пользователю WhatsApp и какие действия доступны. Этот конечный пункт возвращает текущий статус разрешений на звонок конкретному пользователю, а также доступные действия и их ограничения.
Статус доступа:
предоставлено: У вас есть действующее разрешение на звонок этому пользователю - ожидание: Запрос на разрешение отправлен, но еще не одобрен - отклонено: Пользователь отказал в разрешении на звонок - истекло: Предыдущее разрешение истеклоДоступные действия:
start_call: Инициировать новый вызов этому пользователю - send_call_permission_request: Отправить запрос на разрешение этому пользователюОбработка ошибок:
Этот конечный пункт может возвращать различные коды ошибок, включая ошибки ограничения скорости, если за короткий промежуток времени выполняется слишком много проверок разрешений.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·обязательный
Параметры пути
версииСтрока·обязательный
Версия API для использования
Phone-Number-IDСтрока·обязательный
Идентификатор номера телефона, зарегистрированного в вашем аккаунте WhatsApp Business
Параметры запроса
user_wa_idстрока·обязательный
Идентификатор WhatsApp пользователя, для которого вы хотите проверить права на звонки
Ответы
Проверьте, есть ли у вас разрешение на звонок пользователю WhatsApp и какие действия доступны. Этот конечный пункт возвращает текущий статус разрешений на звонок конкретному пользователю, а также доступные действия и их ограничения.
Статус доступа:
предоставлено: У вас есть действующее разрешение на звонок этому пользователю - ожидание: Запрос на разрешение отправлен, но еще не одобрен - отклонено: Пользователь отказал в разрешении на звонок - истекло: Предыдущее разрешение истеклоДоступные действия:
start_call: Инициировать новый вызов этому пользователю - send_call_permission_request: Отправить запрос на разрешение этому пользователюОбработка ошибок:
Этот конечный пункт может возвращать различные коды ошибок, включая ошибки ограничения скорости, если за короткий промежуток времени выполняется слишком много проверок разрешений.
200
Проверка прав доступа прошла успешно
Тип содержимого: application/json
Схема: CallPermissionCheckResponsePayload
Показать дочерние атрибуты
CallPermissionCheckResponsePayload
messaging_productstring·required
Продукт для обмена сообщениями
разрешенияобъект·обязательный
Информация о разрешении на вызов
Показать дочерние атрибуты
Статус:Один из вариантов: "предоставлено", "ожидается", "отказано", "истек срок действия"·требуется
Текущий статус разрешений для вызова этого пользователя
expiration_timeinteger (int64)
Отметка времени Unix, когда истекает срок действия разрешения (если применимо)
действийобъекта
Доступные действия и их ограничения
Показать дочерние атрибуты
действия[]объект
Показать дочерние атрибуты
action_nameОдин из "start_call", "send_call_permission_request"·required
Название действия
can_perform_actionboolean·required
Может ли предприятие выполнить это действие?
ограничиваетмассив объектов
Ограничения скорости для этого действия
Показать дочерние атрибуты
ограничения[]объект
Показать дочерние атрибуты
time_periodстрока·обязательный
Период времени для установления лимита
current_usageцелое число·обязательно
Текущее количество использований
максимально допустимоецелое число·обязательное
Максимально допустимое использование
limit_expiration_timeinteger (int64)
Unix-метка времени, когда сбрасывается лимит
400
Неверный запрос - Недопустимые параметры запроса
Тип содержимого: application/json
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
403
Запрещено — Шаблон не одобрен или имеются недостаточные права доступа
Тип содержимого: application/json
500
Внутренняя ошибка сервера — произошла непредвиденная ошибка
Тип содержимого: application/json
Выберите язык
Выберите код состояния
POST /{Version}/{Phone-Number-ID}/calls
Используйте этот адрес электронной почты для инициирования, принятия, отклонения или завершения звонков WhatsApp.
Для инициирования или управления вызовом:
Отправьте POST-запрос с соответствующим действием (connect, pre_accept, accept, reject, terminate).
Для завершения вызова:
Отправьте POST-запрос с действием "terminate" и call_id.
Примечание: Ответ с кодом ошибки 138006 указывает на отсутствие у пользователя WhatsApp разрешения на запрос вызова для этого номера компании.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·обязательный
Параметры пути
версииСтрока·обязательный
Версия API для использования
Phone-Number-IDСтрока·обязательный
Идентификатор номера телефона, зарегистрированного в вашем аккаунте WhatsApp Business
Необязательный
Тип содержимого: application/json
Схема: Должна быть одной из следующих: CallRequestPayload, CallTerminateRequestPayload
Показать дочерние атрибуты
Должно быть одно из следующих значений: CallRequestPayload, CallTerminateRequestPayload
CallRequestPayload
Показать дочерние атрибуты
messaging_productstring·required
Продукт для обмена сообщениями
встроку·обязательный
Вызываемый номер (звонящий)
Действие:Один из вариантов "connect", "pre_accept", "accept", "reject", "terminate"·обязательно
Действие, выполняемое с указанным идентификатором вызова
сессииобъект
Содержит тип протокола описания сессии (SDP) и язык описания
Показать дочерние атрибуты
sdp_typeОдин из "offer", "answer"·обязательный
Тип SDP: "offer" для действия подключения, "answer" для действия принятия
sdpстрока·обязательный
Информация SDP устройства на другом конце вызова. SDP должен соответствовать RFC 8866
biz_opaque_callback_datastring
CallTerminateRequestPayload
Показать дочерние атрибуты
messaging_productstring·required
Продукт для обмена сообщениями
call_idстрока·обязательный
Идентификатор вызова WhatsApp
действие«прекратить»·требуется
Действия по завершению вызова
Ответы
Используйте этот адрес электронной почты для инициирования, принятия, отклонения или завершения звонков WhatsApp.
Для инициирования или управления вызовом:
Отправьте POST-запрос с соответствующим действием (connect, pre_accept, accept, reject, terminate).
Для завершения вызова:
Отправьте POST-запрос с действием "terminate" и call_id.
Примечание: Ответ с кодом ошибки 138006 указывает на отсутствие у пользователя WhatsApp разрешения на запрос вызова для этого номера компании.
200
Успех в управлении звонками
Тип содержимого: application/json
Схема: Должна быть одной из следующих: CallResponsePayload, CallTerminateResponsePayload
Показать дочерние атрибуты
Должно быть одно из следующих значений: CallResponsePayload, CallTerminateResponsePayload
CallResponsePayload
Показать дочерние атрибуты
messaging_productstring
вызываетмассив объектов
Показать дочерние атрибуты
вызовы[]объект
Показать дочерние атрибуты
идентификаторастрока
CallTerminateResponsePayload
Показать дочерние атрибуты
успехлогическое значение
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют