Метод GetTranscribationsList
Примените этот метод для получения результатов транскрибации за определенный период. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/statistics/call-record/v1/GetTranscribationsList
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| date_from | string | дата начала выборки звонков в формате RFC-3339 / ISO-8601 |
| date_to | string | дата окончания выборки звонков в формате RFC-3339 / ISO-8601 |
| limit | uint32 | лимит выводимых строк |
| offset | uint64 | номер строки, с которой начинать выборку (начинается с 0) |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| url | string | URL-адрес для отправки события о готовности текстовой расшифровки звонка |
| uid | uint64 | идентификатор звонка |
| application_uuid | string | идентификатор приложения, с номера которого был совершён звонок |
| date_time | string | дата и время готовности транскрибации RFC-3339 / ISO-8601 |
| number_a | string | номер звонящего абонента |
| number_b | string | номер принимающего абонента |
| redirect_number | string | номер для переадресации |
| duration | uint32 | длительность разговора |
| chunks | Chunks | текстовая расшифровка разбитая на фразы участников звонка |
Chunks
| Параметр | Тип | Описание |
|---|---|---|
| channel_tag | uint64 | канал связи (1 — звонящий абонент, 2 — отвечающий абонент) |
| text | string | текст |
| start_time | uInt64 | Время начала фразы в секундах |
| end_time | uInt64 | Время конца фразы в секундах |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | invalid value [value] | в поле uid невалидный формат |
| 401 | Bad Request | error while trying to get token from header | нет заголовка авторизации |
| 401 | Bad Request | failed to parse token | невалидный API-ключ |
| 404 | Bad Request | not found transcribation with uid | нет текстовой расшифровки по этому идентификатору звонка |
| 404 | Not Found | invalid uid or application uuid | неверный идентификатор звонка |
Примеры
Входные параметры:
{
"date_from": "2022-11-20T00:50:00Z",
"date_to": "2024-11-22T23:50:00Z",
"limit": 10,
"offset": 0
}
Выходные параметры:
{
"transcribation": [
{
"url": "",
"uid": 7122485413423484900,
"application_uuid": "b7da867d-8c2c-4832-a924-48fbc1e7000",
"date_time": "2023-12-13T14:25:44Z",
"number_b": "79151234567",
"number_a": "79151234578",
"redirect_number": "79151234570",
"duration": 1,
"call_start": "2023-12-13T14:26:44Z",
"call_end": "2023-12-13T14:30:44Z",
"chunks": {
"channel_tag": "1",
"text": "привет",
"start_time": {
"seconds":0
},
"end_time": {
"seconds":0
}
}
}
]
}