This page describes all the API calls you can make to get information and control your voice server(s).
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.
POST
getAll
Get a list of all your voice servers and their details.
Request parameters| Parameter | Context | Type | Description |
|---|
| No parameters |
Response parameters| Parameter | Context | Type | Description |
|---|
|
|
|
|
|
|
|
|
|
|
| voiceservers | | array | List of voice servers |
voiceserverId | voiceservers | int | The ID of the voice server | serverIp | voiceservers | string | The IP or host name of the voice server | serverPort | voiceservers | int | The port of the voice server | serverName | voiceservers | string | The name of the voice server | numPlayers | voiceservers | int | The number of players currently connected | maxPlayers | voiceservers | int | The maximum number of connections | private | voiceservers | string | "private" or "public" | contractStart | voiceservers | string | The start date of the contract | contractEnd | voiceservers | string | The end date of the contract | dateCancelled | voiceservers | string | The date on which the server has been cancelled, if it has been cancelled |
ExampleArray
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[voiceservers] => Array
(
[0] => Array
(
[voiceserverId] => _ID_
[serverIp] => ventrilo.i3d.net
[serverPort] => 3807
[serverName] => i3D.net - Ventrilo test voiceserver
[numPlayers] => 0
[maxPlayers] => 30
[private] => private
[contractStart] => 17 Apr 2013
[contractEnd] => 17 Apr 2015
[dateCancelled] =>
)
)
)
)
Request parameters| Parameter | Context | Type | Description |
|---|
| voiceserverId | | int | The ID of the voice server |
Response parameters| Parameter | Context | Type | Description |
|---|
| stop | | string | executed |
ExampleArray
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[stop] => Array
(
[stop] => executed
)
)
)
Request parameters| Parameter | Context | Type | Description |
|---|
| voiceserverId | | int | The ID of the voice server |
Response parameters| Parameter | Context | Type | Description |
|---|
| start | | string | executed |
ExampleArray
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[start] => Array
(
[start] => executed
)
)
)
Request parameters| Parameter | Context | Type | Description |
|---|
| voiceserverId | | int | The ID of the voice server |
Response parameters| Parameter | Context | Type | Description |
|---|
| restart | | string | executed |
ExampleArray
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[restart] => Array
(
[restart] => executed
)
)
)