Internal Number User (/user/extension/)

_{You can test API methods on the}_{interactive API browser}_{page and without writing code}
_{Some of the resources described on the page may not be available by default due to the type of application (see}_{Creating and authorizing applications}_).

This resource is intended for creating, deleting, and managing and refining user parameters at the internal number level. The user of the internal number level has access to the settings and resources of a specific internal number, and depending on the access type has full access or read-only access (read_only) without the right to make any changes in the settings.

1 Description of data structures
2 Resources of the "Client" section

Description of data structures

Name	Type	Mandatory	Description

Name	Type	Mandatory	Description
comment	string	none	Comment (note)
status	string	none	User status. Can be: 'active' or 'blocked'
name	string	yes	User Name
access	string	none	The type of access to resources. Can be 'full' or 'read_only' (no rights for changes)
extension_id	integer	yes	ID of the internal number for which the user is being created
extra_params	string	none	Field for additional parameters, can be adapted for any purpose
timezone	string	none	User's time zone
login	string	yes	User Login
password	string	yes	User Password
email	string	yes	user's e-mail address
email_notify	boolean	none	If the parameter takes the value 'True’, then the data for access to the system for the new user will be sent to the email address: if the email_for_notify parameter is set – send it to the email from email_for_notify; if the email_for_notify parameter is not set – to the current user (who creates)
email_for_notify	string	none	The field required for the email_notify parameter is the e-mail address where the data will be sent when creating a new user

Resources of the "Client" section

POST /client/{client_id}/user/extension/

Add a new user of the "Internal number" level

URL Parameters

Name	Type

Name	Type
client_id	string

Request parameters

Name	Type

Name	Type
comment	string
status	string
name	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
password	string
email	string
email_notify	boolean

Response parameters

Name	Type

Name	Type
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

GET /client/{client_id}/user/extension/

Get a list of users of the "Internal number" level

URL Parameters

Name	Type

Name	Type
client_id	string

Request parameters (filter)

Name	Type

Name	Type
comment	array [string]
status	array [string]
name	array [string]
id	array [integer]
access	array [string]
extension_id	array [integer]
timezone	array [string]
login	array [string]
email	array [string]

Response parameters

Name	Type

Name	Type
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

PUT /client/{client_id}/user/extension/{user_id}

Update the user of the "Internal number" level

URL Parameters

Name	Type

Name	Type
user_id	integer
client_id	string

Request parameters

Name	Type

Name	Type
comment	string
status	string
name	string
access	string
extension_id	long
extra_params	string
timezone	string
password	string
email	string

Response parameters

Name	Type

Name	Type
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

GET /client/{client_id}/user/extension/{user_id}

Request parameters of the user of the "Internal number" level

URL Parameters

Name	Type

Name	Type
user_id	integer
client_id	string

Response parameters

Name	Type

Name	Type
comment	string
status	string
name	string
email	string
access	string
extension_id	long
extra_params	string
timezone	string
login	string
id	long

DELETE /client/{client_id}/user/extension/{user_id}

Delete the user of the "Internal number" level

URL Parameters

Name	Type

Name	Type
user_id	integer
client_id	string