1. References
  2. Management API
  3. Users
Rate this page:

Users

Methods

AddUser

Copy URL

Adds a new user.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
User manager
AddUser example
Copy

AddUser example

Add a new user.

Parameters

  • application_id:

    number

    The application ID which a new user is to be bound to. Can be used instead of the application_name parameter

  • application_name:

    string

    The application name which a new user is to be bound to. Can be used instead of the application_id parameter

  • parent_accounting:

    boolean

    Optional

    Whether the user uses the parent account's money, 'false' if the user has a separate balance

  • user_active:

    boolean

    Optional
    Defaults on:  true

    Whether the user is active. Inactive users cannot log in to applications

  • user_custom_data:

    string

    Optional

    Any string

  • user_display_name:

    string

    The user display name. The length must be less than 256

  • user_name:

    string

    The user name in format [a-z0-9][a-z0-9_-]{2,49}

  • user_password:

    string

    The user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character

Returns

  • result:

    number

    1

  • user_id:

    number

    The new user ID

DelUser

Copy URL

Deletes the specified user(s).

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
User manager
DelUser example
Copy

DelUser example

Delete two users with ID 3 and 55.

Parameters

  • application_id:

    number

    Optional

    Delete the specified users bound to the application ID. It is required if the user_name is specified

  • application_name:

    string

    Optional

    Delete the specified users bound to the application name. Can be used instead of the application_id parameter

  • user_id:

    intlist

    The user ID list separated by semicolons (;). Use the 'all' value to select all users

  • user_name:

    stringlist

    The user name list separated by semicolons (;) that can be used instead of user_id

Returns

  • result:

    number

    1

GetUsers

Copy URL

Shows the users of the specified account.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
Supervisor
User manager
GetUsers example
Copy

GetUsers example

Get two first identities.

Parameters

  • acd_queue_id:

    number

    Optional

    The ACD queue ID to filter

  • acd_status:

    stringlist

    Optional

    The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND

  • application_id:

    number

    The application ID to filter

  • application_name:

    string

    The application name part to filter

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • excluded_acd_queue_id:

    number

    Optional

    The excluded ACD queue ID to filter

  • excluded_skill_id:

    number

    Optional

    The excluded skill ID to filter

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

  • order_by:

    string

    Optional
    Defaults on:  user_name

    The following values are available: 'user_id', 'user_name' and 'user_display_name'

  • return_live_balance:

    boolean

    Optional
    Defaults on:  true

    Whether to get the user live balance

  • showing_skill_id:

    number

    Optional

    The skill to show in the 'skills' field output

  • skill_id:

    number

    Optional

    The skill ID to filter

  • user_active:

    boolean

    Optional

    Whether the user is active to filter. Inactive users cannot log in to applications

  • user_display_name:

    string

    Optional

    The user display name part to filter

  • user_id:

    number

    Optional

    The user ID to filter

  • user_name:

    string

    Optional

    The user name part to filter

  • with_queues:

    boolean

    Optional
    Defaults on:  false

    Whether to get the bound queues

  • with_skills:

    boolean

    Optional
    Defaults on:  false

    Whether to get the bound skills

Returns

  • count:

    number

    The returned user count

  • result:

    [UserInfoType]

    The UserInfoType records

  • total_count:

    number

    The total found user count

SetUserInfo

Copy URL

Edits the user.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
User manager
SetUserInfo example
Copy

SetUserInfo example

Edit the user password.

Parameters

  • application_id:

    number

    Optional

    The application ID. It is required if the user_name is specified

  • application_name:

    string

    Optional

    The application name that can be used instead of application_id

  • new_user_name:

    string

    Optional

    The new user name in format [a-z0-9][a-z0-9_-]{2,49}

  • parent_accounting:

    boolean

    Optional

    Whether to use the parent account's money, 'false' to use a separate user balance

  • user_active:

    boolean

    Optional
    Defaults on:  true

    Whether the user is active. Inactive users cannot log in to applications

  • user_custom_data:

    string

    Optional

    Any string

  • user_display_name:

    string

    Optional

    The new user display name. The length must be less than 256

  • user_id:

    number

    The user to edit

  • user_name:

    string

    The user name that can be used instead of user_id

  • user_password:

    string

    Optional

    The new user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character

Returns

  • result:

    number

    1