callsDial#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно. В будущем за функционал может взиматься дополнительная плата.
Подключение к функционалу можно запросить через техподдержку GREEN-API

Метод предназначен для начала исходящего вызова.

Ответ 204 No Content означает только то, что агент принял команду. Состояние звонка можно отследить с помощью стасусов уведомлений callsRtc.

Запрос#

Для начала исходящего вызова требуется выполнить запрос по адресу:

POST

{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры тела запроса#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата собеседника, например `79001234567@c.us` или `120650379300963@lid`

Пример тела запроса#

{
    "chatId": "79001234567@c.us"
}

{
    "chatId": "120650379300963@lid"
}

Ответ#

При успешном выполнении метод возвращает 204 No Content с пустым телом ответа.

Ошибки#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Описание
400	`chatId must match ^\d{10,}@(c\.us\\|s\.whatsapp\.net\\|lid)$` — `chatId` id не соответствует установленному формату
404	Инстанс не найден
500	`Dial error: ...` — ошибка вызова на стороне WhatsApp

Примеры кода#

PythoncURL

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}"

payload = {
    "chatId": "79001234567@c.us"
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "79001234567@c.us"
}'