check-management-server-connection.md

Check Management Server Connection

Check the VoIP management server connection status.

HTTP Method	URL	Requires Auth
GET	/api/v1/voip/managementServer/checkConnection	yes

{% hint style="info" %} Permission required: manage-voip-contact-center-settings {% endhint %}

Query Parameters

Key	Example Value	Description
host*	localhost	The hostname of the management server.
port*	3000	The port number of the management server.
username*	user1	The user name of the administrator user.
password*	idosfiejifc354	The password of the administrator user.

Example Call

{% code overflow="wrap" %}

curl --location --request GET 'localhost:3000/api/v1/voip/managementServer/checkConnection?host=localhost&port=3000&username=christystha&password=' \
--header 'X-Auth-Token: aEoKaT8qus3IZHlr_OlAzcsnz46SzZLJeqoRbbctcDQ' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--data-raw ''

{% endcode %}

Example Response

{
	"status": "connected" | "connection-error",
	"error?": "string"
}