Qodex.ai

Get a user's profile

GET {{baseUrl}}/phone/users/:userId

Returns a user's Zoom phone profile. For user-level apps, pass the me value instead of the userId parameter.

Prerequisites:

  • A Business or Enterprise account
  • A Zoom Phone license

Scopes: phone:read:admin , phone:read

Granular Scopes: phone:read:user , phone:read:user:admin

Rate Limit Label : LIGHT

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{"calling_plans":[{"type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"},{"type":"\u003cinteger\u003e","billing_account_id":"\u003cstring\u003e","billing_account_name":"\u003cstring\u003e"}],"cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","email":"\u003cstring\u003e","emergency_address":{"address_line1":"\u003cstring\u003e","address_line2":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","id":"\u003cstring\u003e","state_code":"\u003cstring\u003e","zip":"\u003cstring\u003e"},"extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","id":"\u003cstring\u003e","phone_numbers":[{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","number":"\u003cstring\u003e"}],"phone_user_id":"\u003cstring\u003e","policy":{"ad_hoc_call_recording":{"enable":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":80,"play_beep_time_interval":60,"play_beep_member":"allMember"},"locked":"\u003cboolean\u003e","locked_by":"site"},"ad_hoc_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}],"auto_call_recording":{"allow_stop_resume_recording":"\u003cboolean\u003e","disconnect_on_recording_failure":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","recording_calls":"inbound","recording_explicit_consent":"\u003cboolean\u003e","recording_start_prompt":"\u003cboolean\u003e","recording_transcription":"\u003cboolean\u003e","play_recording_beep_tone":{"enable":"\u003cboolean\u003e","play_beep_volume":0,"play_beep_time_interval":5,"play_beep_member":"recordingSide"}},"auto_call_recording_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}],"call_overflow":{"call_overflow_type":2,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e"},"call_park":{"call_not_picked_up_action":"\u003cinteger\u003e","enable":"\u003cboolean\u003e","expiration_period":9,"forward_to":{"display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","extension_type":"sharedLineGroup","id":"\u003cstring\u003e"},"locked":"\u003cboolean\u003e","locked_by":"account"},"call_transferring":{"call_transferring_type":3,"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group"},"delegation":"\u003cboolean\u003e","elevate_to_meeting":"\u003cboolean\u003e","emergency_address_management":{"enable":"\u003cboolean\u003e","prompt_default_address":"\u003cboolean\u003e"},"emergency_calls_to_psap":"\u003cboolean\u003e","forwarding_to_external_numbers":"\u003cboolean\u003e","call_handling_forwarding_to_other_users":{"enable":"\u003cboolean\u003e","call_forwarding_type":4,"locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"hand_off_to_room":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account"},"international_calling":"\u003cboolean\u003e","mobile_switch_to_carrier":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site"},"select_outbound_caller_id":{"enable":"\u003cboolean\u003e","allow_hide_outbound_caller_id":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group"},"sms":{"enable":"\u003cboolean\u003e","international_sms":"\u003cboolean\u003e","international_sms_countries":["\u003cstring\u003e","\u003cstring\u003e"],"locked":"\u003cboolean\u003e","locked_by":"user_group"},"voicemail":{"allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_transcription":"\u003cboolean\u003e","allow_videomail":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"voicemail_access_members":[{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"},{"access_user_id":"\u003cstring\u003e","allow_delete":"\u003cboolean\u003e","allow_download":"\u003cboolean\u003e","allow_sharing":"\u003cboolean\u003e","shared_id":"\u003cstring\u003e"}],"zoom_phone_on_mobile":{"allow_calling_sms_mms":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group"},"personal_audio_library":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e","allow_music_on_hold_customization":"\u003cboolean\u003e","allow_voicemail_and_message_greeting_customization":"\u003cboolean\u003e"},"voicemail_transcription":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"voicemail_notification_by_email":{"include_voicemail_file":"\u003cboolean\u003e","include_voicemail_transcription":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"shared_voicemail_notification_by_email":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"check_voicemails_over_phone":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"audio_intercom":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"account","modified":"\u003cboolean\u003e"},"peer_to_peer_media":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"site","modified":"\u003cboolean\u003e"},"e2e_encryption":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","locked_by":"user_group","modified":"\u003cboolean\u003e"},"outbound_calling":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","modified":"\u003cboolean\u003e"},"outbound_sms":{"enable":"\u003cboolean\u003e","locked":"\u003cboolean\u003e","modified":"\u003cboolean\u003e"}},"site_admin":"\u003cboolean\u003e","site_id":"\u003cstring\u003e","status":"deactivate"}