Links
Comment on page

Voice channel registration information

Retrieves the User Registration Information for the User ID.
URL
Requires Authentication
HTTP Method
/api/v1/connector.extension.getRegistrationInfoByUserId
Yes
GET

Request Headers

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)

Payload

Argument
Data Type
Required
Description
id
String
Yes
The identifier of the user whose registration is being retrieved.

Example Call

curl --location --request GET 'localhost:3000/api/v1/connector.extension.getRegistrationInfoByUserId' \
--header 'X-Auth-Token: xS8jnLS2YzVy-_w8T_S0WnQm5SnADjACa7gbXmcOcLY' \
--header 'X-User-Id: 6vHSSqdBHdm2R4gfi' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "ByehQjC44FwMeiLbX"
}'

Example Response

The response for this API contains the VoIP User Registration information.
{
"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"
}
}

Error Response

401 Unauthorized
Last modified 6mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.