hangUpCall

Заканчивает разговор, который ведёт сервер Gratio. Пока исходящий звонок звонит, отменяет вызов. endCall — то же самое под другим именем.

Параметры

Пример запроса

Положить трубку:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/hangUpCall/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/hangUpCall/{TOKEN}"
payload = {"callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F"}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/hangUpCall/${GRATIO_TOKEN}`;
const payload = { callId: "31A9ADA2-3889-4B2B-9D88-6A7142875D7F" };
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/hangUpCall/' . getenv('GRATIO_TOKEN');
$payload = ['callId' => '31A9ADA2-3889-4B2B-9D88-6A7142875D7F'];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK:

{"hangUp": true}

Следом придёт callStateChanged со state: "ended", endReason: "hangup", endedBy: "api" и, если писали, ссылкой на запись.

Ещё примеры

endCall

То же под именем endCall:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/endCall/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F"}'

Ошибки

Особенности каналов

• Входящий, на который ещё не ответили, отклоняют через rejectCall.
• Положить трубку можно и из сокета callAudio — командой {"command": "hangup"}.
• Разговор длиннее maxDurationSeconds сервер кладёт сам: endReason: "max_duration", endedBy: "system".

Что дальше

• callStateChanged — итог и ссылка на запись.
• getCall и getActiveCalls — состояние звонка.
• Звонки: как это работает — причины конца.