callsHangUp#

Бета-версия

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

Метод предназначен для завершения текущего вызова.

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

Запрос#

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

POST

{{apiUrl}}/waInstance{{idInstance}}/callsHangUp/{{apiTokenInstance}}

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

Ответ#

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

Ошибки#

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

Код HTTP	Описание
400	Ошибка агента звонков, например нет активного вызова
404	Инстанс не найден
500	`Hang up error: ...` — ошибка при завершении вызова

TODO: что именно попадает в ... у 500 Hang up error: ... (см. открытый вопрос 5).

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

PythoncURLJava - SpringJava - Unirest

import requests

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

payload = {}
headers = {}

response = requests.request("POST", url, headers=headers, data=payload)

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

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/callsHangUp/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsHangUp/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, null, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsHangUp/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);