getCall и getActiveCalls

getCall возвращает звонок по callId: идёт ли он, чем кончился, где запись. getActiveCalls — все разговоры, которые сейчас ведёт сервер на этом канале. Удобно после перезапуска приложения — когда уведомления callStateChanged могли пройти мимо.

Параметры

getCall:

У getActiveCalls параметров нет.

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

Чем кончился звонок:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getCall/$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}/getCall/{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}/getCall/${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 . '/getCall/' . 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 — объект звонка; после конца — со ссылкой на запись:

{
  "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
  "chatId": "8695836",
  "direction": "in",
  "state": "ended",
  "answered": true,
  "endReason": "hangup",
  "endedBy": "remote",
  "talkSeconds": 21.7,
  "recording": {
    "downloadUrl": "https://api.gratio.net/calls/7100000001/31A9ADA2-3889-4B2B-9D88-6A7142875D7F/5e0c….wav",
    "mimeType": "audio/wav",
    "durationSeconds": 21.7
  }
}

Поля ответа

Все поля и причины конца — в статье Звонки: как это работает.

Ещё примеры

Идущие разговоры

getActiveCalls отвечает массивом объектов звонка; нет разговоров — пустой массив:

curl "$GRATIO_URL/waInstance$GRATIO_ID/getActiveCalls/$GRATIO_TOKEN"

[
  {
    "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
    "chatId": "8695836",
    "direction": "out",
    "state": "active",
    "answered": true,
    "endReason": null,
    "endedBy": null,
    "talkSeconds": 8.4
  }
]

Ошибки

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

• MAX. Входящий, который ещё звонит и на который не отвечали через API, — state: "ringing": на него можно ответить answerCall.
• WhatsApp. Звонок, который сервер не вёл, — 404: состояние есть только у звонков после answerCall или makeCall.
• Telegram. Звонков со звуком нет: getCall отвечает 404, getActiveCalls — пустым массивом.
• Сервер помнит последние звонки, а не всю историю. Журнал звонков — в истории чата: элементы с typeMessage: "callMessage", см. getChatHistory.

Что дальше

• callStateChanged — состояние звонка уведомлением, без опроса.
• hangUpCall — положить трубку.
• Звонки: как это работает — объект звонка.