Managing Applications
Methods
AddApplication
Adds a new account's application.
Parameters
Follow link for authentication parameter names and details.
application_name:
stringThe short application name in format a-z{1,79}
Returns
result:
number1
application_id:
numberThe application ID
application_name:
stringThe 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"
}
DelApplication
Deletes the account's application.
Parameters
Follow link for authentication parameter names and details.
application_id:
stringThe application ID list separated by the ';' symbol or the 'all' value.
application_name:
stringThe application name list separated by the ';' symbol. Can be used instead of appliction_id.
Returns
result:
number1
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
}
GetApplications
Gets the account's applications.
Parameters
Follow link for authentication parameter names and details.
- OPTIONAL
application_id:
numberThe application ID to filter.
- OPTIONAL
application_name:
stringThe application name part to filter.
- OPTIONAL
user_id:
numberThe binding user ID to filter.
- OPTIONAL
excluded_user_id:
numberThe excluded binding user ID to filter.
- OPTIONAL
showing_user_id:
numberSpecify the binding user ID value to show it in the 'users' array output.
- OPTIONALDEFAULTS TO: false
with_rules:
booleanSet true to get binding rules info.
- OPTIONALDEFAULTS TO: false
with_scenarios:
booleanSet true to get binding rules and scenarios info.
- OPTIONALDEFAULTS TO: 20
count:
numberThe max returning record count.
- OPTIONALDEFAULTS TO: 0
offset:
numberThe first N records will be skipped in the output.
Returns
result:
[ ApplicationInfoType ]total_count:
numberThe total found application count.
count:
numberThe 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
}
SetApplicationInfo
Edits the account's application.
Parameters
Follow link for authentication parameter names and details.
application_id:
numberThe application ID.
required_application_name:
stringCan be used instead of application_id.
- OPTIONAL
application_name:
stringThe new short application name in format a-z{1,79}
Returns
result:
number1
application_name:
stringThe 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"
}