Check Call Server Connection
- Print
- DarkLight
- PDF
Check Call Server Connection
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/voip/callServer/checkConnection
Check the SIP call server connection status. Permission required: manage-voip-contact-center-settings
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
websocketUrl
stringRequired
The websocket URL.
Examplewss://omni-asterisk.dev.rocket.chat/ws
host
stringRequired
The hostname of the call server.
Examplelocalhost
port
stringRequired
The port number of the websocket.
Example3000
path
stringRequired
The path of the websocket.
Exampletest/voip
Responses
200
OK
Example 1
{
"status": "connected | connection-error",
"error": "string"
}object
status
string
error
string
400
Bad Request
Example 1
{
"success": false,
"error": "Incorrect / Insufficient Parameters"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?