check-call-server-connection.md

Check Call Server Connection

Check the SIP call server connection status.

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

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

Query Parameters

Key	Example Value	Description
websocketUrl*	wss://omni-asterisk.dev.rocket.chat/ws	The websocket URL.
host*	localhost	The hostname of the call server.
port*	3000	The port number of the websocket.
path*	test/voip	The path of the websocket.

Example Call

{% code overflow="wrap" %}

curl --location 'http://localhost:3000/api/v1/voip/callServer/checkConnection?websocketURL=wss%3A%2F%2Fomni-asterisk.dev.rocket.chat%2Fws&host=localhost&port=3000&path=test' \
--header 'X-Auth-Token: NcQtu58azANDJ1FuCmGvGVOWhYIpJVg4GqhK9h-j61l' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC'

{% endcode %}

Example Response

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