playAudio

Проигрывает собеседнику звуковой файл во время разговора, который ведёт сервер. Файлы встают в очередь друг за другом; replace: true сначала сбрасывает очередь — когда собеседник перебил.

Параметры

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

Сказать следующую фразу после того, что уже звучит:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/playAudio/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
    "urlFile": "https://example.ru/audio/schedule.mp3"
  }'

Python

import os
import requests

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

url = f"{BASE}/playAudio/{TOKEN}"
payload = {
    "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
    "urlFile": "https://example.ru/audio/schedule.mp3",
}
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}/playAudio/${GRATIO_TOKEN}`;
const payload = {
  callId: "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
  urlFile: "https://example.ru/audio/schedule.mp3",
};
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 . '/playAudio/' . getenv('GRATIO_TOKEN');
$payload = [
    'callId' => '31A9ADA2-3889-4B2B-9D88-6A7142875D7F',
    'urlFile' => 'https://example.ru/audio/schedule.mp3',
];

$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 — файл в очереди:

{"queued": true}

Ещё примеры

Собеседник перебил

Сбросить очередь и сразу ответить:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/playAudio/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
    "urlFile": "https://example.ru/audio/sorry.mp3",
    "replace": true
  }'

Свой файл

Загрузите файл через uploadFile один раз и передавайте его ссылку в urlFile — сервер возьмёт файл у себя, без скачивания:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/playAudio/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "callId": "31A9ADA2-3889-4B2B-9D88-6A7142875D7F",
    "urlFile": "https://api.gratio.net/upload/7100000001/a1b2c3/8f0e…/hello.mp3"
  }'

Ошибки

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

• Файл, поставленный в очередь до соединения, прозвучит, когда пойдёт звук: так можно заранее подготовить фразу для исходящего звонка.
• Тишина между файлами — обычная тишина в трубке: разговор не прерывается.
• Ту же очередь пополняет живой звук callAudio. Команда clear в сокете сбрасывает её так же, как replace: true.

Что дальше

• callAudio — живой звук вместо файлов.
• hangUpCall — положить трубку.
• Звонки: как это работает — ход звонка и ограничения.