Check Management Server Connection
Use this endpoint to check the VoIP management server connection status
URL | Requires Authentication | HTTP Method |
api/v1/voip/managementServer/checkConnection?host&port&username&password | Yes | GET |
Header | Example | Description |
X-Auth-Token | myauth-token | Your token (returned after you log in through the API) |
X-User-Id | myuser-name | Your username hash (returned after you log in through the API) |
Argument | Data Type | Required | Description |
host | string | Yes | The hostname of the management server. |
port | string | Yes | The port number of the management server |
username | string | Yes | The user name of the administrator user. |
password | string | Yes | The password of the administrator user. |
curl --location --request GET 'localhost:3000/api/v1/voip/managementServer/checkConnection?host=localhost&port=3000&username=christysujitha&password=' \
--header 'X-Auth-Token: aEoKaT8qus3IZHlr_OlAzcsnz46SzZLJeqoRbbctcDQ' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--data-raw ''
{
"status": "connected" | "connection-error",
"error?": "string"
}
401 Unauthorized
Last modified 1yr ago