POST /calltracking/call/record

Возвращает ссылку на запись звонка.

Формат запроса

POST https://apiauto.ru/1.0/calltracking/call/record

Заголовки запроса

Заголовок

Описание

x-dealer-id

Идентификатор клиента. Используется для работы под учетной записью агентства.

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login.

Формат тела запроса

{
  "call_id": {integer},
  "external_id":
    {
      "id": {string},
      "service": {string}
    }
}

call_id

Идентификатор звонка в трекере звонков.


external_id

Внешний идентификатор звонка.


id

Идентификатор звонка.


service

Сервис, в котором используется идентификатор.

Допустимые значения:
  • TELEPONY — прямые входящие звонки;
  • CALL_KEEPER — обратные звонки.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
  "url": {string},
  "headers": {object},
  "expire_timestamp": {string},
  "error": {string},
  "status": {string},
  "detailed_error": {string}
}

url

Ссылка на запись звонка.


headers

Заголовки для запроса.


expire_timestamp

Срок действия для ссылки в формате YYYY-MM-DDThh:mm:ss.fZZZZZ. Например, 2020-06-17T17:20:58.502Z.


error

Код ошибки.


status

Статус запроса.

Допустимые значения:
  • SUCCESS — успешный запрос;
  • ERROR — ошибка.

detailed_error

Детальное описание ошибки.


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X POST 'https://apiauto.ru/1.0/calltracking/call/record' \ 
-H 'x-dealer-id: 2dtrer432...' \
-H 'x-session-id: 112_aoR02Tpv...' \
-H 'Accept: application/json' \
-d '{
      "call_id":0,
      "external_id": {
        "id":"string",
        "service":"TELEPONY"
      }
    }'

Ответ:

HTTP/1.1 200 OK
Server: nginx
Date: Tue, 24 Jul 2018 15:19:41 GMT
Content-Type: application/json
Connection: keep-alive

{
  "url": "string",
  "headers": {},
  "expire_timestamp": "2020-06-17T17:20:58.502Z",
  "status": "SUCCESS"
}