Zoom Public API Documentation
Get a user's profile
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:readphone:read:user,phone:read:user:adminLIGHT
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_delet Curl curl -X GET 'https://api.zoom.us/v2/phone/users/:userId' -H 'Accept: application/json' ENDPOINTS |