GET {{baseUrl}}/phone/users/:userId
Returns a user's Zoom phone profile. 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:read
phone:read:user
,phone:read:user:admin
LIGHT
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"calling_plans": [
{
"type": "<integer>",
"billing_account_id": "<string>",
"billing_account_name": "<string>"
},
{
"type": "<integer>",
"billing_account_id": "<string>",
"billing_account_name": "<string>"
}
],
"cost_center": "<string>",
"department": "<string>",
"email": "<string>",
"emergency_address": {
"address_line1": "<string>",
"address_line2": "<string>",
"city": "<string>",
"country": "<string>",
"id": "<string>",
"state_code": "<string>",
"zip": "<string>"
},
"extension_id": "<string>",
"extension_number": "<long>",
"id": "<string>",
"phone_numbers": [
{
"id": "<string>",
"number": "<string>"
},
{
"id": "<string>",
"number": "<string>"
}
],
"phone_user_id": "<string>",
"policy": {
"ad_hoc_call_recording": {
"enable": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 80,
"play_beep_time_interval": 60,
"play_beep_member": "allMember"
},
"locked": "<boolean>",
"locked_by": "site"
},
"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>"
}
],
"auto_call_recording": {
"allow_stop_resume_recording": "<boolean>",
"disconnect_on_recording_failure": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"recording_calls": "inbound",
"recording_explicit_consent": "<boolean>",
"recording_start_prompt": "<boolean>",
"recording_transcription": "<boolean>",
"play_recording_beep_tone": {
"enable": "<boolean>",
"play_beep_volume": 0,
"play_beep_time_interval": 5,
"play_beep_member": "recordingSide"
}
},
"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>"
}
],
"call_overflow": {
"call_overflow_type": 2,
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>"
},
"call_park": {
"call_not_picked_up_action": "<integer>",
"enable": "<boolean>",
"expiration_period": 9,
"forward_to": {
"display_name": "<string>",
"extension_id": "<string>",
"extension_number": "<long>",
"extension_type": "sharedLineGroup",
"id": "<string>"
},
"locked": "<boolean>",
"locked_by": "account"
},
"call_transferring": {
"call_transferring_type": 3,
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group"
},
"delegation": "<boolean>",
"elevate_to_meeting": "<boolean>",
"emergency_address_management": {
"enable": "<boolean>",
"prompt_default_address": "<boolean>"
},
"emergency_calls_to_psap": "<boolean>",
"forwarding_to_external_numbers": "<boolean>",
"call_handling_forwarding_to_other_users": {
"enable": "<boolean>",
"call_forwarding_type": 4,
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"hand_off_to_room": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account"
},
"international_calling": "<boolean>",
"mobile_switch_to_carrier": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site"
},
"select_outbound_caller_id": {
"enable": "<boolean>",
"allow_hide_outbound_caller_id": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group"
},
"sms": {
"enable": "<boolean>",
"international_sms": "<boolean>",
"international_sms_countries": [
"<string>",
"<string>"
],
"locked": "<boolean>",
"locked_by": "user_group"
},
"voicemail": {
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"allow_transcription": "<boolean>",
"allow_videomail": "<boolean>",
"enable": "<boolean>"
},
"voicemail_access_members": [
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"allow_sharing": "<boolean>",
"shared_id": "<string>"
},
{
"access_user_id": "<string>",
"allow_delete": "<boolean>",
"allow_download": "<boolean>",
"allow_sharing": "<boolean>",
"shared_id": "<string>"
}
],
"zoom_phone_on_mobile": {
"allow_calling_sms_mms": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group"
},
"personal_audio_library": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>",
"allow_music_on_hold_customization": "<boolean>",
"allow_voicemail_and_message_greeting_customization": "<boolean>"
},
"voicemail_transcription": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"voicemail_notification_by_email": {
"include_voicemail_file": "<boolean>",
"include_voicemail_transcription": "<boolean>",
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"shared_voicemail_notification_by_email": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"check_voicemails_over_phone": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"audio_intercom": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "account",
"modified": "<boolean>"
},
"peer_to_peer_media": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "site",
"modified": "<boolean>"
},
"e2e_encryption": {
"enable": "<boolean>",
"locked": "<boolean>",
"locked_by": "user_group",
"modified": "<boolean>"
},
"outbound_calling": {
"enable": "<boolean>",
"locked": "<boolean>",
"modified": "<boolean>"
},
"outbound_sms": {
"enable": "<boolean>",
"locked": "<boolean>",
"modified": "<boolean>"
}
},
"site_admin": "<boolean>",
"site_id": "<string>",
"status": "deactivate"
} |
ENDPOINTS