Voice server API calls

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.

Actions

POST 
getAll

Get a list of all your voice servers and their details.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
voiceserversarrayList of voice servers
voiceserverIdvoiceserversintThe ID of the voice server
serverIpvoiceserversstringThe IP or host name of the voice server
serverPortvoiceserversintThe port of the voice server
serverNamevoiceserversstringThe name of the voice server
numPlayersvoiceserversintThe number of players currently connected
maxPlayersvoiceserversintThe maximum number of connections
privatevoiceserversstring"private" or "public"
contractStartvoiceserversstringThe start date of the contract
contractEndvoiceserversstringThe end date of the contract
dateCancelledvoiceserversstringThe date on which the server has been cancelled, if it has been cancelled

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [voiceservers] => Array
                (
                    [0] => Array
                        (
                            [voiceserverId] => 2913
                            [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] => 
                        )

                )

        )

)
POST 
stop

Stop a voice server


Request parameters
ParameterContextTypeDescription
voiceserverIdintThe ID of the voice server
Response parameters
ParameterContextTypeDescription
stopstringexecuted

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [stop] => Array
                (
                    [stop] => executed
                )

        )

)
POST 
start

Start a voice server


Request parameters
ParameterContextTypeDescription
voiceserverIdintThe ID of the voice server
Response parameters
ParameterContextTypeDescription
startstringexecuted

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [start] => Array
                (
                    [start] => executed
                )

        )

)
POST 
restart

Restart a voice server


Request parameters
ParameterContextTypeDescription
voiceserverIdintThe ID of the voice server
Response parameters
ParameterContextTypeDescription
restartstringexecuted

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [restart] => executed
                )

        )

)