Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

Данный ресурс служит для получения списка оценки разговора в разных звонка.

Table of Contents
Info

Документация по настройке получения запроса оценки разговора доступна здесь: Quality rate. Настройка получения оценки разговора

Описание структур данных

Имя

Тип

Описание

call_uuid

string

Уникальный идентификатор вызова

client_id

long

Идентификатор клиента

datetime

string

Дата оценки

extension_id

long

Идентификатор внутреннего номера

id

long

Уникальный идентификатор оценки

max_rate

long

Максимально возможная оценка

rate

long

Оценка разговора

Получение оценки разговора

Для получения оценки разговора за период времени используется ресурс GET /client/{client_id}/quality_rate/ с фильтром по дате:

Tabs
[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication ","marks":[{"type":"strong"}]},{"type":"text","text":"в поля "},{"type":"text","text":"client_id ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"client_secret ","marks":[{"type":"strong"}]},{"type":"text","text":"требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку "},{"type":"text","text":"\"Try it out!\"","marks":[{"type":"strong"}]},{"type":"text","text":". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки "},{"type":"text","text":"\"Set Token\"","marks":[{"type":"strong"}]},{"type":"text","text":"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/client/@me/quality_rate/?start_datetime=2019-08-01%2000%3A00%3A00&end_datetime=2019-08-10%2000%3A00%3A00"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[]}]}]}]},{"type":"paragraph","content":[]}]},"id":"4d94561d-951c-42f2-94ef-844bd5ae6270","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X GET \"${url}/client/@me/quality_rate/?start_datetime=2019-08-01%2000%3A00%3A00&end_datetime=2019-08-10%2000%3A00%3A00\""}]}]},"id":"cdc4a57a-0eb0-43e9-9f34-8a1a15554c63","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f'{URL}/client/@me/quality_rate/?start_datetime=2019-08-01%2000%3A00%3A00&end_datetime=2019-08-10%2000%3A00%3A00'\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.get(url, headers=headers)\nprint(response.text)"}]}]},"id":"7367eee1-5b40-473e-8312-75dad0c2dca3","label":"На языке Python3    ","type":"tab"}]

Ответ системы:

Code Block
languagejson
{
  "max_rate": 9,
  "datetime": "2019-08-07 12:21:10",
  "rate": 5,
  "extension_id": 27874,
  "client_id": 801,
  "call_uuid": "BF4643A0B90D11E98DA84B40F3DF0459",
  "id": 147
}

extension_id может быть либо id очереди, либо id голосового меню (ivr) в зависимости от того, где настроено правило оценки.

Если необходима детализация звонка, можно воспользоваться ресурсом “История вызовов (/call_history/, /calls/)”:
GET /client/{client_id}/call_history/{call_uuid}
call_uuid получен ранее, в ответе системы на получение оценки разговора quality_rate:
"call_uuid": "BF4643A0B90D11E98DA84B40F3DF0459"

Ресурсы раздела “Клиент”

Expand
titleGET /client/{client_id}/quality_rate/

GET /client/{client_id}/quality_rate/

Параметры URL

Имя

Тип

client_id

string

Параметры запроса

Имя

Тип

start_datetime

string

end_datetime

string

extension_id

integer

Параметры ответа

Имя

Тип

call_uuid

string

client_id

long

datetime

string

extension_id

long

id

long

max_rate

long

rate

long