Check Call Server Connection
Use this endpoint to check the SIP call 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 | Example | Required | Description |
websocketUrl | string | Yes | The Websocket URL |
host | string | Yes | The hostname of the Call Server. |
port | string | Yes | The port number of the Websocket. |
path | string | Yes | The path of the Websocket. |
curl --location --request GET 'localhost:3000/api/v1/voip/callServer/checkConnection?websocketUrl=wss://omni-asterisk.dev.rocket.chat/ws' \
--header 'X-Auth-Token: aEoKaT8qus3IZHlr_OlAzcsnz46SzZLJeqoRbbctcDQ' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--header 'Content-Type: application/json' \
--data-raw '{
"rid": "c9YW3rejo7HeL6ZDW",
"token": "yHoawq4s9bDn4dM5H"
}'
{
"status": "connected" | "connection-error",
"error?": "string"
}
401 Unauthorized
Last modified 1yr ago