Enable or disable a service.

This function has the following parameters:

Parameter Name Mandatory Default Value Description
id true null The id of the service
enable true null 1 to enable, 0 to disable service

An example of the enableService interface is:

enableService id=5 enable=0

This disables the service with an id of 5.


API Call:

enableService id=5 enable=0

JSON Response:

    "description":"Status changed",

The JSON response contains the following details:

  • data – The data to parse

    • acceptedConnectionsCount – Number of active connections
    • appId – ID of application using the service
    • appName – Application using the service
    • droppedConnectionsCount – Number of dropped connections
    • enabled - true if the service is enabled, false if not
    • id – ID of the service
    • ip – IP address used by the service
    • port – Port used by the service
    • protocol – Protocol used by the service
    • sslCert – The SSL certificate
    • sslKey – The SSL certificate key
    • waitForMedia -
  • description – Describes the result of parsing/executing the command

  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not