SIGN UP

Managing Applications

Methods

Adds a new account's application.

Parameters

  • Follow link for authentication parameter names and details.

  • application_name:

    string

    The short application name in format a-z{1,79}

Returns

  • result:

    number

    1

  • application_id:

    number

    The application ID

  • application_name:

    string

    The full application name

Examples

request:

Add a new application.

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

response:

Returned 'application_name' is the full application name.

{
    "result": 1,
    "application_id": 1,
    "application_name": "myapp1.test.voximplant.com"
}

Deletes the account's application.

Parameters

  • Follow link for authentication parameter names and details.

  • application_id:

    string

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

  • application_name:

    string

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

Returns

  • result:

    number

    1

Examples

request:

Delete the application 1 and 3.

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

Delete the all applications.

https://api.voximplant.com/platform_api/DelApplication/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=all

response:

Success.

{
    "result": 1
}

Gets the account's applications.

Parameters

  • Follow link for authentication parameter names and details.

  • application_id:

    number

    The application ID to filter.

  • application_name:

    string

    The application name part to filter.

  • user_id:

    number

    The binding user ID to filter.

  • excluded_user_id:

    number

    The excluded binding user ID to filter.

  • showing_user_id:

    number

    Specify the binding user ID value to show it in the 'users' array output.

  • with_rules:

    boolean
    Defaults to false

    Set true to get binding rules info.

  • with_scenarios:

    boolean
    Defaults to false

    Set true to get binding rules and scenarios info.

  • count:

    number
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Defaults to 0

    The first N records will be skipped in the output.

Returns

  • total_count:

    number

    The total found application count.

  • count:

    number

    The returned application count.

Examples

request:

Get two applications, but skip the first one.

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

response:

{
    "count": 2,
    "result": [
        {
            "modified": "2013-09-09 14:12:12",
            "application_id": 2,
            "application_name": "myapp2.test.voximplant.com"
        },
        {
            "modified": "2013-09-09 14:12:46",
            "application_id": 3,
            "application_name": "myapp3.test.voximplant.com"
        }
    ],
    "total_count": 17
}

Edits the account's application.

Parameters

  • Follow link for authentication parameter names and details.

  • application_id:

    number

    The application ID.

  • required_application_name:

    string

    Can be used instead of application_id.

  • application_name:

    string

    The new short application name in format a-z{1,79}

Returns

  • result:

    number

    1

  • application_name:

    string

    The new full application name

Examples

request:

Change the application name.

https://api.voximplant.com/platform_api/SetApplicationInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=1&application_name=myapp11

response:

Returned 'application_name' is the new full application name.

{
    "result": 1,
    "application_name": "myapp11.test.voximplant.com"
}