Zoom Public API Documentation
Get user profile settings
GET {{baseUrl}}/phone/users/:userId/settings
Use this API to get the Zoom Phone profile settings of a user. For user-level apps, pass the Scopes: Prerequisites:
* A Business or Enterprise account
* A Zoom Phone licenseme value instead of the userId parameter.phone:read, phone:read:admin
Rate Limit Label: Light
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"area_code": "01",
"audio_prompt_language": "en-US",
"company_number": "+12058945640",
"country": {
"code": "US",
"country_code": "1",
"name": "United States"
},
"delegation": {
"assistants": [
{
"display_name": "test user delegation",
"extension_id": "CcrEGgmeQem1uyJsuIRKwA",
"extension_number": "1000123477",
"extension_type": "user",
"id": "fWOgOALdT1ei4vjXK-QYsA"
},
{
"display_name": "test user delegation",
"extension_id": "CcrEGgmeQem1uyJsuIRKwA",
"extension_number": "1000123477",
"extension_type": "user",
"id": "fWOgOALdT1ei4vjXK-QYsA"
}
],
"privacy": true,
"privileges": 2
},
"desk_phone": {
"devices": [
{
"device_type": "Yealink t42s",
"display_name": "ApiTA_Device_2020_12_14_22_59_31_749",
"id": "GHFnf5WQe-H-_r0Wwx9iQ",
"policy": {
"call_control": {
"status": "off"
},
"hot_desking": {
"status": "off"
}
},
"status": "online"
},
{
"device_type": "Yealink t42s",
"display_name": "ApiTA_Device_2020_12_14_22_59_31_749",
"id": "GHFnf5WQe-H-_r0Wwx9iQ",
"policy": {
"call_control": {
"status": "off"
},
"hot_desking": {
"status": "off"
}
},
"status": "online"
}
],
"keys_positions": {
"primary_number": "+123456789"
},
"phone_screen_lock": true,
"pin_code": "0995"
},
"extension_number": 1000001036,
"music_on_hold_id": "NOZ98sQvTimYi0XxL_x-iQ",
"outbound_caller": {
"number": "+123456789"
},
"outbound_caller_ids": [
{
"is_default": true,
"name": "Outbound caller name.",
"number": "+2097392651"
},
{
"is_default": true,
"name": "Outbound caller name.",
"number": "+2097392651"
}
],
"status": "Active",
"voice_mail": [
{
"access_user_id": "DnEopNmXQEGU2uvvzjgojw",
"delete": true,
"download": true,
"shared_id": "--e8ugg0SeS-9clgrDkn2w"
},
{
"access_user_id": "DnEopNmXQEGU2uvvzjgojw",
"delete": true,
"download": true,
"shared_id": "--e8ugg0SeS-9clgrDkn2w"
}
],
"intercom": {
"audio_intercoms": [
{
"extension_id": "52OdSKGSSS-EOyJwQncFvA",
"extension_number": "1000001004",
"extension_type": "user",
"display_name": "test name",
"status": "pending",
"device_id": "GHFnf5WQe-H-_r0Wwx9iQ",
"device_status": "offline"
},
{
"extension_id": "52OdSKGSSS-EOyJwQncFvA",
"extension_number": "1000001004",
"extension_type": "user",
"display_name": "test name",
"status": "pending",
"device_id": "GHFnf5WQe-H-_r0Wwx9iQ",
"device_status": "offline"
}
],
"device": {
"id": "JHwOJZ_PRICfVhQlL0x_ww",
"name": "Sita's Phone"
}
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId/settings' -H 'Accept: application/json'
ENDPOINTS