Zoom Public API Documentation
Get a user's profile settings
GET {{baseUrl}}/phone/users/:userId/settings
Gets the Zoom Phone profile settings of a user. For user-level apps, pass the Prerequisites:
* A Business or Enterprise account
* A Zoom Phone license Scopes: Granular Scopes: Rate Limit Label: me value instead of the userId parameter.phone:read:admin,phone:readphone:read:user_setting:admin,phone:read:user_settingLight
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"area_code": "<string>",
"audio_prompt_language": "<string>",
"company_number": "<string>",
"country": {
"code": "<string>",
"country_code": "<string>",
"name": "<string>"
},
"delegation": {
"assistants": [
{
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"extension_type": "<string>",
"id": "<string>"
},
{
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"extension_type": "<string>",
"id": "<string>"
}
],
"privacy": "<boolean>",
"privileges": 3,
"locked": "<boolean>"
},
"desk_phone": {
"devices": [
{
"device_type": "<string>",
"display_name": "<string>",
"id": "<string>",
"policy": {
"call_control": {
"status": "unsupported"
},
"hot_desking": {
"status": "off"
}
},
"status": "offline"
},
{
"device_type": "<string>",
"display_name": "<string>",
"id": "<string>",
"policy": {
"call_control": {
"status": "off"
},
"hot_desking": {
"status": "on"
}
},
"status": "online"
}
],
"keys_positions": {
"primary_number": "<string>"
},
"phone_screen_lock": "<boolean>",
"pin_code": "<string>"
},
"extension_number": "<long>",
"music_on_hold_id": "<string>",
"outbound_caller": {
"number": "<string>"
},
"outbound_caller_ids": [
{
"is_default": "<boolean>",
"name": "<string>",
"number": "<string>"
},
{
"is_default": "<boolean>",
"name": "<string>",
"number": "<string>"
}
],
"status": "Active",
"voice_mail": [
{
"access_user_id": "<string>",
"delete": "<boolean>",
"download": "<boolean>",
"shared_id": "<string>"
},
{
"access_user_id": "<string>",
"delete": "<boolean>",
"download": "<boolean>",
"shared_id": "<string>"
}
],
"intercom": {
"audio_intercoms": [
{
"extension_id": "<string>",
"extension_number": "<string>",
"extension_type": "<string>",
"display_name": "<string>",
"status": "active",
"device_id": "<string>",
"device_status": "online"
},
{
"extension_id": "<string>",
"extension_number": "<string>",
"extension_type": "<string>",
"display_name": "<string>",
"status": "active",
"device_id": "<string>",
"device_status": "offline"
}
],
"device": {
"id": "<string>",
"name": "<string>"
}
},
"auto_call_recording_access_members": [
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"shared_id": "<string>"
},
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"shared_id": "<string>"
}
],
"ad_hoc_call_recording_access_members": [
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"shared_id": "<string>"
},
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"shared_id": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/settings' -H 'Accept: application/json'
ENDPOINTS