Check Management Server Connection
- Print
- DarkLight
- PDF
Check Management Server Connection
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/voip/managementServer/checkConnection
Check the VoIP management 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
host
stringRequired
The hostname of the management server.
Examplelocalhost
port
stringRequired
The port number of the management server.
Example3000
username
stringRequired
The user name of the administrator user.
Exampleuser1
password
stringRequired
The password of the administrator user.
Exampleidosfiejifc354
Responses
200
OK
Example 1
{
"status": "connected | connection-error",
"error": "string"
}object
status
string
error
string
400
Bad Request
Example 1
{
"success": false,
"error": "Match error: Missing key 'port'"
}Example 2
{
"success": false,
"error": "Match error: Missing key 'host'"
}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?