openapi: 3.2.0
info:
title: Phone Call Logs API
description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
contact:
name: Zoom Developers
url: https://developer.zoom.us/
version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Call Logs
paths:
/phone/call_element/{callElementId}:
get:
tags:
- Call Logs
summary: Get call element
description: "Returns the call element for a given call element ID.\n \n **Prerequisites** \n * A Business or Enterprise account \n * A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read`,`phone_call_log:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getCallElement
parameters:
- name: callElementId
in: path
description: The ID of the call element.
required: true
schema:
type: string
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
responses:
'200':
description: '**HTTP Status code:** `200`
Call element returned.'
content:
application/json:
schema:
type: object
properties:
call_element_id:
type: string
description: The ID of the call element.
example: 20211008-fe9c3900-5187-4254-9359-590afbc40bc9
call_history_uuid:
type: string
description: The call history ID of the call.
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The caller' name.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The caller's extension number .
example: '101229'
caller_ext_type:
type: string
description: "The caller's extension type: \n* `user` \n* `call_queue` \n* `auto_receptionist` \n* `common_area` \n* `zoom_room` \n* `cisco_room` \n* `shared_line_group` \n* `group_call_pickup` \n* `external_contact`."
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The callee's name.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The callee's extension number.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: "The callee's extension type: \n* `user` \n* `call_queue` \n* `auto_receptionist` \n* `common_area` \n* `zoom_room` \n* `cisco_room` \n* `shared_line_group` \n* `group_call_pickup` \n* `external_contact`."
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
client_code:
type: string
description: The client code for the call.
example: '1234'
department:
type: string
description: The name of the user's department.
example: web-api1
cost_center:
type: string
description: The name of the cost center of which the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group of which the user belongs.
example: California
site_name:
type: string
description: The site name of which the user belongs.
example: site name
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detailed results of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The cause or outcome of an event in a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
device_private_ip:
type: string
description: The private IP of which the user belongs.
example: ''
device_public_ip:
type: string
description: The public IP of which the user belongs.
example: ''
operator_ext_number:
type: string
description: The operator's extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator's extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
press_key:
type: string
description: The key value associated with a press or input event.
example: '3'
segment:
type: integer
description: A sequential number to indicate the orders of events that starts from 0.
example: 0
node:
type: integer
description: Within one segment, a sequential number to indicate the orders of the events that start from 0.
example: 0
is_node:
type: integer
description: This indicates whether it is a node or not.
example: 0
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
waiting_time:
type: integer
description: The call wait time in seconds.
example: 20
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
description: The phone extension call element.
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n "
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone_call_log:read
- phone_call_log:read:admin
- phone:read
- phone:read:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone_call_log:read
- phone_call_log:read:admin
- phone:read
x-granular-scopes:
- phone:read:call_log:admin
/phone/call_history:
get:
tags:
- Call Logs
summary: Get account's call history
description: "Returns an account's new edition of [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`"
operationId: accountCallHistory
parameters:
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: from
in: query
description: "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
required: false
schema:
type: string
format: date
example: '2020-10-31'
- name: to
in: query
description: "**Required** only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
required: false
schema:
type: string
format: date
example: '2021-12-31'
- name: next_page_token
in: query
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: keyword
in: query
description: The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword.
required: false
schema:
type: string
example: User 1
- name: directions
in: query
description: The direction filter of the call logs.
required: false
schema:
type: array
example: []
items:
type: string
example: inbound
enum:
- inbound
- outbound
- name: connect_types
in: query
description: "The connect type filter of the call logs. \n* `internal` \n* `external` "
required: false
schema:
type: array
example: []
items:
type: string
example: internal
enum:
- internal
- external
- name: number_types
in: query
description: 'The number type filter of the caller or callee. '
required: false
schema:
type: array
example: []
items:
type: string
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
- name: call_types
in: query
description: "The call type filter of the call logs. \n* `general` \n* `emergency`"
required: false
schema:
type: array
example: []
items:
type: string
example: general
enum:
- general
- emergency
- name: extension_types
in: query
description: The extension type filter of the call logs.
required: false
schema:
type: array
example: []
items:
type: string
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
- name: call_results
in: query
description: The call result filter of the call logs.
required: false
schema:
type: array
example: []
items:
type: string
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
- name: group_ids
in: query
description: The primary group filter of call logs.
required: false
schema:
type: array
example: []
items:
type: string
example: b4Uge6AxQQWlAepTCbFeKQ
- name: site_ids
in: query
description: The site filter of call logs.
required: false
schema:
type: array
example: []
items:
type: string
example: 8f71O6rWT8KFUGQmJIFAdQ
- name: department
in: query
description: The department where the call log belongs.
required: false
schema:
type: string
example: Phone department
- name: cost_center
in: query
description: The cost center where the call log belongs.
required: false
schema:
type: string
example: Phone cost center
- name: time_type
in: query
description: This field enables you to search call logs by start or end time. By default, using start_time
required: false
schema:
type: string
example: start_time
default: start_time
enum:
- start_time
- end_time
- name: recording_status
in: query
description: The recording filter indicates whether the whole call has recording or not. Recorded means the call has at least one recording. `non_recorded` means the call does not have any recordings.
required: false
schema:
type: string
example: recorded
default: recorded
enum:
- recorded
- non_recorded
- name: with_voicemail
in: query
description: The voicemail filter of the call logs.
required: false
schema:
type: boolean
example: true
- name: call_ids
in: query
description: The call ID to filter the call logs.
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: '**HTTP Status Code:** `200`
Account''s call logs returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
type: array
description: The call log.
deprecated: true
items:
type: object
properties:
id:
type: string
description: The ID of the call log summary, get call path with this summary ID.
example: 20211001-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The unique identifier of the phone call. One call id might contain multiple call log ID.
example: '7018317023722949162'
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
international:
type: boolean
description: A flag to indicate the call is international or not.
example: false
enum:
- true
- false
start_time:
type: string
description: The call start time in GMT date-time format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT date-time format.
example: '2021-10-08T16:12:10Z'
end_time:
type: string
description: The call end time in GMT date-time format.
example: '2021-10-08T16:12:15Z'
duration:
type: integer
description: The duration of the call in seconds.
example: 20
connect_type:
type: string
description: The connect type of the call logs.
example: internal
enum:
- internal
- external
sbc_id:
type: string
description: The SBC ID that the call goes through.
example: '20'
sbc_name:
type: string
description: The SBC name that the call goes through.
example: '20'
sip_group_id:
type: string
description: The SIP group ID that the call goes through.
example: '20'
sip_group_name:
type: string
description: The SIP group name that the call goes through.
example: '20'
call_type:
type: string
description: 'The type of call. '
example: general
enum:
- general
- emergency
call_result:
type: string
description: 'The final call result of the call logs. '
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The caller's extension number.
example: '101229'
caller_name:
type: string
description: The caller's name.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: US
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The callee's extension number.
example: '101229'
callee_name:
type: string
description: The callee's name.
example: Callee name
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: US
department:
type: string
description: The name of the department where the user belongs.
example: web-api1
cost_center:
type: string
description: The name of the cost center where the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group where the user belongs.
example: California
site_name:
type: string
description: The name of the site name where the user belongs.
example: site name
spam:
type: string
description: The spam type of the call.
example: Maybe Spam
recording_status:
type: string
description: The recording status indicates whether the call has recording or not. Recorded means the call has at least one recording. Non_recorded means the call does not have any recordings.
example: recorded
enum:
- recorded
- non_recorded
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
call_history:
type: array
description: The call history.
items:
type: object
properties:
call_history_uuid:
type: string
description: The call history ID of the call. Use this ID to retrieve the call history.
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The unique identifier of the phone call. One call id might contain multiple call log ID.
example: '7018317023722949162'
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
international:
type: boolean
description: A flag to indicate the call is international or not.
example: false
enum:
- true
- false
start_time:
type: string
description: The call start time in GMT date-time format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT date-time format.
example: '2021-10-08T16:12:10Z'
end_time:
type: string
description: The call end time in GMT date-time format.
example: '2021-10-08T16:12:15Z'
duration:
type: integer
description: The duration of the call in seconds.
example: 20
connect_type:
type: string
description: The connect type of the call logs.
example: internal
enum:
- internal
- external
sbc_id:
type: string
description: The SBC ID that the call goes through.
example: '20'
sbc_name:
type: string
description: The SBC name that the call goes through.
example: '20'
sip_group_id:
type: string
description: The SIP group ID that the call goes through.
example: '20'
sip_group_name:
type: string
description: The SIP group name that the call goes through.
example: '20'
call_type:
type: string
description: 'The type of call. '
example: general
enum:
- general
- emergency
call_result:
type: string
description: 'The final call result of the call logs. '
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The caller's extension number.
example: '101229'
caller_name:
type: string
description: The caller's name.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: US
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The callee's extension number.
example: '101229'
callee_name:
type: string
description: The callee's name.
example: Callee name
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: US
department:
type: string
description: The name of the department where the user belongs.
example: web-api1
cost_center:
type: string
description: The name of the cost center where the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group where the user belongs.
example: California
site_name:
type: string
description: The name of the site name where the user belongs.
example: site name
spam:
type: string
description: The spam type of the call.
example: Maybe Spam
recording_status:
type: string
description: The recording status indicates whether the call has recording or not. Recorded means the call has at least one recording. Non_recorded means the call does not have any recordings.
example: recorded
enum:
- recorded
- non_recorded
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
from:
type: string
description: The start time and date of the log.
example: '2021-10-01'
to:
type: string
description: The end time and date of the log.
example: '2021-10-12'
page_count:
type: integer
description: The total number of pages.
example: 2
page_size:
type: integer
description: The number of records returned within a single API call for each page.
example: 30
total_records:
type: integer
description: The total number of records returned.
example: 54
next_page_token:
type: string
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone_call_log:read:admin
- phone:read:list_call_logs:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone_call_log:read:admin
x-granular-scopes:
- phone:read:list_call_logs:admin
/phone/call_history/{callHistoryUuid}:
get:
tags:
- Call Logs
summary: Get call history
description: "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getCallPath
parameters:
- name: callHistoryUuid
in: path
description: The ID of the call history.
required: true
schema:
type: string
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
responses:
'200':
description: The details of the call history.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the call log summary.
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_history_uuid:
type: string
description: The call history ID of the call.
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
international:
type: boolean
description: A flag to indicate the call is international or not.
example: false
enum:
- true
- false
hide_caller_id:
type: boolean
description: A flag to indicate the call is a hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is an end-to-end encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
department:
type: string
description: The name of the department of which the user belongs.
example: web-api1
cost_center:
type: string
description: The name of the cost center of which the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group of which the user belongs.
example: California
site_name:
type: string
description: The name of the site name of which the user belongs.
example: site name
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:15Z'
call_path:
type: array
description: The call segment path.
items:
type: object
properties:
id:
type: string
description: The ID of the call log.
example: 48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: US
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: US
client_code:
type: string
description: The client code for the call.
example: '1234'
department:
type: string
description: The name of the department of which the user belongs.
example: web-api1
cost_center:
type: string
description: The name of the cost center of which the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group of which the user belongs.
example: California
site_name:
type: string
description: The name of the site name of which the user belongs.
example: site name
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
device_private_ip:
type: string
description: The private IP of which the user belongs.
example: ''
device_public_ip:
type: string
description: The public IP of which the user belongs
example: ''
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
press_key:
type: string
description: The press key value for event press or input.
example: '3'
segment:
type: integer
description: A sequential number to indicate the orders of events that starts from 0.
example: 0
node:
type: integer
description: Within one segment, a sequential number to indicate the orders of the events that starts from 0.
example: 0
is_node:
type: integer
example: 0
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- automatic
- ad-hoc
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
waiting_time:
type: integer
description: The call wait time in seconds.
example: 20
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
caller_acconut_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
call_elements:
type: array
description: The call elements.
items:
type: object
properties:
call_element_id:
type: string
description: The ID of the call element.
example: 48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: US
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: US
client_code:
type: string
description: The client code for the call.
example: '1234'
department:
type: string
description: The name of the department of which the user belongs.
example: web-api1
cost_center:
type: string
description: The name of the cost center of which the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group of which the user belongs.
example: California
site_name:
type: string
description: The name of the site name of which the user belongs.
example: site name
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
device_private_ip:
type: string
description: The private IP of which the user belongs.
example: ''
device_public_ip:
type: string
description: The public IP of which the user belongs
example: ''
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
press_key:
type: string
description: The press key value for event press or input.
example: '3'
segment:
type: integer
description: A sequential number to indicate the orders of events that starts from 0.
example: 0
node:
type: integer
description: Within one segment, a sequential number to indicate the orders of the events that starts from 0.
example: 0
is_node:
type: integer
description: This indicates whether it is a node or not.
example: 0
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- automatic
- ad-hoc
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
waiting_time:
type: integer
description: The call wait time in seconds.
example: 20
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n "
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone_call_log:read:admin
- phone:read:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone_call_log:read:admin
x-granular-scopes:
- phone:read:call_log:admin
/phone/call_history/{callLogId}/client_code:
patch:
tags:
- Call Logs
summary: Add a client code to a call history
description: "Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. \n\n**Prerequisites**\n* Business or Education account\n* Zoom Phone license \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: addClientCodeToCallHistory
parameters:
- name: callLogId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- client_code
type: object
properties:
client_code:
type: string
description: The client code (3 to 16 digit number) to mark the call log.
example: The client code (3 to 16 digit number) to mark the call log.
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**Successfully added the client code to the call log.'
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `301`
\n Invalid client code: {client_code}
\n**Error Code:** `302`
\n Client code cannot be added to admin call log
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n Call history not found: {callLogId}
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_log:admin
/phone/call_history_detail/{callHistoryId}:
get:
tags:
- Call Logs
summary: Get call history detail
description: " Returns the call history details for a given call log ID [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). \n \n **Prerequisites** \n * A Business or Enterprise account \n * A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read`,`phone_call_log:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getCallHistoryDetail
parameters:
- name: callHistoryId
in: path
description: The ID of call history.
required: true
schema:
type: string
example: 20211008-fe9c3900-5187-4254-9359-590afbc40bc9
responses:
'200':
description: '**HTTP Status code:** `200`
Call history detail returned.'
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the call history.
example: 20211008-fe9c3900-5187-4254-9359-590afbc40bc9
call_path_id:
type: string
description: The call path ID of the call.
example: 20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The caller' name.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The caller's extension number .
example: '101229'
caller_ext_type:
type: string
description: "The caller's extension type: \n* `user` \n* `call_queue` \n* `auto_receptionist` \n* `common_area` \n* `zoom_room` \n* `cisco_room` \n* `shared_line_group` \n* `group_call_pickup` \n* `external_contact`."
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The callee's name.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The callee's extension number.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_ext_type:
type: string
description: "The callee's extension type: \n* `user` \n* `call_queue` \n* `auto_receptionist` \n* `common_area` \n* `zoom_room` \n* `cisco_room` \n* `shared_line_group` \n* `group_call_pickup` \n* `external_contact`."
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zra_phone_number
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
client_code:
type: string
description: The client code for the call.
example: '1234'
department:
type: string
description: The name of the user's department.
example: web-api1
cost_center:
type: string
description: The name of the cost center of which the user belongs.
example: cost-center1
site_id:
type: string
description: The name of the site ID of which the user belongs.
example: BpCTBMRARBefUrprildVqw
group_id:
type: string
description: The primary group of which the user belongs.
example: California
site_name:
type: string
description: The site name of which the user belongs.
example: site name
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detailed results of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The cause or outcome of an event in a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
device_private_ip:
type: string
description: The private IP of which the user belongs.
example: ''
device_public_ip:
type: string
description: The public IP of which the user belongs.
example: ''
operator_ext_number:
type: string
description: The operator's extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator's extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
press_key:
type: string
description: The key value associated with a press or input event.
example: '3'
segment:
type: integer
description: A sequential number to indicate the orders of events that starts from 0.
example: 0
node:
type: integer
description: Within one segment, a sequential number to indicate the orders of the events that start from 0.
example: 0
is_node:
type: integer
example: 0
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
waiting_time:
type: integer
description: The call wait time in seconds.
example: 20
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
description: The phone extension call history.
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `301`
\n Call history does not exist for call log Id: {callLogId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone_call_log:read
- phone_call_log:read:admin
- phone:read
- phone:read:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone_call_log:read
- phone_call_log:read:admin
- phone:read
x-granular-scopes:
- phone:read:call_log:admin
/phone/call_logs:
get:
tags:
- Call Logs
summary: Get account's call logs
description: "Returns an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license \n* Account owner or a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`"
operationId: accountCallLogs
parameters:
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: from
in: query
description: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.
required: false
schema:
type: string
format: date
example: '2020-10-31'
- name: to
in: query
description: '**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd''T''HH:mm:ss''Z''** format, the same format as the `from` parameter.'
required: false
schema:
type: string
format: date
example: '2021-12-31'
- name: type
in: query
description: The type of the call logs. The value can be either "all" or "missed".
required: false
schema:
type: string
example: all
- name: next_page_token
in: query
description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: path
in: query
description: 'This field filters the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`,
`pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`,
`parkTimeout`, `monitor`, `takeover`, `sipGroup`'
required: false
schema:
type: string
example: extension
- name: time_type
in: query
description: This field enables you to search call logs by start or end time. You can choose `startTime` or `endTime`.
required: false
schema:
type: string
example: startTime
default: startTime
enum:
- startTime
- endTime
- name: site_id
in: query
description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
required: false
schema:
type: string
example: 8f71O6rWT8KFUGQmJIFAdQ
- name: charged_call_logs
in: query
description: Whether to filter API responses to include call logs that only have a non-zero charge.
required: false
schema:
type: boolean
example: false
responses:
'200':
description: '**HTTP Status Code:** `200`
Account''s call logs returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
maxItems: 300
type: array
description: Call Log
items:
type: object
properties:
answer_start_time:
type: string
description: "The GMT date and time at which the inbound call was answered. The value of this field is in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.\n\t\t"
format: date-time
example: '2021-10-12T16:00:08Z'
call_end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
call_id:
type: string
description: The unique identifier of the phone call.
example: '7018210229361148737'
call_type:
type: string
description: 'The type of call:
* `voip` (Voice over IP)
* `pstn` (Public Switched Telephone Network)
* `tollfree`
* `international`
* `contactCenter`'
example: voip
enum:
- voip
- pstn
- tollfree
- international
- contactCenter
callee_country_code:
type: string
description: The country calling code.
example: '1'
callee_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
callee_did_number:
type: string
description: The callee's DID (direct inward dial) number in e164 format.
example: '+12055432724'
callee_name:
type: string
description: The contact name of the callee.
example: Callee name
callee_number:
type: string
description: The number of the callee.
example: '1001'
callee_number_type:
type: integer
description: 'The callee''s number type:
* `1` — Extension number.
* `2` — Phone number.
* `3` — Customized emergency number.'
example: 1
enum:
- 1
- 2
- 3
callee_number_source:
type: string
description: 'Ths field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `callee_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_country_code:
type: string
description: The country calling code.
example: '1'
caller_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
caller_did_number:
type: string
description: The caller's DID (direct inward dial) number in e164 format.
example: '+12055432724'
caller_name:
type: string
description: The contact name of the caller.
example: Caller name
caller_number:
type: string
description: The number of the caller.
example: '+12059300920'
caller_number_type:
type: integer
description: "The caller's number type: \n* `1` — Extension number. \n* `2` — Phone number."
example: 1
enum:
- 1
- 2
caller_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `caller_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_billing_reference_id:
type: string
description: The billing reference ID (for peering phone numbers).
example: ZoomTelecom123456
charge:
type: string
description: The billing charge for the call.
example: $0.0255
client_code:
type: string
description: Client code.
example: '123'
date_time:
type: string
description: Start time of the call
example: '2021-10-08T16:23:34Z'
device_private_ip:
type: string
description: Display the device's private IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '12'
device_public_ip:
type: string
description: Display the device's public IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '23'
direction:
type: string
description: Direction of the call. "inbound" | "outbound"
example: inbound
duration:
type: integer
description: Duration of the billing call in seconds.
example: 25
id:
type: string
description: Call Log ID
example: 48c1dfd4-91ce-4df5-8495-7c9e33d10869
owner:
type: object
properties:
extension_number:
type: integer
description: The owner's extension number.
format: int64
example: 1000001019
id:
type: string
description: The owner ID.
example: N3hAhug-QVyFPYZJrHpRaQ
name:
type: string
description: The owner name.
example: 123@test.com
type:
type: string
description: 'The owner type:
*`user`
*`callQueue`
*`autoReceptionist`
*`commonArea`
*`sharedLineGroup`'
example: user
enum:
- user
- callQueue
- autoReceptionist
- commonArea
- sharedLineGroup
path:
type: string
description: 'Path of the call. '
example: pstn
rate:
type: string
description: Billing rate for the call.
example: '0.0255'
recording_id:
type: string
description: Unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: 'Type of call recording:
`1` OnDemand
`2` Automatic'
example: OnDemand
enum:
- OnDemand
- Automatic
result:
type: string
description: 'Result of the call: `Missed` | `Voicemail` | `Call connected` | `Rejected` | `Blocked`| `Busy`| `Wrong Number`| `No Answer`| `International Disabled`| `Internal Error`| `Call failed` | `Restricted Number`| `Call Cancel` | `Message`| `Answered by Other Member` | `Call Cancelled` | `Park` | `Parked` | `Blocked by non-GAL` | `Blocked by info-Barriers` | `Recording Failure`| `Recorded`| `Auto Recorded`.'
example: Call connected
site:
type: object
properties:
id:
type: string
description: Target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) in which the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, you sites could be created based on different office locations.
example: 8f71O6rWT8KFUGQmJIFAdQ
name:
type: string
description: Name of the site where the phone number is assigned.
example: Main Site
user_id:
type: string
description: User ID of the call log owner.
example: IqoQmDRqS-aIoXqV_FZ88w
hold_time:
type: integer
description: Hold time during a call in seconds.
example: 5
waiting_time:
type: integer
description: "Duration that a **call queue member** takes to answer a call from the time it started ringing. The value of the duration is in seconds.\n\t\t\t"
example: 5
department:
type: string
description: Name of the user's department.
example: web-api1
cost_center:
type: string
description: The cost center name to which a user belongs.
example: cost-center1
from:
type: string
description: Start time and date of the log.
example: '2021-10-01'
next_page_token:
type: string
description: The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
page_count:
type: integer
description: Total number of pages
example: 2
page_size:
type: integer
description: The number of records returned within a single API call for each page.
example: 30
to:
type: string
description: End time and date of the log
example: '2021-10-12'
total_records:
type: integer
description: The total number of records returned.
example: 54
description: Account Call Logs
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n "
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `3001`
\n Error retrieving call logs.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:read:admin
- phone_call_log:read:admin
- phone:read:list_call_logs:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone_call_log:read:admin
x-granular-scopes:
- phone:read:list_call_logs:admin
/phone/call_logs/{callLogId}:
get:
tags:
- Call Logs
summary: Get call log details
description: "Returns information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read:admin`,`phone:read`,`phone_call_log:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: getCallLogDetails
parameters:
- name: callLogId
in: path
description: The unique identifier of the call log. Both `callLogId` and `callId` can be used as path parameters. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or the [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs).
required: true
schema:
type: string
example: a55d94f7-27ea-4dbb-ab25-028f2c8d55bd
responses:
'200':
description: The details of the call log.
content:
application/json:
schema:
type: object
properties:
call_id:
type: string
description: The unique identifier of the phone call.
example: '7018317023722949162'
call_type:
type: string
description: 'The type of call:
* `voip` (Voice over IP)
* `pstn` (Public Switched Telephone Network)
* `tollfree`
* `international`
* `contactCenter`'
example: voip
enum:
- voip
- pstn
- tollfree
- international
- contactCenter
callee_country_code:
type: string
description: The country calling code.
example: '1'
callee_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
callee_did_number:
type: string
description: The callee's DID (direct inward dial) number in e164 format.
example: '+12055432724'
callee_name:
type: string
description: The contact name of callee.
example: Callee name
callee_number:
type: string
description: The number of callee.
example: '1018'
callee_number_type:
type: integer
description: 'The callee''s number type:
* `1` — Extension number.
* `2` — Phone number.
* `3` — Customized emergency number.'
example: 1
enum:
- 1
- 2
- 3
callee_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `callee_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
callee_status:
type: string
description: "This field indicates the status of extension. \n* `inactive` \n* `deleted`"
example: deleted
enum:
- inactive
- deleted
callee_deleted_time:
type: string
description: The datetime the extension was deleted. It exists only when `extension_status` is `deleted`.
example: '2022-10-14T22:10:54Z'
caller_country_code:
type: string
description: The country calling code.
example: '1'
caller_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
caller_did_number:
type: string
description: The caller's DID (direct inward dial) number in e164 format.
example: '+12055432724'
caller_name:
type: string
description: The contact name of caller.
example: Caller name
caller_number:
type: string
description: The number of the caller.
example: '+16622001852'
caller_number_type:
type: integer
description: "The caller's number type: \n* `1` — Extension number. \n* `2` — Phone number."
example: 1
enum:
- 1
- 2
caller_number_source:
type: string
description: 'This field Iindicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `caller_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_billing_reference_id:
type: string
description: The billing reference ID (for peering phone numbers).
example: ZoomTelecom123456
caller_status:
type: string
description: "This field indicates the status of extension. \n* `inactive` \n* `deleted`"
example: deleted
enum:
- inactive
- deleted
caller_deleted_time:
type: string
description: The datetime the extension was deleted. Exists only when extension_status is `deleted`.
example: '2022-10-14T22:10:54Z'
date_time:
type: string
description: The start time of the call.
example: '2021-10-12T22:54:31Z'
device_private_ip:
type: string
description: This field displays the device's private IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '12'
device_public_ip:
type: string
description: This field displays the device's public IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '23'
direction:
type: string
description: 'The direction of the call: `inbound` | `outbound`'
example: inbound
enum:
- inbound
- outbound
duration:
type: integer
description: The duration of the call in seconds.
example: 20
has_recording:
type: boolean
description: Whether the call has a recording. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021.
example: false
deprecated: true
has_voicemail:
type: boolean
description: Whether the call has a voicemail. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021.
example: false
deprecated: true
id:
type: string
description: The call log ID.
example: a55d94f7-27ea-4dbb-ab25-028f2c8d55bd
log_details:
maxItems: 10000
type: array
description: The call segment details.
items:
type: object
properties:
date_time:
type: string
description: The start time of the call.
example: '2021-10-12T22:54:31Z'
hold_time:
type: integer
description: The hold time during a call in seconds.
example: 5
device_private_ip:
type: string
description: This field displays the device's private IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '12'
device_public_ip:
type: string
description: This field displays the device's public IP address if the account has the `show_device_ip_for_call_log` parameter set to `enabled`.
example: '23'
duration:
type: integer
description: The duration of the call in seconds.
example: 20
forward_to:
type: object
properties:
extension_number:
type: string
description: The call forward's extension number.
example: '1002'
id:
type: string
description: The call forward's unique ID.
example: 1234abcd
name:
type: string
description: The call forward's name.
example: name
type:
type: string
description: "The call forwarding recipient type: \n* `user` \n* `callQueue` \n* `autoReceptionist` \n* `sharedLineGroup`"
example: user
enum:
- user
- callQueue
- autoReceptionist
- sharedLineGroup
extension_status:
type: string
description: "This field indicates the status of extension. \n* `inactive` \n* `deleted`"
example: deleted
enum:
- inactive
- deleted
extension_deleted_time:
type: string
description: The datetime the extension was deleted. Exists only when extension_status is `deleted`.
example: '2022-10-14T22:10:54Z'
description: The information about the call's forwarding.
id:
type: string
description: The call log ID.
example: a55d94f7-27ea-4dbb-ab25-028f2c8d55bd
path:
type: string
description: The path of the call.
example: callQueue
result:
type: string
description: 'The result of the call: `Missed` | `Voicemail`| `Call connected`|`Rejected`| `Blocked`| `Busy`|`Wrong Number`| `No Answer`| `International Disabled`|`Internal Error`| `Call failed`| `Restricted Number`|`Call Cancel`| `Message`| `Answered by Other Member`|`Call Cancelled`| `Park`| `Parked`| `Blocked by non-GAL`| `Blocked by info-Barriers`|`Recording Failure`| `Recorded`| `Auto Recorded`.'
example: Call connected
site:
type: object
properties:
id:
type: string
description: The target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) where the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, you can create sites based on different office locations.
example: 8f71O6rWT8KFUGQmJIFAdQ
name:
type: string
description: The name of the site where the phone number is assigned.
example: Main Site
path:
type: string
description: The path of the call.
example: callQueue
result:
type: string
description: 'The result of the call: `Missed` | `Voicemail` | `Call connected` | `Rejected` | `Blocked`| `Busy`| `Wrong Number`| `No Answer`| `International Disabled`| `Internal Error`| `Call failed` | `Restricted Number`| `Call Cancel` | `Message`| `Answered by Other Member` | `Call Cancelled` | `Park` | `Parked` | `Blocked by non-GAL` | `Blocked by info-Barriers` | `Recording Failure`| `Recorded`| `Auto Recorded`.'
example: Call connected
department:
type: string
description: The name of the user's department.
example: web-api1
cost_center:
type: string
description: The cost center name to which a user belongs.
example: cost-center1
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n "
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:read:admin
- phone_call_log:read:admin
- phone:read
- phone_call_log:read
- phone:read:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone_call_log:read:admin
- phone:read
- phone_call_log:read
x-granular-scopes:
- phone:read:call_log:admin
/phone/call_logs/{callLogId}/client_code:
put:
tags:
- Call Logs
summary: Add a client code to a call log
description: "Adds a client code to a [call log](https://support.zoom.us/hc/en-us/articles/360040999352-Assigning-client-codes-to-phone-calls). You can track call logs with a client code. \n\n**Prerequisites:**\n* Business or Education account\n* Zoom Phone license \n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: addClientCodeToCallLog
parameters:
- name: callLogId
in: path
description: The unique identifier of the call log.
required: true
schema:
type: string
example: a55d94f7-27ea-4dbb-ab25-028f2c8d55bd
requestBody:
content:
application/json:
schema:
required:
- client_code
type: object
properties:
client_code:
type: string
description: The client code (3 to 16 digit number) to mark the call log.
example: '123'
responses:
'204':
description: '**HTTP Status Code:** `204` **No Content**
Successfully added the client code to the call log.'
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Validation Failed.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:write:admin
- phone:update:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write:admin
x-granular-scopes:
- phone:update:call_log:admin
/phone/user/{userId}/ai_call_summary/{aiCallSummaryId}:
get:
tags:
- Call Logs
summary: Get User AI Call Summary Detail
description: "Returns AI call summary details. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:ai_call_summary`,`phone:read:ai_call_summary:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
operationId: getUserAICallSummary
parameters:
- name: userId
in: path
description: The owner's user ID.
required: true
schema:
type: string
example: 8XQfveqPRB2TfEIa4SygEA
- name: aiCallSummaryId
in: path
description: The ID of the AI call summary.
required: true
schema:
type: string
example: DcmBZMsTSuOVTorcxJzeFg
responses:
'200':
description: '**HTTP Status code:** `200`User AI call summary returned.'
content:
application/json:
schema:
type: object
properties:
ai_call_summary_id:
type: string
description: The ID of the AI call summary.
example: HfBQmSIARZi5zeDMmofwTA
account_id:
type: string
description: The ID of the account.
example: A88lsb7WQ46FwTeNe8jsMw
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
user_id:
type: string
description: The owner's user ID.
example: x2ci3VDeQEqJsuHkn5oRzg
call_summary_rate:
type: string
description: The call summary rate.
example: thumb_up
enum:
- thumb_up
- thumb_down
transcript_language:
type: string
description: The transcription language ID.
example: en
call_summary:
type: string
description: The recap of the call summary.
example: Tom discussed his personal beliefs and values, including his support for certain political figures and his advocacy for various social causes.
next_steps:
type: string
description: The next step in the call summary.
example: Tom will provide PPT next Tuesday.
detailed_summary:
type: string
description: The detailed version of the call summary.
example: Tom discussed ...
created_time:
type: string
description: The created time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
modified_time:
type: string
description: The modified time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
edited:
type: boolean
description: The flag indicates if the call summary is modified.
example: true
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Validation Failed
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n "
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read
- phone:read:ai_call_summary
- phone:read:ai_call_summary:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone:read
x-granular-scopes:
- phone:read:ai_call_summary
- phone:read:ai_call_summary:admin
/phone/users/{userId}/call_history:
get:
tags:
- Call Logs
summary: Get user's call history
description: "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_call_log:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs:admin`,`phone:read:list_call_logs`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
operationId: phoneUserCallHistory
parameters:
- name: userId
in: path
description: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
required: true
schema:
type: string
example: DYHrdpjrS3uaOf7dPkkg8w
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: from
in: query
description: "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours."
required: false
schema:
type: string
format: date
example: '2023-10-01'
- name: to
in: query
description: "**Required** only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter."
required: false
schema:
type: string
format: date
example: '2023-10-12'
- name: next_page_token
in: query
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: keyword
in: query
description: The keyword of the name, extension, number, email address, and call ID. It provides the ability to search by keyword and it shows a list of all the related calls. Any calls go through this keyword.
required: false
schema:
type: string
example: User 1
- name: directions
in: query
description: The direction filter of the call logs.
required: false
schema:
maxItems: 2
type: array
example: []
items:
type: string
example: inbound
enum:
- inbound
- outbound
- name: connect_types
in: query
description: "The connect type filter of the call logs. \n* `internal` \n* `external` "
required: false
schema:
maxItems: 2
type: array
example: []
items:
type: string
example: internal
enum:
- internal
- external
- name: number_types
in: query
description: 'The number type filter of the caller or callee. '
required: false
schema:
maxItems: 10
type: array
example: []
items:
type: string
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
- name: call_types
in: query
description: "The call type filter of the call logs. \n* `general` \n* `emergency`"
required: false
schema:
maxItems: 2
type: array
example: []
items:
type: string
example: general
enum:
- general
- emergency
- name: extension_types
in: query
description: The extension type filter of the call logs.
required: false
schema:
maxItems: 10
type: array
example: []
items:
type: string
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
- name: call_results
in: query
description: The call result filter of the call logs.
required: false
schema:
maxItems: 10
type: array
example: []
items:
type: string
example: answered
enum:
- answered
- connected
- voicemail
- hang_up
- no_answer
- invalid_operation
- abandoned
- blocked
- service_unavailable
- name: group_ids
in: query
description: The primary group filter of call logs.
required: false
schema:
maxItems: 10
type: array
example: []
items:
type: string
example: b4Uge6AxQQWlAepTCbFeKQ
- name: site_ids
in: query
description: The site filter of call logs.
required: false
schema:
maxItems: 10
type: array
example: []
items:
type: string
example: 8f71O6rWT8KFUGQmJIFAdQ
- name: department
in: query
description: The department of which the call log belongs.
required: false
schema:
type: string
example: Phone department
- name: cost_center
in: query
description: The cost center of which the call log belongs.
required: false
schema:
type: string
example: Phone cost center
- name: time_type
in: query
description: This field enables you to search call logs by start or end time. By default, using start_time
required: false
schema:
type: string
example: start_time
default: start_time
enum:
- start_time
- end_time
- name: recording_status
in: query
description: The recording filter indicates whether the whole call has recording or not. recorded means the call has at least one recording, non_recorded means the call does not have any recordings.
required: false
schema:
type: string
example: recorded
default: ''
enum:
- recorded
- non_recorded
- name: with_voicemail
in: query
description: The voicemail filter of the call logs.
required: false
schema:
type: boolean
example: true
responses:
'200':
description: '**HTTP Status Code:** `200` User''s call history returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
type: array
description: The call history.
items:
type: object
properties:
id:
type: string
description: The ID of the call history.
example: 20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_path_id:
type: string
description: The call path ID of the call.
example: 20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
group_id:
type: string
description: The primary group of which the user belongs.
example: _sj190JDFasa19321_adA7
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_employee_id:
type: string
description: Ther caller's employee ID.
example: '102911'
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_private_ip:
type: string
description: The caller's private IP.
example: 10.0.0.1
caller_device_public_ip:
type: string
description: The caller's public IP.
example: 135.0.0.1
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
caller_site_id:
type: string
description: The caller's site ID.
example: BpCTBMRARBefUrprildVqw
caller_department:
type: string
description: The caller's department.
example: web-api1
caller_cost_center:
type: string
description: The caller's cost center.
example: cost-center1
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_employee_id:
type: string
description: Ther callee's employee id
example: '102912'
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_private_ip:
type: string
description: The callee's private IP.
example: 10.0.0.2
callee_device_public_ip:
type: string
description: The callee's public IP.
example: 135.0.0.2
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
callee_site_id:
type: string
description: The callee's site ID.
example: BpCTBMRARBefUrprildVqw
callee_department:
type: string
description: The callee's department.
example: web-api1
callee_cost_center:
type: string
description: The callee's cost center.
example: cost-center1
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2023-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
talk_time:
type: integer
description: The call talk time in seconds.
example: 31
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
wait_time:
type: integer
description: The call wait time in seconds.
example: 20
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
call_elements:
type: array
description: The call elements.
items:
type: object
properties:
call_element_id:
type: string
description: The ID of the call element.
example: 20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_history_uuid:
type: string
description: The ID of the call history.
example: 20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
group_id:
type: string
description: The primary group of which the user belongs.
example: _sj190JDFasa19321_adA7
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_employee_id:
type: string
description: Ther caller's employee ID.
example: '102911'
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_private_ip:
type: string
description: The caller's private IP.
example: 10.0.0.1
caller_device_public_ip:
type: string
description: The caller's public IP.
example: 135.0.0.1
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
caller_site_id:
type: string
description: The caller's site ID.
example: BpCTBMRARBefUrprildVqw
caller_department:
type: string
description: The caller's department.
example: web-api1
caller_cost_center:
type: string
description: The caller's cost center.
example: cost-center1
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_employee_id:
type: string
description: Ther callee's employee id
example: '102912'
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_private_ip:
type: string
description: The callee's private IP.
example: 10.0.0.2
callee_device_public_ip:
type: string
description: The callee's public IP.
example: 135.0.0.2
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
callee_site_id:
type: string
description: The callee's site ID.
example: BpCTBMRARBefUrprildVqw
callee_department:
type: string
description: The callee's department.
example: web-api1
callee_cost_center:
type: string
description: The callee's cost center.
example: cost-center1
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2023-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
talk_time:
type: integer
description: The call talk time in seconds.
example: 31
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
wait_time:
type: integer
description: The call wait time in seconds.
example: 20
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
from:
type: string
description: The start time and date of the log.
example: '2023-10-01'
to:
type: string
description: The end time and date of the log
example: '2023-10-12'
next_page_token:
type: string
description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
page_count:
type: integer
description: The total number of pages
example: 2
page_size:
type: integer
description: The number of records returned within a single API call for each page.
example: 30
total_records:
type: integer
description: The total number of records returned.
example: 54
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `301`
\n Invalid request param: {paramName}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n User does not exist: {userId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone_call_log:read
- phone:read:list_call_logs:admin
- phone:read:list_call_logs
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone_call_log:read
x-granular-scopes:
- phone:read:list_call_logs:admin
- phone:read:list_call_logs
/phone/users/{userId}/call_history/sync:
get:
tags:
- Call Logs
summary: Sync user's call history
description: "Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call history. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n* A Business or Enterprise account\n * A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
operationId: syncUserCallHistory
parameters:
- name: userId
in: path
required: true
schema:
type: string
- name: sync_type
in: query
description: 'The options for synchronizing call log: FSync - Full sync ISync - Increase sync BSync - Backward sync'
required: false
schema:
type: string
example: FSync
- name: count
in: query
description: The number of records returned within a single API call.
required: false
schema:
type: integer
example: 50
- name: sync_token
in: query
description: The time range for returned records. It's used for locating where the next retrieval will begin.
required: false
schema:
type: string
example: SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=
responses:
'200':
description: '**HTTP Status code:** `200`User call logs returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
type: array
items:
type: object
properties:
id:
type: string
description: The ID of the call history.
example: 20231008-321adfd4-91ce-4d15-84a5-7c9e33d10c32
call_path_id:
type: string
description: The call path ID of the call.
example: 20231008-c12adfdf-93ce-fda5-8ca1-7c5e31d1021c
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
group_id:
type: string
description: The primary group of which the user belongs.
example: _sj190JDFasa19321_adA7
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_employee_id:
type: string
description: Ther caller's employee id
example: '102911'
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_private_ip:
type: string
description: The caller's private IP.
example: 10.0.0.1
caller_device_public_ip:
type: string
description: The caller's public IP.
example: 135.0.0.1
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
caller_site_id:
type: string
description: The caller's site ID.
example: BpCTBMRARBefUrprildVqw
caller_department:
type: string
description: The caller's department.
example: web-api1
caller_cost_center:
type: string
description: The caller's cost center.
example: cost-center1
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_employee_id:
type: string
description: Ther callee's employee id
example: '102912'
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_private_ip:
type: string
description: The callee's private IP.
example: 10.0.0.2
callee_device_public_ip:
type: string
description: The callee's public IP.
example: 135.0.0.2
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
callee_site_id:
type: string
description: The callee's site ID.
example: BpCTBMRARBefUrprildVqw
callee_department:
type: string
description: The callee's department.
example: web-api1
callee_cost_center:
type: string
description: The callee's cost center.
example: cost-center1
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2023-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
talk_time:
type: integer
description: The call talk time in seconds.
example: 31
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
wait_time:
type: integer
description: The call wait time in seconds.
example: 20
ai_call_summary_id:
type: string
description: The ai call summary ID.
example: rBA9KJdyTVqGdTLpysHBsg
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
call_elements:
type: array
description: The sync user call elements.
items:
type: object
properties:
call_element_id:
type: string
description: The ID of the call element.
example: 20231008-321adfd4-91ce-4d15-84a5-7c9e33d10c32
call_history_uuid:
type: string
description: The call history ID of the call.
example: 20231008-c12adfdf-93ce-fda5-8ca1-7c5e31d1021c
call_id:
type: string
description: The ID of the phone call.
example: '7018317023722949162'
group_id:
type: string
description: The primary group of which the user belongs.
example: _sj190JDFasa19321_adA7
connect_type:
type: string
description: The connect type of call.
example: internal
enum:
- internal
- external
call_type:
type: string
description: The type of call.
example: general
enum:
- general
- emergency
direction:
type: string
description: The direction of the call.
example: inbound
enum:
- inbound
- outbound
hide_caller_id:
type: boolean
description: A flag to indicate the call is hide caller ID or not.
example: true
end_to_end:
type: boolean
description: A flag to indicate the call is end to End-to-End Encryption or not.
example: false
caller_ext_id:
type: string
description: The caller's extension ID.
example: ATu63--9TjudZetpf4UuQg
caller_name:
type: string
description: The name of the caller.
example: Caller name
caller_email:
type: string
description: The caller's email.
example: test@abc.com
caller_employee_id:
type: string
description: Ther caller's employee ID.
example: '102911'
caller_did_number:
type: string
description: The caller's DID number in e164 format.
example: '+12059300920'
caller_ext_number:
type: string
description: The extension number of the caller.
example: '101229'
caller_ext_type:
type: string
description: The caller's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
caller_number_type:
type: string
description: The caller's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
caller_device_private_ip:
type: string
description: The caller's private IP.
example: 10.0.0.1
caller_device_public_ip:
type: string
description: The caller's public IP.
example: 135.0.0.1
caller_device_type:
type: string
description: The caller's device type.
example: MAC_Client(6.0.2.33403)
caller_country_iso_code:
type: string
description: The caller's country ISO code.
example: US
caller_country_code:
type: string
description: The caller's country code.
example: '1'
caller_site_id:
type: string
description: The caller's site ID.
example: BpCTBMRARBefUrprildVqw
caller_department:
type: string
description: The caller's department.
example: web-api1
caller_cost_center:
type: string
description: The caller's cost center.
example: cost-center1
callee_ext_id:
type: string
description: The callee's extension ID.
example: ATu63--9TjudZetpf4UuQg
callee_name:
type: string
description: The name of the callee.
example: Callee name
callee_did_number:
type: string
description: The callee's DID number in e164 format.
example: '+12059300920'
callee_ext_number:
type: string
description: The extension number of the callee.
example: '101229'
callee_email:
type: string
description: The callee's email.
example: test@abc.com
callee_employee_id:
type: string
description: Ther callee's employee ID.
example: '102912'
callee_ext_type:
type: string
description: The callee's extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
callee_number_type:
type: string
description: The callee's number type.
example: external_pstn
enum:
- zoom_pstn
- zoom_toll_free_number
- external_pstn
- external_contact
- byoc
- byop
- 3rd_party_contact_center
- zoom_service_number
- external_service_number
- zoom_contact_center
- meeting_phone_number
- meeting_id
- anonymous_number
- zoom_revenue_accelerator
callee_device_private_ip:
type: string
description: The callee's private IP.
example: 10.0.0.2
callee_device_public_ip:
type: string
description: The callee's public IP.
example: 135.0.0.2
callee_device_type:
type: string
description: The callee's device type.
example: MAC_Client(6.0.2.33403)
callee_country_iso_code:
type: string
description: The callee's country ISO code.
example: US
callee_country_code:
type: string
description: The callee's country code.
example: '1'
callee_site_id:
type: string
description: The callee's site ID.
example: BpCTBMRARBefUrprildVqw
callee_department:
type: string
description: The callee's department.
example: web-api1
callee_cost_center:
type: string
description: The callee's cost center.
example: cost-center1
start_time:
type: string
description: The call start time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
answer_time:
type: string
description: The call answer time in GMT `date-time` format.
example: '2023-10-08T16:12:04Z'
end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2023-10-08T16:12:15Z'
event:
type: string
description: An event within a call log.
example: outgoing
enum:
- incoming
- transfer_from_zoom_contact_center
- shared_line_incoming
- outgoing
- call_me_on
- outgoing_to_zoom_contact_center
- warm_transfer
- forward
- ring_to_member
- overflow
- direct_transfer
- barge
- monitor
- whisper
- listen
- takeover
- conference_barge
- park
- timeout
- park_pick_up
- merge
- shared
result:
type: string
description: The detail result of an event for a call log.
example: answered
enum:
- answered
- accepted
- picked_up
- connected
- succeeded
- voicemail
- hang_up
- canceled
- call_failed
- unconnected
- rejected
- busy
- ring_timeout
- overflowed
- no_answer
- invalid_key
- invalid_operation
- abandoned
- system_blocked
- service_unavailable
result_reason:
type: string
description: The reason of result of an event for a call log.
example: answered_by_other
enum:
- answered_by_other
- pickup_by_other
- call_out_by_other
operator_ext_number:
type: string
description: The operator extension number.
example: '3456'
operator_ext_id:
type: string
description: The operator extension ID.
example: NN9rA4fZSsScB2YiCqw7Ig
operator_ext_type:
type: string
description: The operator extension type.
example: user
enum:
- user
- call_queue
- auto_receptionist
- common_area
- zoom_room
- cisco_room
- shared_line_group
- group_call_pickup
- external_contact
operator_name:
type: string
description: The operator's name.
example: operator name
recording_id:
type: string
description: The unique identifier of the call recording.
example: c71b360f6e774e3aa101453117b7e1a7
recording_type:
type: string
description: The type of call recording.
example: automatic
enum:
- ad-hoc
- automatic
voicemail_id:
type: string
description: The ID of the call voicemail.
example: 6cd2da01bcaa47f58e3250a575c5f2bf
talk_time:
type: integer
description: The call talk time in seconds.
example: 31
hold_time:
type: integer
description: The call hold time in seconds.
example: 20
wait_time:
type: integer
description: The call wait time in seconds.
example: 20
ai_call_summary_id:
type: string
description: The ai call summary ID.
example: rBA9KJdyTVqGdTLpysHBsg
caller_account_code:
type: string
description: 'The caller''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '111'
callee_account_code:
type: string
description: 'The callee''s account code. To dial between accounts, use the format: [Account code] - [extension number].'
example: '222'
sync_token:
type: string
description: The time range for returned records. Used for locating where the next retrieval will begin.
example: SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=
description: The sync user call history.
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `301`
\n Invalid request param: {paramName}.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n User does not exist: {userId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:read:admin
- phone:read
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone:read
x-granular-scopes:
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
/phone/users/{userId}/call_history/{callLogId}:
delete:
tags:
- Call Logs
summary: Delete a user's call history
description: "Deletes a user's [call history](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites** \n\n* Belong to a Business or Enterprise account \n* Have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`phone_call_log:write`,`phone_call_log:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_log`,`phone:delete:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: deleteUserCallHistory
parameters:
- name: userId
in: path
description: The user ID or email address of the user.
required: true
schema:
type: string
example: DnEopNmXQEGU2uvvzjgojw
- name: callLogId
in: path
description: The unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs).
required: true
schema:
type: string
example: 20231008-c106fda5-7320-46cb-a5d2-7c73a2173d2f
responses:
'204':
description: Call history has been deleted successfully
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n User does not exist: {userId}.
\n**Error Code:** `301`
\n Call history not found: {callLogId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
security:
- openapi_oauth:
- phone:write
- phone:write:admin
- phone_call_log:write
- phone_call_log:write:admin
- phone:delete:call_log
- phone:delete:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write
- phone:write:admin
- phone_call_log:write
- phone_call_log:write:admin
x-granular-scopes:
- phone:delete:call_log
- phone:delete:call_log:admin
/phone/users/{userId}/call_logs:
get:
tags:
- Call Logs
summary: Get user's call logs
description: "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone_call_log:read`,`phone_call_log:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
operationId: phoneUserCallLogs
parameters:
- name: userId
in: path
description: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
required: true
schema:
type: string
example: DYHrdpjrS3uaOf7dPkkg8w
- name: page_size
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 300
type: integer
example: 30
default: 30
- name: from
in: query
description: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data. The month defined should fall within the last six months. If unspecified, returns data within the 24 hours.
required: false
schema:
type: string
format: date
example: '2020-10-31'
- name: to
in: query
description: '**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd''T''HH:mm:ss''Z''** format, the same format as the `from` parameter.'
required: false
schema:
type: string
format: date
example: '2021-12-31'
- name: type
in: query
required: false
schema:
type: string
example: all
enum:
- all
- missed
- name: next_page_token
in: query
description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
required: false
schema:
type: string
example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
- name: phone_number
in: query
description: This field filters API responses to include call logs of only the phone number defined in this field.
required: false
schema:
type: string
example: '+12055432724'
- name: time_type
in: query
description: This field enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`.
required: false
schema:
type: string
example: startTime
default: startTime
enum:
- startTime
- endTime
responses:
'200':
description: '**HTTP Status code:** `200`
User''s call logs returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
maxItems: 100
type: array
description: The call Log
items:
type: object
properties:
accepted_by:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Pontotoc MS
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: This field indicates who accepted the call.
answer_start_time:
type: string
description: The call's answer time, in GMT `date-time` format. The API only displays this response if the `direction` value is `inbound`.
example: '2021-10-09T16:52:05Z'
call_end_time:
type: string
description: The call end time, in GMT `date-time` format.
example: '2021-10-09T17:20:53Z'
call_id:
type: string
description: The unique identifier of the phone call.
example: '7017184835983901126'
callee_country_code:
type: string
description: The country calling code.
example: '1'
callee_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
callee_did_number:
type: string
description: The callee's DID (direct inward dial) number in e164 format.
example: '+12055432724'
callee_name:
type: string
description: The contact name of callee
example: Callee name
callee_number:
type: string
description: The number of the callee
example: '1018'
callee_number_type:
type: integer
description: 'The callee''s number type:
* `1` — Extension number.
* `2` — Phone number.
* `3` — Customized emergency number.'
example: 1
enum:
- 1
- 2
- 3
callee_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `callee_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_country_code:
type: string
description: The country calling code.
example: '1'
caller_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
caller_did_number:
type: string
description: The caller's DID (direct inward dial) number in e164 format.
example: '+12055432724'
caller_name:
type: string
description: The contact name of the caller
example: Caller name
caller_number:
type: string
description: The number of the caller
example: '+12059300920'
caller_number_type:
type: integer
description: "The caller's number type: \n* `1` — Extension number. \n* `2` — Phone number."
example: 1
enum:
- 1
- 2
caller_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `caller_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_billing_reference_id:
type: string
description: The billing reference ID (for peering phone numbers).
example: ZoomTelecom123456
charge:
type: string
description: The billing charge for the call.
example: $0.0255
client_code:
type: string
description: The client code.
example: '123'
date_time:
type: string
description: The start time of the call
example: '2022-01-24T23:58:10Z'
direction:
type: string
description: The direction of the call. "inbound" | "outbound"
example: inbound
duration:
type: integer
description: The duration of the call in seconds.
example: 20
forwarded_by:
type: object
properties:
extension_number:
type: string
example: '1009'
extension_type:
type: string
example: user
enum:
- user
- callQueue
- commonAreaPhone
- autoReceptionist
- sharedLineGroup
location:
type: string
example: Glendale CA
name:
type: string
example: The display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: This field indicates where the call was forwarded from.
forwarded_to:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Glendale CA
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: The field indicates who the call was forwarded to.
has_recording:
type: boolean
description: Whether the call has a recording. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021
example: false
deprecated: true
has_voicemail:
type: boolean
description: Whether the call has a voicemail. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021.
example: false
deprecated: true
id:
type: string
description: The call Log ID
example: 48c1dfd4-91ce-4df5-8495-7c9e33d10869
outgoing_by:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Glendale CA
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
path:
type: string
description: The path of the call log.
example: pstn
rate:
type: string
description: The billing rate for the call.
example: $0.0255
recording_type:
type: string
description: "The recording type. \n\n* `On-demand` recording.\n\n* `Automatic` recording."
example: On-demand
enum:
- OnDemand
- Automatic
result:
type: string
description: 'The result of the call: `Missed` | `Voicemail` | `Call connected` | `Rejected` | `Blocked`| `Busy`| `Wrong Number`| `No Answer`| `International Disabled`| `Internal Error`| `Call failed` | `Restricted Number`| `Call Cancel` | `Message`| `Answered by Other Member` | `Call Cancelled` | `Park` | `Parked` | `Blocked by non-GAL` | `Blocked by info-Barriers` | `Recording Failure`| `Recorded`| `Auto Recorded`.'
example: Call connected
site:
type: object
properties:
id:
type: string
description: The target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) in which the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, you sites could be created based on different office locations.
example: 8f71O6rWT8KFUGQmJIFAdQ
name:
type: string
description: The name of the site where the phone number is assigned.
example: Main Site
user_id:
type: string
description: The user ID or user email.
example: DnEopNmXQEGU2uvvzjgojw
hold_time:
type: integer
description: The hold time during a call in seconds.
example: 5
waiting_time:
type: integer
description: The time (in seconds) spent waiting for the call to be connected.
example: 10
department:
type: string
description: The name of the user's department.
example: web-api1
cost_center:
type: string
description: The cost center name to which a user belongs.
example: cost-center1
from:
type: string
description: The start time and date of the log
example: '2021-10-01'
next_page_token:
type: string
description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
example: AmhfoKtF2Ey4TaPg2iZsAcmetRLs2ZY0Sk2
page_count:
type: integer
description: The total number of pages
example: 2
page_size:
type: integer
description: The number of records returned within a single API call for each page.
example: 30
to:
type: string
description: The end time and date of the log
example: '2021-10-12'
total_records:
type: integer
description: The total number of records returned.
example: 54
description: The phone user call logs
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Invalid user id.
\n**Error Code:** `400`
\n The next page token is invalid or expired.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\n**Error Code:** `3001`
\n Error retrieving call logs.
\n**Error Code:** `1001`
\n User does not exist: {userId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:read
- phone:read:admin
- phone_call_log:read
- phone_call_log:read:admin
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read
- phone:read:admin
- phone_call_log:read
- phone_call_log:read:admin
x-granular-scopes:
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
/phone/users/{userId}/call_logs/sync:
get:
tags:
- Call Logs
summary: Sync user's call logs
description: "Syncs a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_call_logs`,`phone:read:list_call_logs:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
operationId: syncUserCallLogs
parameters:
- name: userId
in: path
description: The user ID.
required: true
schema:
type: string
example: DnEopNmXQEGU2uvvzjgojw
- name: sync_type
in: query
description: "The options for synchronizing call log: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync"
required: false
schema:
type: string
example: FSync
enum:
- FSync
- ISync
- BSync
- name: count
in: query
description: The number of records returned within a single API call.
required: false
schema:
maximum: 250
minimum: 1
type: integer
example: 50
- name: sync_token
in: query
description: The time range for returned records. It's used for locating where the next retrieval will begin.
required: false
schema:
type: string
example: SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=
responses:
'200':
description: '**HTTP Status code:** `200`
User call logs returned.'
content:
application/json:
schema:
type: object
properties:
call_logs:
maxItems: 250
type: array
description: The call log.
items:
type: object
properties:
accepted_by:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Glendale CA
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: This field indicates who accepted the call.
answer_start_time:
type: string
description: The time the call was answered in GMT `date-time` format. The API only displays this response if the `direction` value is `inbound`.
example: '2021-10-08T16:10:04Z'
call_end_time:
type: string
description: The call end time in GMT `date-time` format.
example: '2021-10-08T16:12:04Z'
call_id:
type: string
description: THe unique identifier of the phone call.
example: '7006926284340112376'
callee_user_id:
type: string
description: The callee's user id.
example: IqoQmDRqS-aIoXqV_FZ88w
callee_country_code:
type: string
description: The country calling code.
example: '1'
callee_country_iso_code:
type: string
description: The ISO alpha2 country code.
example: US
callee_did_number:
type: string
description: The callee's DID (direct inward dial) number in e164 format.
example: '+12135551234'
callee_name:
type: string
description: The contact name of the callee.
example: Jan Dev
callee_number:
type: string
description: The number associated with the callee. It can be an e164 number or an extension.
example: '101'
callee_number_type:
type: integer
description: 'The callee number type:
* `1` — Extension number.
* `2` — Phone number.
* `3` — Customized emergency number.'
example: 1
enum:
- 1
- 2
- 3
callee_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `callee_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_user_id:
type: string
description: The caller's user ID.
example: IqoQmDRqS-aIoXqV_FZ88w
caller_country_code:
type: string
description: The country calling code.
example: '1'
caller_country_iso_code:
type: string
description: ISO alpha2 country code.
example: US
caller_did_number:
type: string
description: The caller's DID (direct inward dial) number in e164 format.
example: '+18108001001'
caller_name:
type: string
description: The contact name of the caller.
example: Zoom
caller_number:
type: string
description: The number associated with the caller. It can be an e164 number or an extension.
example: '+12095552345'
caller_number_type:
type: integer
description: "The caller number type: \n* `1` — Extension number. \n* `2` — Phone number."
example: 1
enum:
- 1
- 2
caller_number_source:
type: string
description: 'This field indicates where the phone number comes from:
* `internal` — ZP native.
* `external` — BYOC or Provider Exchange.
* `byop` — Premise peering.
Not available when `caller_number_type = 1`.'
example: internal
enum:
- internal
- external
- byop
caller_billing_reference_id:
type: string
description: The billing reference ID (for peering phone numbers).
example: ZoomTelecom123456
charge:
type: string
description: The billing charge for the call.
example: $0.0255
client_code:
type: string
description: The client code.
example: '123'
date_time:
type: string
description: The start time of the call.
example: '2022-01-24T23:58:10Z'
direction:
type: string
description: 'The direction of the call: `inbound`or `outbound`.'
example: inbound
duration:
type: integer
description: The duration of the call in seconds.
example: 7
forwarded_by:
type: object
properties:
extension_number:
type: string
example: '1009'
extension_type:
type: string
example: callQueue
enum:
- user
- callQueue
- commonAreaPhone
- autoReceptionist
- sharedLineGroup
location:
type: string
example: Glendale CA
name:
type: string
example: The display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: This field indicates where the call was forwarded from.
forwarded_to:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Glendale CA
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
description: This field indicates who the call was forwarded to.
has_recording:
type: boolean
description: Whether the call has a recording. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021.
example: false
deprecated: true
has_voicemail:
type: boolean
description: Whether the call has a voicemail. See [announcement](https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#deprecation-of-the-has_voicemail-and-has_recording-responses-in-phone-api) from July, 2021.
example: false
deprecated: true
id:
type: string
description: The call log ID.
example: 11f2bacb-37d8-4ae4-8d88-be657421266f
outgoing_by:
type: object
properties:
extension_number:
type: string
example: '1009'
location:
type: string
example: Glendale CA
name:
type: string
example: Display name
number_type:
type: integer
description: 'The phone number types: `1` - Extension `2`- E164 number `3` - Custom number.'
example: 1
phone_number:
type: string
example: '+12055432724'
path:
type: string
description: The path of the call log.
example: callQueue
rate:
type: string
description: The billing rate for the call.
example: $0.0255
recording_type:
type: string
description: "The recording type. \n\n* `On-demand` recording.\n\n* `Automatic` recording."
example: Automatic
enum:
- OnDemand
- Automatic
result:
type: string
description: 'The result of the call: `Missed` | `Voicemail` | `Call connected` | `Rejected` | `Blocked`| `Busy`| `Wrong Number`| `No Answer`| `International Disabled`| `Internal Error`| `Call failed` | `Restricted Number`| `Call Cancel` | `Message`| `Answered by Other Member` | `Call Cancelled` | `Park` | `Parked` | `Blocked by non-GAL` | `Blocked by info-Barriers` | `Recording Failure`| `Recorded`| `Auto Recorded`.'
example: Call connected
site:
type: object
properties:
id:
type: string
description: The target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) in which the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, your sites can be created based on different office locations.
example: GNO-CItXQaLhqH3qfPD1kg
name:
type: string
description: The name of the site where the phone number is assigned.
example: Main Site
user_id:
type: string
description: The user ID or email.
example: IqoQmDRqS-aIoXqV_FZ88w
hold_time:
type: integer
description: The hold time during a call in seconds.
example: 5
waiting_time:
type: integer
description: The time (in seconds) spent waiting for the call to be connected.
example: 47
sync_token:
type: string
description: The time range for returned records. Used for locating where the next retrieval will begin.
example: SDVjM3NHRlNyMF8xNjQwODI3NTkyMzkwXzE2NDgwMTUzNTk0MzI=
description: The sync user call logs
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Invalid user id.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n The sync token is invalid or expired.
\n**Error Code:** `2001`
\n Account does not exist.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:read:admin
- phone:read
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:read:admin
- phone:read
x-granular-scopes:
- phone:read:list_call_logs
- phone:read:list_call_logs:admin
/phone/users/{userId}/call_logs/{callLogId}:
delete:
tags:
- Call Logs
summary: Delete a user's call log
description: "Deletes a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* User must belong to a Business or Enterprise account \n* User must have a Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write`,`phone:write:admin`,`phone_call_log:write`,`phone_call_log:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:delete:call_log`,`phone:delete:call_log:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
operationId: deleteCallLog
parameters:
- name: userId
in: path
description: The user ID or email address of the user.
required: true
schema:
type: string
example: DnEopNmXQEGU2uvvzjgojw
- name: callLogId
in: path
description: The unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/accountCallLogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/phoneUserCallLogs).
required: true
schema:
type: string
example: c106fda5-7320-46cb-a5d2-7c73a2173d2f
responses:
'204':
description: "**HTTP Status Code**: `204` \n\nLog deleted.\n"
'400':
description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n Invalid user id.
\n**Error Code:** `124`
\n Invalid access token.
\n"
'404':
description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `404`
\n Call log information was not found for the following callLogId: {0}.
\n**Error Code:** `2001`
\n The account (accountId: {0}) does not exist.
\n**Error Code:** `1001`
\n User does not exist: {userId}.
\n"
'429':
description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
deprecated: true
security:
- openapi_oauth:
- phone:write
- phone:write:admin
- phone_call_log:write
- phone_call_log:write:admin
- phone:delete:call_log
- phone:delete:call_log:admin
openapi_authorization: []
x-extensions:
x-permissions: []
x-macro-scopes:
- phone:write
- phone:write:admin
- phone_call_log:write
- phone_call_log:write:admin
x-granular-scopes:
- phone:delete:call_log
- phone:delete:call_log:admin
components:
securitySchemes:
openapi_authorization:
type: apiKey
name: Authorization
in: header
openapi_oauth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /
tokenUrl: ''
refreshUrl: ''
scopes:
phone:read:admin: phone:read:admin
phone:read:list_account_settings:admin: phone:read:list_account_settings:admin
phone:write:admin: phone:write:admin
phone:write:customized_number:admin: phone:write:customized_number:admin
phone:read:list_customized_number:admin: phone:read:list_customized_number:admin
phone:delete:customized_number:admin: phone:delete:customized_number:admin
phone:write:alert_setting:admin: phone:write:alert_setting:admin
phone:read:list_alert_settings:admin: phone:read:list_alert_settings:admin
phone:read:alert_setting:admin: phone:read:alert_setting:admin
phone:patch:alert_setting:admin: phone:patch:alert_setting:admin
phone:delete:alert_setting:admin: phone:delete:alert_setting:admin
phone:read: phone:read
phone:read:audio: phone:read:audio
phone:read:audio:admin: phone:read:audio:admin
phone:write: phone:write
phone:delete:audio: phone:delete:audio
phone:delete:audio:admin: phone:delete:audio:admin
phone:update:audio: phone:update:audio
phone:update:audio:admin: phone:update:audio:admin
phone:read:list_audios: phone:read:list_audios
phone:read:list_audios:admin: phone:read:list_audios:admin
phone:write:audio: phone:write:audio
phone:write:audio:admin: phone:write:audio:admin
phone:write:batch_audios: phone:write:batch_audios
phone:write:batch_audios:admin: phone:write:batch_audios:admin
phone:read:list_auto_receptionists:admin: phone:read:list_auto_receptionists:admin
phone:write:auto_receptionist:admin: phone:write:auto_receptionist:admin
phone:delete:auto_receptionist:admin: phone:delete:auto_receptionist:admin
phone:update:auto_receptionist:admin: phone:update:auto_receptionist:admin
phone:read:auto_receptionist:admin: phone:read:auto_receptionist:admin
phone:read:auto_receptionist_call_handling_setting:admin: phone:read:auto_receptionist_call_handling_setting:admin
phone:update:auto_receptionist_call_handling_setting:admin: phone:update:auto_receptionist_call_handling_setting:admin
phone:delete:auto_receptionist_number:admin: phone:delete:auto_receptionist_number:admin
phone:write:auto_receptionist_number:admin: phone:write:auto_receptionist_number:admin
phone:update:auto_receptionist_policy:admin: phone:update:auto_receptionist_policy:admin
phone:read:auto_receptionist_policy:admin: phone:read:auto_receptionist_policy:admin
phone:delete:auto_receptionist_policy:admin: phone:delete:auto_receptionist_policy:admin
phone:write:auto_receptionist_policy:admin: phone:write:auto_receptionist_policy:admin
phone:read:auto_receptionist_setting:admin: phone:read:auto_receptionist_setting:admin
phone:write:auto_receptionist_setting:admin: phone:write:auto_receptionist_setting:admin
phone:update:auto_receptionist_setting:admin: phone:update:auto_receptionist_setting:admin
phone:delete:auto_receptionist_setting:admin: phone:delete:auto_receptionist_setting:admin
phone:read:list_billing_accounts:admin: phone:read:list_billing_accounts:admin
phone:read:billing_account:admin: phone:read:billing_account:admin
phone:write:blocked_list:admin: phone:write:blocked_list:admin
phone:read:list_blocked_lists:admin: phone:read:list_blocked_lists:admin
phone:delete:blocked_list:admin: phone:delete:blocked_list:admin
phone:read:blocked_list:admin: phone:read:blocked_list:admin
phone:update:blocked_list:admin: phone:update:blocked_list:admin
phone:read:list_call_handling_settings:admin: phone:read:list_call_handling_settings:admin
phone:update:call_handling_setting:admin: phone:update:call_handling_setting:admin
phone:delete:call_handling_setting:admin: phone:delete:call_handling_setting:admin
phone:write:call_handling_setting:admin: phone:write:call_handling_setting:admin
phone_call_log:read: phone_call_log:read
phone_call_log:read:admin: phone_call_log:read:admin
phone:read:call_log:admin: phone:read:call_log:admin
phone:read:list_call_logs:admin: phone:read:list_call_logs:admin
phone:update:call_log:admin: phone:update:call_log:admin
phone:read:ai_call_summary: phone:read:ai_call_summary
phone:read:ai_call_summary:admin: phone:read:ai_call_summary:admin
phone:read:list_call_logs: phone:read:list_call_logs
phone_call_log:write: phone_call_log:write
phone_call_log:write:admin: phone_call_log:write:admin
phone:delete:call_log: phone:delete:call_log
phone:delete:call_log:admin: phone:delete:call_log:admin
phone:read:list_call_queues:admin: phone:read:list_call_queues:admin
phone:write:call_queue:admin: phone:write:call_queue:admin
phone:delete:call_queue:admin: phone:delete:call_queue:admin
phone:update:call_queue:admin: phone:update:call_queue:admin
phone:read:call_queue:admin: phone:read:call_queue:admin
phone:read:call_queue_call_handling_setting:admin: phone:read:call_queue_call_handling_setting:admin
phone:update:call_queue_call_handling_setting:admin: phone:update:call_queue_call_handling_setting:admin
phone:read:call_queue_custom_group:admin: phone:read:call_queue_custom_group:admin
phone:write:call_queue_custom_group:admin: phone:write:call_queue_custom_group:admin
phone:update:call_queue_custom_group:admin: phone:update:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:admin: phone:delete:call_queue_custom_group:admin
phone:delete:call_queue_custom_group:master: phone:delete:call_queue_custom_group:master
phone:master: phone:master
phone:read:call_queue_custom_group:master: phone:read:call_queue_custom_group:master
phone:write:call_queue_custom_group_member:admin: phone:write:call_queue_custom_group_member:admin
phone:delete:call_queue_custom_group_member:admin: phone:delete:call_queue_custom_group_member:admin
phone:write:call_queue_member:admin: phone:write:call_queue_member:admin
phone:delete:call_queue_member:admin: phone:delete:call_queue_member:admin
phone:read:list_call_queue_members:admin: phone:read:list_call_queue_members:admin
phone:write:call_queue_number:admin: phone:write:call_queue_number:admin
phone:delete:call_queue_number:admin: phone:delete:call_queue_number:admin
phone:read:call_queue_policy:admin: phone:read:call_queue_policy:admin
phone:update:call_queue_policy:admin: phone:update:call_queue_policy:admin
phone:write:call_queue_policy:admin: phone:write:call_queue_policy:admin
phone:delete:call_queue_policy:admin: phone:delete:call_queue_policy:admin
phone:read:list_call_queue_recordings:admin: phone:read:list_call_queue_recordings:admin
phone:read:call_queue_setting:admin: phone:read:call_queue_setting:admin
phone:write:call_queue_setting:admin: phone:write:call_queue_setting:admin
phone:delete:call_queue_setting:admin: phone:delete:call_queue_setting:admin
phone:update:call_queue_setting:admin: phone:update:call_queue_setting:admin
phone:update:carrier_number:admin: phone:update:carrier_number:admin
phone:write:carrier_number:admin: phone:write:carrier_number:admin
phone:read:list_carrier_numbers:admin: phone:read:list_carrier_numbers:admin
phone:delete:carrier_number:admin: phone:delete:carrier_number:admin
phone:write:common_area:admin: phone:write:common_area:admin
phone:read:common_area:admin: phone:read:common_area:admin
phone:read:list_common_area_activation_codes:admin: phone:read:list_common_area_activation_codes:admin
phone:write:apply_template_to_common_areas:admin: phone:write:apply_template_to_common_areas:admin
phone:delete:common_area:admin: phone:delete:common_area:admin
phone:update:common_area:admin: phone:update:common_area:admin
phone:read:common_area_call_handling_setting:admin: phone:read:common_area_call_handling_setting:admin
phone:update:common_area_call_handling_setting:admin: phone:update:common_area_call_handling_setting:admin
phone:write:common_area_calling_plan:admin: phone:write:common_area_calling_plan:admin
phone:delete:common_area_calling_plan:admin: phone:delete:common_area_calling_plan:admin
phone:write:common_area_number:admin: phone:write:common_area_number:admin
phone:delete:common_area_number:admin: phone:delete:common_area_number:admin
phone:read:list_common_area_settings:admin: phone:read:list_common_area_settings:admin
phone:update:common_area_setting:admin: phone:update:common_area_setting:admin
phone:delete:common_area_setting:admin: phone:delete:common_area_setting:admin
phone:write:common_area_setting:admin: phone:write:common_area_setting:admin
phone:read:call_qos:admin: phone:read:call_qos:admin
phone:read:default_emergency_address:admin: phone:read:default_emergency_address:admin
phone:read:detectable_personal_location:admin: phone:read:detectable_personal_location:admin
phone:read:location_sharing_permission:admin: phone:read:location_sharing_permission:admin
phone:read:nomadic_emergency_services:admin: phone:read:nomadic_emergency_services:admin
phone:read:realtime_location_devices:admin: phone:read:realtime_location_devices:admin
phone:read:realtime_location_users:admin: phone:read:realtime_location_users:admin
phone:read:list_tracked_locations:admin: phone:read:list_tracked_locations:admin
phone:update:device_line_keys: phone:update:device_line_keys
phone:update:device_line_keys:admin: phone:update:device_line_keys:admin
phone:read:device_line_keys: phone:read:device_line_keys
phone:read:device_line_keys:admin: phone:read:device_line_keys:admin
phone:delete:directory:admin: phone:delete:directory:admin
phone:read:directory:admin: phone:read:directory:admin
phone:write:directory:admin: phone:write:directory:admin
phone:write:emergency_address:admin: phone:write:emergency_address:admin
phone:read:list_emergency_addresses:admin: phone:read:list_emergency_addresses:admin
phone:read:emergency_address:admin: phone:read:emergency_address:admin
phone:delete:emergency_address:admin: phone:delete:emergency_address:admin
phone:update:emergency_address:admin: phone:update:emergency_address:admin
phone:write:batch_emergency_locations:admin: phone:write:batch_emergency_locations:admin
phone:read:list_emergency_locations:admin: phone:read:list_emergency_locations:admin
phone:write:emergency_location:admin: phone:write:emergency_location:admin
phone:read:emergency_location:admin: phone:read:emergency_location:admin
phone:update:emergency_location:admin: phone:update:emergency_location:admin
phone:delete:emergency_location:admin: phone:delete:emergency_location:admin
phone:write:external_contact:admin: phone:write:external_contact:admin
phone:read:list_external_contacts:admin: phone:read:list_external_contacts:admin
phone:delete:external_contact:admin: phone:delete:external_contact:admin
phone:read:external_contact:admin: phone:read:external_contact:admin
phone:update:external_contact:admin: phone:update:external_contact:admin
phone:write:send_fax: phone:write:send_fax
phone:write:send_fax:admin: phone:write:send_fax:admin
phone:read:list_fax_log: phone:read:list_fax_log
phone:read:list_fax_log:admin: phone:read:list_fax_log:admin
phone:read:fax_log:admin: phone:read:fax_log:admin
phone:read:fax_log: phone:read:fax_log
phone:delete:fax_log: phone:delete:fax_log
phone:delete:fax_log:admin: phone:delete:fax_log:admin
phone:read:list_firmware_update_rules:admin: phone:read:list_firmware_update_rules:admin
phone:write:firmware_update_rule:admin: phone:write:firmware_update_rule:admin
phone:delete:firmware_update_rule:admin: phone:delete:firmware_update_rule:admin
phone:update:firmware_update_rule:admin: phone:update:firmware_update_rule:admin
phone:read:firmware_update_rule:admin: phone:read:firmware_update_rule:admin
phone:read:list_firmwares:admin: phone:read:list_firmwares:admin
phone:read:list_call_pickup_groups:admin: phone:read:list_call_pickup_groups:admin
phone:write:call_pickup_group:admin: phone:write:call_pickup_group:admin
phone:read:call_pickup_group:admin: phone:read:call_pickup_group:admin
phone:update:call_pickup_group:admin: phone:update:call_pickup_group:admin
phone:delete:call_pickup_group:admin: phone:delete:call_pickup_group:admin
phone:write:call_pickup_group_member:admin: phone:write:call_pickup_group_member:admin
phone:read:call_pickup_group_member:admin: phone:read:call_pickup_group_member:admin
phone:delete:call_pickup_group_member:admin: phone:delete:call_pickup_group_member:admin
phone:update:group_policy:admin: phone:update:group_policy:admin
phone:read:group_policy:admin: phone:read:group_policy:admin
phone:read:group_setting:admin: phone:read:group_setting:admin
phone:read:auto_receptionist_ivr:admin: phone:read:auto_receptionist_ivr:admin
phone:update:auto_receptionist_ivr:admin: phone:update:auto_receptionist_ivr:admin
phone:read:list_extension_inbound_block_rules:admin: phone:read:list_extension_inbound_block_rules:admin
phone:read:list_extension_inbound_block_rules: phone:read:list_extension_inbound_block_rules
phone:delete:extension_inbound_block_rule:admin: phone:delete:extension_inbound_block_rule:admin
phone:delete:extension_inbound_block_rule: phone:delete:extension_inbound_block_rule
phone:write:extension_inbound_block_rule:admin: phone:write:extension_inbound_block_rule:admin
phone:write:extension_inbound_block_rule: phone:write:extension_inbound_block_rule
phone:delete:extension_inbound_block_rule_stat:admin: phone:delete:extension_inbound_block_rule_stat:admin
phone:read:list_extension_inbound_block_rules_stat:admin: phone:read:list_extension_inbound_block_rules_stat:admin
phone:update:inbound_blocked_for_all:admin: phone:update:inbound_blocked_for_all:admin
phone:delete:inbound_block_rule:admin: phone:delete:inbound_block_rule:admin
phone:read:list_inbound_block_rules:admin: phone:read:list_inbound_block_rules:admin
phone:write:inbound_block_rule:admin: phone:write:inbound_block_rule:admin
phone:update:inbound_block_rule:admin: phone:update:inbound_block_rule:admin
phone:update:line_keys: phone:update:line_keys
phone:update:line_keys:admin: phone:update:line_keys:admin
phone:read:line_keys: phone:read:line_keys
phone:read:line_keys:admin: phone:read:line_keys:admin
phone:delete:line_keys: phone:delete:line_keys
phone:delete:line_keys:admin: phone:delete:line_keys:admin
phone:read:list_monitoring_groups:admin: phone:read:list_monitoring_groups:admin
phone:write:monitoring_group:admin: phone:write:monitoring_group:admin
phone:delete:monitoring_group:admin: phone:delete:monitoring_group:admin
phone:update:monitoring_group:admin: phone:update:monitoring_group:admin
phone:read:monitoring_group:admin: phone:read:monitoring_group:admin
phone:read:list_monitoring_group_members:admin: phone:read:list_monitoring_group_members:admin
phone:write:monitoring_group_member:admin: phone:write:monitoring_group_member:admin
phone:delete:monitoring_group_member:admin: phone:delete:monitoring_group_member:admin
phone:read:common_area_outbound_calling_rule:admin: phone:read:common_area_outbound_calling_rule:admin
phone:update:common_area_outbound_calling_rule:admin: phone:update:common_area_outbound_calling_rule:admin
phone:write:common_area_outbound_calling_rule:admin: phone:write:common_area_outbound_calling_rule:admin
phone:delete:common_area_outbound_calling_rule:admin: phone:delete:common_area_outbound_calling_rule:admin
phone:read:list_outbound_calling_rules:admin: phone:read:list_outbound_calling_rules:admin
phone:update:outbound_calling_rule:admin: phone:update:outbound_calling_rule:admin
phone:write:outbound_calling_rule:admin: phone:write:outbound_calling_rule:admin
phone:delete:outbound_calling_rule:admin: phone:delete:outbound_calling_rule:admin
phone:update:site_outbound_calling_rule:admin: phone:update:site_outbound_calling_rule:admin
phone:read:site_outbound_calling_rule:admin: phone:read:site_outbound_calling_rule:admin
phone:write:site_outbound_calling_rule:admin: phone:write:site_outbound_calling_rule:admin
phone:delete:site_outbound_calling_rule:admin: phone:delete:site_outbound_calling_rule:admin
phone:update:user_outbound_calling_rule:admin: phone:update:user_outbound_calling_rule:admin
phone:read:user_outbound_calling_rule:admin: phone:read:user_outbound_calling_rule:admin
phone:write:user_outbound_calling_rule:admin: phone:write:user_outbound_calling_rule:admin
phone:delete:user_outbound_calling_rule:admin: phone:delete:user_outbound_calling_rule:admin
phone:read:list_devices:admin: phone:read:list_devices:admin
phone:write:device:admin: phone:write:device:admin
phone:write:sync_device:admin: phone:write:sync_device:admin
phone:update:device:admin: phone:update:device:admin
phone:delete:device:admin: phone:delete:device:admin
phone:read:device:admin: phone:read:device:admin
phone:write:device_extension:admin: phone:write:device_extension:admin
phone:delete:device_extension:admin: phone:delete:device_extension:admin
phone:update:device_provision_template:admin: phone:update:device_provision_template:admin
phone:write:reboot_device:admin: phone:write:reboot_device:admin
phone:write:byo_carrier_number:admin: phone:write:byo_carrier_number:admin
phone:delete:number:admin: phone:delete:number:admin
phone:read:list_numbers:admin: phone:read:list_numbers:admin
phone:update:site_number:admin: phone:update:site_number:admin
phone:read:numbers:admin: phone:read:numbers:admin
phone:update:number:admin: phone:update:number:admin
phone:write:user_number: phone:write:user_number
phone:write:user_number:admin: phone:write:user_number:admin
phone:delete:user_number: phone:delete:user_number
phone:delete:user_number:admin: phone:delete:user_number:admin
phone:read:list_calling_plans:admin: phone:read:list_calling_plans:admin
phone:read:list_roles:admin: phone:read:list_roles:admin
phone:write:role:admin: phone:write:role:admin
phone:update:role:admin: phone:update:role:admin
phone:read:role:admin: phone:read:role:admin
phone:delete:role:admin: phone:delete:role:admin
phone:read:role_member:admin: phone:read:role_member:admin
phone:write:role_member:admin: phone:write:role_member:admin
phone:delete:role_member:admin: phone:delete:role_member:admin
phone:write:private_directory_member:admin: phone:write:private_directory_member:admin
phone:read:list_private_directory_members:admin: phone:read:list_private_directory_members:admin
phone:update:private_directory_member:admin: phone:update:private_directory_member:admin
phone:delete:private_directory_member:admin: phone:delete:private_directory_member:admin
phone_peering:read:admin: phone_peering:read:admin
phone:read:list_peering_numbers:admin: phone:read:list_peering_numbers:admin
phone_peering:write:admin: phone_peering:write:admin
phone:write:peering_number:admin: phone:write:peering_number:admin
phone:delete:peering_number:admin: phone:delete:peering_number:admin
phone:update:peering_number:admin: phone:update:peering_number:admin
phone:write:provision_template:admin: phone:write:provision_template:admin
phone:read:list_provision_templates:admin: phone:read:list_provision_templates:admin
phone:update:provision_template:admin: phone:update:provision_template:admin
phone:read:provision_template:admin: phone:read:provision_template:admin
phone:delete:provision_template:admin: phone:delete:provision_template:admin
phone_recording:read: phone_recording:read
phone_recording:read:admin: phone_recording:read:admin
phone:read:call_recording: phone:read:call_recording
phone:read:call_recording:admin: phone:read:call_recording:admin
phone:read:recording_transcript: phone:read:recording_transcript
phone:read:recording_transcript:admin: phone:read:recording_transcript:admin
phone:read:list_call_recordings:admin: phone:read:list_call_recordings:admin
phone_recording:write: phone_recording:write
phone_recording:write:admin: phone_recording:write:admin
phone:update:call_recording: phone:update:call_recording
phone:update:call_recording:admin: phone:update:call_recording:admin
phone:delete:call_recording: phone:delete:call_recording
phone:delete:call_recording:admin: phone:delete:call_recording:admin
phone:read:list_recordings: phone:read:list_recordings
phone:read:list_recordings:admin: phone:read:list_recordings:admin
phone:read:call_charges:admin: phone:read:call_charges:admin
phone:read:fax_charges:admin: phone:read:fax_charges:admin
phone:read:operation_logs:admin: phone:read:operation_logs:admin
phone:read:sms_charges:admin: phone:read:sms_charges:admin
phone:read:list_routing_rules:admin: phone:read:list_routing_rules:admin
phone:write:routing_rule:admin: phone:write:routing_rule:admin
phone:update:routing_rule:admin: phone:update:routing_rule:admin
phone:read:routing_rule:admin: phone:read:routing_rule:admin
phone:delete:routing_rule:admin: phone:delete:routing_rule:admin
phone_sms:write: phone_sms:write
phone_sms:write:admin: phone_sms:write:admin
phone:read:sms_message: phone:read:sms_message
phone:read:sms_message:admin: phone:read:sms_message:admin
phone_sms:read: phone_sms:read
phone_sms:read:admin: phone_sms:read:admin
phone:read:list_sms_sessions: phone:read:list_sms_sessions
phone:read:list_sms_sessions:admin: phone:read:list_sms_sessions:admin
phone:read:sms_session: phone:read:sms_session
phone:read:sms_session:admin: phone:read:sms_session:admin
phone:read:list_sms_campaigns:admin: phone:read:list_sms_campaigns:admin
phone:read:sms_campaign:admin: phone:read:sms_campaign:admin
phone:write:sms_campaign_number:admin: phone:write:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status:admin: phone:read:sms_campaign_number_opt_status:admin
phone:update:sms_campaign_number_opt_status:admin: phone:update:sms_campaign_number_opt_status:admin
phone:delete:sms_campaign_number:admin: phone:delete:sms_campaign_number:admin
phone:read:sms_campaign_number_opt_status: phone:read:sms_campaign_number_opt_status
phone:read:sms_consent_number_opt_status:admin: phone:read:sms_consent_number_opt_status:admin
phone:write:setting_template:admin: phone:write:setting_template:admin
phone:read:list_setting_templates:admin: phone:read:list_setting_templates:admin
phone:update:setting_template:admin: phone:update:setting_template:admin
phone:read:setting_template:admin: phone:read:setting_template:admin
phone:update:policy:admin: phone:update:policy:admin
phone:read:policy:admin: phone:read:policy:admin
phone:read:list_ported_numbers:admin: phone:read:list_ported_numbers:admin
phone:read:ported_number:admin: phone:read:ported_number:admin
phone:update:settings:admin: phone:update:settings:admin
phone:read:settings:admin: phone:read:settings:admin
phone:read:list_sip_groups:admin: phone:read:list_sip_groups:admin
phone:read:list_sip_trunks:admin: phone:read:list_sip_trunks:admin
phone:read:list_shared_line_appearances:admin: phone:read:list_shared_line_appearances:admin
phone:read:list_shared_line_groups:admin: phone:read:list_shared_line_groups:admin
phone:write:shared_line_group:admin: phone:write:shared_line_group:admin
phone:read:shared_line_group:admin: phone:read:shared_line_group:admin
phone:read:shared_line_group_call_handling_setting:admin: phone:read:shared_line_group_call_handling_setting:admin
phone:update:shared_line_group_call_handling_setting:admin: phone:update:shared_line_group_call_handling_setting:admin
phone:read:shared_line_group_policy:admin: phone:read:shared_line_group_policy:admin
phone:update:shared_line_group_policy:admin: phone:update:shared_line_group_policy:admin
phone:read:shared_line_group_setting:admin: phone:read:shared_line_group_setting:admin
phone:update:shared_line_group_setting:admin: phone:update:shared_line_group_setting:admin
phone:delete:shared_line_group_setting:admin: phone:delete:shared_line_group_setting:admin
phone:write:shared_line_group_setting:admin: phone:write:shared_line_group_setting:admin
phone:update:shared_line_group:admin: phone:update:shared_line_group:admin
phone:delete:shared_line_group:admin: phone:delete:shared_line_group:admin
phone:delete:shared_line_member:admin: phone:delete:shared_line_member:admin
phone:write:shared_line_member:admin: phone:write:shared_line_member:admin
phone:delete:shared_line_group_number:admin: phone:delete:shared_line_group_number:admin
phone:write:shared_line_group_number:admin: phone:write:shared_line_group_number:admin
phone:delete:shared_line_group_policy:admin: phone:delete:shared_line_group_policy:admin
phone:write:shared_line_group_policy:admin: phone:write:shared_line_group_policy:admin
phone:read:list_sites:admin: phone:read:list_sites:admin
phone:write:site:admin: phone:write:site:admin
phone:read:site:admin: phone:read:site:admin
phone:delete:site:admin: phone:delete:site:admin
phone:update:site:admin: phone:update:site:admin
phone:read:list_site_customized_number:admin: phone:read:list_site_customized_number:admin
phone:delete:site_customized_number:admin: phone:delete:site_customized_number:admin
phone:write:site_customized_number:admin: phone:write:site_customized_number:admin
phone:read:site_setting:admin: phone:read:site_setting:admin
phone:write:site_setting:admin: phone:write:site_setting:admin
phone:delete:site_setting:admin: phone:delete:site_setting:admin
phone:update:site_setting:admin: phone:update:site_setting:admin
phone:read:list_users:admin: phone:read:list_users:admin
phone:write:batch_users:admin: phone:write:batch_users:admin
phone:update:batch_users:admin: phone:update:batch_users:admin
phone:read:user: phone:read:user
phone:read:user:admin: phone:read:user:admin
phone:update:user: phone:update:user
phone:update:user:admin: phone:update:user:admin
phone:delete:user_call_handling_setting: phone:delete:user_call_handling_setting
phone:delete:user_call_handling_setting:admin: phone:delete:user_call_handling_setting:admin
phone:write:user_call_handling_setting: phone:write:user_call_handling_setting
phone:write:user_call_handling_setting:admin: phone:write:user_call_handling_setting:admin
phone:read:user_call_handling_setting:admin: phone:read:user_call_handling_setting:admin
phone:read:user_call_handling_setting: phone:read:user_call_handling_setting
phone:update:user_call_handling_setting:admin: phone:update:user_call_handling_setting:admin
phone:update:user_call_handling_setting: phone:update:user_call_handling_setting
phone:write:calling_plan: phone:write:calling_plan
phone:write:calling_plan:admin: phone:write:calling_plan:admin
phone:update:calling_plan: phone:update:calling_plan
phone:update:calling_plan:admin: phone:update:calling_plan:admin
phone:delete:users_calling_plan: phone:delete:users_calling_plan
phone:delete:users_calling_plan:admin: phone:delete:users_calling_plan:admin
phone:read:list_user_customized_number: phone:read:list_user_customized_number
phone:read:list_user_customized_number:admin: phone:read:list_user_customized_number:admin
phone:write:user_customized_number: phone:write:user_customized_number
phone:write:user_customized_number:admin: phone:write:user_customized_number:admin
phone:delete:user_customized_number: phone:delete:user_customized_number
phone:delete:user_customized_number:admin: phone:delete:user_customized_number:admin
phone:update:user_policy:admin: phone:update:user_policy:admin
phone:read:user_policy:admin: phone:read:user_policy:admin
phone:delete:user_setting: phone:delete:user_setting
phone:delete:user_setting:admin: phone:delete:user_setting:admin
phone:write:user_setting:admin: phone:write:user_setting:admin
phone:write:user_setting: phone:write:user_setting
phone:read:user_setting:admin: phone:read:user_setting:admin
phone:read:user_setting: phone:read:user_setting
phone:update:user_setting: phone:update:user_setting
phone:update:user_setting:admin: phone:update:user_setting:admin
phone:update:shared_setting: phone:update:shared_setting
phone:update:shared_setting:admin: phone:update:shared_setting:admin
phone:write:shared_setting: phone:write:shared_setting
phone:write:shared_setting:admin: phone:write:shared_setting:admin
phone:delete:shared_setting: phone:delete:shared_setting
phone:delete:shared_setting:admin: phone:delete:shared_setting:admin
phone_voicemail:read: phone_voicemail:read
phone_voicemail:read:admin: phone_voicemail:read:admin
phone:read:voicemail: phone:read:voicemail
phone:read:voicemail:admin: phone:read:voicemail:admin
phone:read:list_voicemails: phone:read:list_voicemails
phone:read:list_voicemails:admin: phone:read:list_voicemails:admin
phone_voicemail:write: phone_voicemail:write
phone_voicemail:write:admin: phone_voicemail:write:admin
phone:update:voicemail: phone:update:voicemail
phone:update:voicemail:admin: phone:update:voicemail:admin
phone:delete:voicemail: phone:delete:voicemail
phone:delete:voicemail:admin: phone:delete:voicemail:admin
phone:read:list_rooms:admin: phone:read:list_rooms:admin
phone:write:room:admin: phone:write:room:admin
phone:read:room:admin: phone:read:room:admin
phone:delete:room:admin: phone:delete:room:admin
phone:update:room:admin: phone:update:room:admin
phone:write:room_calling_plan:admin: phone:write:room_calling_plan:admin
phone:delete:room_calling_plan:admin: phone:delete:room_calling_plan:admin
phone:write:room_phone_number:admin: phone:write:room_phone_number:admin
phone:delete:room_phone_number:admin: phone:delete:room_phone_number:admin
externalDocs:
description: Find out more about Swagger
url: https://swagger.io