ADDER Infinity - Page 64

63
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
create_preset
This method was last updated in API version 3, and is compatible with API requests from
version 3 onwards
This function creates a new preset. The API user must have admin privileges to call this
method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- name (the display name for the new preset)
- pairs (a comma-separated list of the channel ID–receiver ID pairs for the preset, where
each ID in the pair is separated by a hyphen)
- allowed (the permitted connection modes for the preset. Optional; if omitted, the
global setting will be inherited. Permitted values are:
v - video-only
vs - video-only and shared
s - shared only
e - private only
vse - any mode allowed)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- id (the ID of the new preset, if it was created)
Examples
Input:
/api/?v=3&method=create_preset&token=xxxxx&name=my_preset&pairs=1-1,1-2,2-3,2-
4&allowed=vs
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
<id>5</success>
</api_response>
delete_preset
This method was last updated in API version 3, and is compatible with API requests from
version 3 onwards
This function deletes a preset. The API user must have admin privileges to call this
method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (the ID of the preset to be deleted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=3&method=delete_preset&token=xxxxx&id=5
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>