Page Comparison

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

Ресурс предназначен для получения информации о залогиненном пользователе. Может быть использован для получения идентификатора пользователя.

Table of Contents

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

Expand

title	Развернуть

Имя	Тип	Описание
access	string	Уровень доступа пользователя. Может принимать значения full (полный доступ) и read_only (доступ только на чтение, разрешены только GET-запросы)
admin	boolean	Имеет значение true, если тип пользователя "администратор", в остальных случаях имеет значение false (пользователь уровня "администратор" вне данной документации)
client_id	long	Идентификатор клиента пользователя. Задан, если тип пользователя "клиент"
dealer_id	long	Идентификатор дилера пользователя. Задан, если тип пользователя “дилер” (пользователь уровня "дилер" вне данной документации)
extension_group_id	long	Идентификатор группы внутренних номеров пользователя. Задан, если тип пользователя "группа внутренних номеров"
extension_id	long	Идентификатор внутреннего номера пользователя. Задан, если тип пользователя "внутренний номер"
extra_params	string	Дополнительные параметры
id	long	Уникальный идентификатор пользователя
login	string	Уникальный логин пользователя
timezone	string	Временная зона пользователя

Пример

После авторизации приложения и получения токена выполняется следующий запрос:

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":"/user/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":" "}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"d9b5f2d4-704e-4a20-9ba1-2295549780f7","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значениязначение переменныхпеременной "},{"type":"text","text":"urlaccess_token ","marks":[{"type":"strong"}]},{"type":"text","text":"и заменим"},{"type":"text","text":"access_token hostname","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 \\\r\n-H \"Authorization: Bearer ${access_token}\" \\\r\n-X GET ${url}https://<hostname>/api/ver1.0/user/"}]}]},"id":"829c6b55-4d77-460d-9b6b-2d6aee0e809c","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}/user/\"\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)"}]}]},"id":"09301931-c573-439d-96dd-8015970b80b8","label":"На языке Python3    ","type":"tab"}]

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

Code Block

language	json

{
  "dealer_id": null,
  "admin": false,
  "extra_params": null,
  "access": "full",
  "extension_id": null,
  "client_id": 100,
  "extension_group_id": null,
  "timezone": "Europe/Moscow",
  "login": "client_login",
  "id": 123
}

Из ответа видно, что работа идет от имени пользователя уровня "клиент" с логином "client_login" и идентификатором 100.

Ресурсы

Expand

title	GET /user/

GET /user/

Получить информацию о текущем авторизованном пользователе

Поля ответа

Имя	Тип
dealer_id	long
admin	boolean
extra_params	string
access	string
extension_id	long
client_id	long
extension_group_id	long
timezone	string
login	string
id	long

Versions Compared

Old Version 1

New Version Current

Key

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

Пример

Ресурсы