ADDER Infinity - Page 63

To Next Page

To Previous Page

INSTALLATIONCONFIGURATIONOPERATION

FURTHER

INFORMATION

INDEX

disconnect_channel

This method was last updated in API version 2, and is compatible with API requests from

version 2 onwards.

This function disconnects a receiver, a number of receivers, or all connected receivers.

Input parameters:

- token

- v (the AIM API version this request is designed for)

- rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers.

Optional. If not supplied, all connections will be ended)

- force - whether to disconnect existing connections by other users, or for ofine

receivers

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=2&method=disconnect_channel&token=xxxxx (disconnect all your online,

connected channels)

/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1 (disconnect channel 1, if

you connected it and it’s online)

/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,2,3 (disconnect channels

1, 2, and 3, if you connected them and they’re online)

/api/?v=2&method=disconnect_channel&token=xxxxx&force=1 (force disconnect all

connected channels)

/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,3&force=1 (force

disconnect channels 1 and 3)

Output:

<api_response>

</api_response>

disconnect_preset

This method was last updated in API version 1, and is compatible with API requests from

version 1 onwards.

This function disconnects all channel-receiver pairs in a preset, or disconnects ALL

connections in the whole AIM network.