Zoom Public API Documentation
Get user's profile
GET {{baseUrl}}/phone/users/:userId
Use this API to return a user's Zoom phone profile. 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
| {
"calling_plans": [
{
"type": 600
},
{
"type": 600
}
],
"cost_center": "testCostCenter",
"department": "testDepartment",
"email": "suesu_test_delete3@testapi.com",
"emergency_address": {
"address_line1": "55 Almaden Boulevard",
"address_line2": "1002 Airport Way S",
"city": "SAN JOSE",
"country": "US",
"id": "CCc8zYT1SN60i7uDMzDbXA",
"state_code": "CA",
"zip": "95113"
},
"extension_id": "nNGsNx2zRDyiIXWVI23FCQ",
"extension_number": 77521529,
"id": "NL3cEpSdRc-c2t8aLoZqiw",
"phone_numbers": [
{
"id": "---M1padRvSUtw7YihN7sA",
"number": "14232058798"
},
{
"id": "---M1padRvSUtw7YihN7sA",
"number": "14232058798"
}
],
"phone_user_id": "u7pnC468TaS46OuNoEw6GA",
"policy": {
"ad_hoc_call_recording": {
"enable": true,
"recording_start_prompt": true,
"recording_transcription": true
},
"auto_call_recording": {
"allow_stop_resume_recording": true,
"disconnect_on_recording_failure": true,
"enable": true,
"locked": true,
"locked_by": "account",
"recording_calls": "inbound",
"recording_explicit_consent": true,
"recording_start_prompt": true,
"recording_transcription": true
},
"call_overflow": {
"call_overflow_type": 1,
"enable": true,
"locked": true,
"locked_by": "account"
},
"call_park": {
"call_not_picked_up_action": 9,
"enable": true,
"expiration_period": 10,
"forward_to": {
"display_name": "test extension name",
"extension_id": "CcrEGgmeQem1uyJsuIRKwA",
"extension_number": -51216469,
"extension_type": "user",
"id": "fWOgOALdT1ei4vjXK-QYsA"
},
"locked": true,
"locked_by": "account"
},
"call_transferring": {
"call_transferring_type": 2,
"enable": true,
"locked": true,
"locked_by": "account"
},
"delegation": true,
"elevate_to_meeting": true,
"emergency_address_management": {
"enable": true,
"prompt_default_address": true
},
"emergency_calls_to_psap": true,
"forwarding_to_external_numbers": true,
"hand_off_to_room": {
"enable": true,
"locked": true,
"locked_by": "account"
},
"international_calling": true,
"mobile_switch_to_carrier": {
"enable": true,
"locked": true,
"locked_by": "account"
},
"select_outbound_caller_id": {
"enable": true,
"locked": true,
"locked_by": "account"
},
"sms": {
"enable": true,
"international_sms": true,
"international_sms_countries": [
"US",
"US"
],
"locked": true,
"locked_by": "account"
},
"voicemail": {
"allow_delete": true,
"allow_download": true,
"allow_transcription": true,
"allow_videomail": true,
"enable": true
},
"voicemail_access_members": [
{
"access_user_id": "w0RChiauQeqRlv5fgxYULQ",
"allow_delete": true,
"allow_download": true
}
],
"zoom_phone_on_mobile": {
"allow_calling_sms_mms": true,
"enable": true,
"locked": true,
"locked_by": "account"
},
"personal_audio_library": {
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true,
"allow_music_on_hold_customization": true,
"allow_voicemail_and_message_greeting_customization": true
},
"voicemail_transcription": {
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true
},
"voicemail_notification_by_email": {
"include_voicemail_file": true,
"include_voicemail_transcription": false,
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true
},
"shared_voicemail_notification_by_email": {
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true
},
"check_voicemails_over_phone": {
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true
},
"audio_intercom": {
"enable": true,
"locked": true,
"locked_by": "account",
"modified": true
}
},
"site_admin": true,
"site_id": "8f71O6rWT8KFUGQmJIFAdQ",
"status": "activate"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/users/:userId' -H 'Accept: application/json'
ENDPOINTS