Метод GetInfo
Примените метод GetInfo для получения статистики об отправленном голосовом SMS (звонке).
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/call/v1/GetInfo
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| call_id | string | идентификатор вызова голосового сообщения (call_id из метода MakeVoiceMessage) |
Выходные параметры
| Параметр | Тип | |
|---|---|---|
| call_id | string | идентификатор вызова голосового SMS |
| created | string | время создания вызова голосового SMS |
| updated | string | время обновления вызова |
| started | string | время начала вызова |
| ended | string | время окончания вызова |
| duration | int32 | продолжительность вызова в секундах |
| timeout | int32 | ожидание ответа вызываемого абонента |
| status | Status | статус вызова |
| direction | string | направление вызова |
| source | string | номер вызывающего абонента |
| destination | string | номер вызываемого абонента |
Status
| Параметр | Тип | Описание |
|---|---|---|
| queued | вызов в очереди | |
| initiated | вызов инициирован | |
| ringing | вызов поступил на номер | |
| answered | поступил ответ на вызов | |
| play_audio_start | на вызов ответили и началось проигрывание аудиосообщения | |
| play_audio_stop | на вызов ответили и проигрывание аудио сообщения окончено | |
| talk | разговорная фаза вызова | |
| completed | вызов завершён | |
| no_answer | вызов завершён без ответа | |
| canceled | вызов отменён вызывающим абонентом | |
| busy | вызываемый абонент занят | |
| rejected | вызов отклонён вызываемым абонентом | |
| failed | вызов не может быть совершён из за недостаточности баланса или неверных настроек вызова | |
| modified | вызов модифицирован API-функцией |
Примеры
Входные параметры:
{
"call_id": "7374422070618357761"
}
Выходные параметры:
{
"call_id": "7374422070618357761",
"created": "Wed, 29 Mar 2023 10:32:45 +0000",
"updated": "Wed, 29 Mar 2023 10:33:07 +0000",
"started": "Wed, 29 Mar 2023 10:32:58 +0000",
"ended": "Wed, 29 Mar 2023 10:33:07 +0000",
"duration": 9,
"timeout": 60,
"status": "completed",
"direction": "outbound",
"source": "79990557296",
"destination": "79995556789"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | Validation error. Please enter valid parameter values | неправильный параметр в запросе (call_id) |
| 401 | Unauthorized | malformed token | не указан / неправильно указан API-ключ приложения |
| 404 | Not Found | Not Found | отсутствует аудиофайл, привязанный к ресурсу голосового SMS |