SIGN UP

Managing Users

Methods

AddUser

Adds a new user.

Parameters

  • Follow link for authentication parameter names and details.

  • user_name:

    string

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

  • user_display_name:

    string

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

  • user_password:

    string

    The user password. The length must be at least 6 symbols.

  • mobile_phone:

    string
    Optional

    The user mobile phone. The length must be less than 50.

  • user_active:

    boolean
    Optional
    Defaults to true

    The user enable flag

  • user_custom_data:

    string
    Optional

    Any string

  • application_id:

    number
    Optional

    The application ID which new user will be bound to. Could be used instead of the application_name parameter.

  • application_name:

    string
    Optional

    The application name which new user will be bound to. Could be used instead of the application_id parameter.

Returns

  • result:

    number

    1

  • user_id:

    number

    The new user ID.

Examples

request:

Add a new user.

https://api.voximplant.com/platform_api/AddUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_name=iden1&user_display_name=iden1&user_password=1234567

response:

{
    "result": 1,
    "user_id": 1
}

BindUser

Binds the user(s) with the application(s).

Parameters

  • Follow link for authentication parameter names and details.

  • user_id:

    string

    The user ID list separated by the ';' symbol or the 'all' value.

  • user_name:

    string

    Can be used instead of user_id. The user name list separated by the ';' symbol.

  • application_id:

    string

    The application ID list separated by the ';' symbol or the 'all' value.

  • application_name:

    string

    Can be used instead of application_id. The application name list separated by the ';' symbol.

  • bind:

    boolean
    Optional
    Defaults to true

    Bind or unbind?

Returns

  • result:

    number

    1

Examples

request:

Bind the user 1 with the applications 1, 2 and 3.

https://api.voximplant.com/platform_api/BindUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&application_id=1;2;3

response:

Success

{
    "result": 1
}

DelUser

Deletes the user.

Parameters

  • Follow link for authentication parameter names and details.

  • user_id:

    string

    The user ID list separated by the ';' symbol or the 'all' value.

  • user_name:

    string

    The user name list separated by the ';' symbol that can be used instead of user_id.

  • application_id:

    string
    Optional

    Delete the specified users bound to the application ID list separated by the ';' symbol. Could be used instead of the application_name parameter.

  • application_name:

    string
    Optional

    Delete the specified users bound to the application name list separated by the ';' symbol. Could be used instead of the application_id parameter.

Returns

  • result:

    number

    1

Examples

request:

Delete the two user.

https://api.voximplant.com/platform_api/DelUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=3;55

Delete the all users bound to the 'myapp1' application.

https://api.voximplant.com/platform_api/DelUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=all&application_name=myapp1

response:

Success

{
    "result": 1
}

GetUsers

Shows the users of the specifited account.

Parameters

  • Follow link for authentication parameter names and details.

  • application_id:

    number
    Optional

    The application ID to filter.

  • excluded_application_id:

    number
    Optional

    The excluded application ID to filter.

  • excluded_application_name:

    string
    Optional

    The excluded application name to filter.

  • skill_id:

    number
    Optional

    The skill ID to filter.

  • excluded_skill_id:

    number
    Optional

    The excluded skill ID to filter.

  • acd_queue_id:

    number
    Optional

    The ACD queue ID to filter.

  • user_id:

    number
    Optional

    The user ID to filter.

  • user_name:

    string
    Optional

    The user name part to filter.

  • user_active:

    boolean
    Optional

    The user active flag to filter.

  • user_display_name:

    string
    Optional

    The user display name part to filter.

  • application_name:

    string
    Optional

    The application name part to filter.

  • with_applications:

    boolean
    Optional
    Defaults to false

    Set true to get the bound applications.

  • with_skills:

    boolean
    Optional
    Defaults to false

    Set true to get the bound skills.

  • with_queues:

    boolean
    Optional
    Defaults to false

    Set true to get the bound queues.

  • acd_status:

    string
    Optional

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

  • showing_application_id:

    number
    Optional

    The application to show in the 'applications' field output.

  • showing_skill_id:

    number
    Optional

    The skill to show in the 'skills' field output.

  • count:

    number
    Optional
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 0

    The first N records will be skipped in the output.

  • order_by:

    string
    Optional
    Defaults to user_name

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

  • return_live_balance:

    boolean
    Optional
    Defaults to true

    Set true to get the user live balance.

Returns

  • result:

    [ UserInfoType ]

    The UserInfoType records.

  • total_count:

    number

    The total found user count.

  • count:

    number

    The returned user count.

Examples

request:

Get two first identities.

https://api.voximplant.com/platform_api/GetUsers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_applications=true&count=2

response:

{
    "count": 2,
    "result": [
        {
            "frozen": false,
            "balance": 1,
            "user_id": 1,
            "modified": "2013-09-09 11:26:31",
            "user_name": "iden-1",
            "user_active": true,
            "applications": [
                {
                    "modified": "2013-09-09 14:12:46",
                    "application_id": 3,
                    "application_name": "myapp3.test.voximplant.com"
                },
                {
                    "modified": "2013-09-09 14:13:14",
                    "application_id": 4,
                    "application_name": "myapp4.test.voximplant.com"
                }
            ],
            "user_display_name": "iden-1"
        },
        {
            "frozen": false,
            "balance": 0,
            "user_id": 2,
            "modified": "2013-09-09 15:22:13",
            "user_name": "iden-2",
            "user_active": true,
            "applications": [
                {
                    "modified": "2013-09-09 14:13:14",
                    "application_id": 4,
                    "application_name": "myapp4.test.voximplant.com"
                }
            ],
            "user_display_name": "iden-2"
        }
    ],
    "total_count": 2
}

SetUserInfo

Edits the user.

Parameters

  • Follow link for authentication parameter names and details.

  • user_id:

    number

    The user to edit.

  • user_name:

    string

    Can be used instead of user_id.

  • new_user_name:

    string
    Optional

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

  • user_display_name:

    string
    Optional

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

  • user_password:

    string
    Optional

    The new user password. The length must be at least 6 symbols.

  • user_active:

    boolean
    Optional
    Defaults to true

    The user enable flag

  • user_custom_data:

    string
    Optional

    Any string

  • mobile_phone:

    string
    Optional

    The new user mobile phone. The length must be less than 50.

Returns

  • result:

    number

    1

Examples

request:

Edit the user password.

https://api.voximplant.com/platform_api/SetUserInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&user_password=7654321

response:

Success

{
    "result": 1
}