Get Voice Channel Registration Information

Prev Next
Get
/api/v1/connector.extension.getRegistrationInfoByUserId

Retrieves the user registration Information for the user ID. Permission required: view-agent-extension-association

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
id
stringRequired

The user ID whose registration is being retrieved.

Responses
200

OK

Success Example
{
  "host": "omni-asterisk.dev.rocket.chat",
  "callServerConfig": {
    "websocketPort": "443",
    "websocketPath": "wss://omni-asterisk.dev.rocket.chat/ws"
  },
  "extensionDetails": {
    "extension": "12342",
    "password": "my$up3erP@ssw0rd",
    "authtype": "password",
    "state": "Not in use"
  }
}
Expand All
object
host
string
callServerConfig
object
websocketPort
string
websocketPath
string
extensionDetails
object
extension
string
password
string
authtype
string
state
string
400

Bad Request

Example 1
{
  "success": false,
  "error": "Match error: Missing key 'id'"
}
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

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string