Звонки API#
Бета-версия
Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно.
По вопросам подключения к тарифу и дополнительных условиях просим вас писать на почту support@green-api.com или в чат на сайте.
Тариф "Звонки" предоставляет универсальный REST API интерфейс для управления входящими и исходящими WhatsApp звонками.
Содержание#
- Возможности
- Авторизация инстанса для тарифа Звонки
- Быстрый старт по работе со звонками
3.1. Сценарий исходящего вызова
3.2. Сценарий входящего вызова - Методы для управления звонками
4.1 Аккаунт
4.2 Управление вызовом
1. Возможности#
Тариф позволяет производить входящие и исходящие звонки с пользователями WhatsApp. Продолжительность одного звонка составляет до 60 минут.
2. Авторизация инстанса для тарифа Звонки#
Для работы с тарифом Звонки требуется авторизовать инстанс. Авторизация инстанса выполняется в Личном кабинете путем считывания QR-кода из мобильного приложения WhatsApp Business или WhatsApp.
3. Быстрый старт по работе со звонками#
3.1. Сценарий исходящего вызова#
Совершить исходящий вызов методом callsDial с номером собеседника. Состояние звонка можно отследить с помощью стасусов исходящих уведомлений (offer, answer, ice-candidate, on-call) callsRtc. Для заверщения звонка необходимо вызвать метод callsHangUp. После завершения звонка в журнале придёт уведомление со значением stop.
3.2. Сценарий входящего вызова#
О получении входящего вызова оповещает статус inc-call во входящем уведомлении callsRtc. Для того чтобы принять входящий вызов воспользуйтесь методом callsAccept, а чтобы отклонить - методом callsReject. Состояние звонка можно отследить с помощью стасусов входящих уведомлений (offer, answer, ice-candidate, on-call) callsRtc. Для заверщения звонка необходимо вызвать метод callsHangUp. После завершения звонка в журнале придёт уведомление со значением stop.
4. Методы для управления звонками#
4.1 Аккаунт#
- callsQr — Получить QR-код
- callsScanqrcode — Получить QR-код через WebSocket
- callsGetStateInstance — Получить состояние инстанса
- callsLogout — Разлогинить инстанс
4.2 Управление вызовом#
- callsDial — Начать исходящий вызов
- callsAccept — Принять входящий вызов
- callsReject — Отклонить входящий вызов
- callsHangUp — Завершить текущий вызов
4.3 Уведомления звонков#
- callsRtc — Уведомления состояний звонков