Записи разговора (attachments)

Обзор

Предоставляет доступ к файлам записей разговора.

Каждый звонок в подавляющем большинстве случаев содержит не более одного файла записи. В общем случае звонок может иметь несколько файлов записей.

В соответствии с правилами хранения записи могут автоматически удаляться. Пользователям также могут быть назначены роли доступа, позволяющие запросы к API удаления файлов записей разговоров.

Доступно только в рабочих доменах.

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/journal/calls/<inviteid>/attachments

Получение списка файлов записей звонка

GET

/rest/v1/journal/calls/<inviteid>/attachments/FILENAME

Получение файла записи по имени

DELETE

/rest/v1/journal/calls/<inviteid>/attachments/FILENAME

Удаление файла звонка

DELETE

/rest/v1/journal/calls/<inviteid>/attachments

Удаление всех файлов звонка

HEAD

/rest/v1/journal/calls/<inviteid>/attachments/FILENAME

Получение информации о файле


Получение списка файлов записей звонка

Запрос

Пример запроса
GET /rest/v1/journal/calls/37dd29c9-0622-2b0d-0d4a-580000000002/attachments HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "site": "SITE1",
    "files": [
      {
        "name": "site1_x_11492-1570176336928.mp3",
        "size": 19296
        "_links": {
          "self": {
            "href": "/rest/v1/journal/calls/9ef49d6e-0623-2573-acd0-290000000002/attachments/mg1_1111150691-1571153402983.mp3"
          }
        }
      }
    ]
  }
]

Получение файла записи по имени

Запрос

Table 1. Параметры запроса
Имя Тип Описание

attachment

bool

Тип выдачи. По умолчанию false.

  • true – выдается с заголовками Content-Type: application/octet-stream и Content-Disposition: attachment; filename*=UTF-8''FILENAME.EXT, где FILENAME.EXT – имя и расширение файла в UrlEncoding, и отправляется на скачивание браузером.

  • false – выдается с Content-Type, соответствующим mime-type расширения файла.

Пример запроса
GET /rest/v1/journal/calls/37dd29c9-0622-2b0d-0d4a-580000000002/attachments/site1_x_11492-1570176336928.mp3 HTTP/1.1

Ответ

Пример ответа с параметром attachment=false
HTTP/1.1 200 Ok
Content-Length: 19296
Content-Type: audio/mpeg

BINARY
Пример ответа с параметром attachment=true
HTTP/1.1 200 Ok
Content-Length: 19296
Content-Type: audio/mpeg
Cache-Control: no-cache, no-store, must-revalidate
Content-Disposition: attachment; filename=site1_x_11492-1570176336928.mp3

BINARY
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Call record not found"
}

Удаление файла звонка

Не реализовано.

Запрос

Пример запроса
DELETE /rest/v1/journal/calls/37dd29c9-0622-2b0d-0d4a-580000000002/attachments/site1_x_11492-1570176336928.mp3 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Удаление всех файлов звонка

Не реализовано.

Запрос

Пример запроса
DELETE /rest/v1/journal/calls/37dd29c9-0622-2b0d-0d4a-580000000002/attachments HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Запрос

Пример запроса
HEAD /rest/v1/journal/calls/37dd29c9-0622-2b0d-0d4a-580000000002/attachments/site1_x_11492-1570176336928.mp3

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
Content-Length: 188426
Content-Type: audio/mpeg