{"openapi":"3.1.0","info":{"title":"Ferrule Zoom Phone API","version":"1.0.0","description":"REST API for Zoom Phone via the Ferrule gateway.","contact":{"name":"Ferrule","url":"https://ferrule.io"}},"servers":[{"url":"https://0.0.0.0:3000","description":"Ferrule gateway"}],"paths":{"/api/v1/zoom-phone/settings":{"get":{"operationId":"zoom-phone.list_zoom_phone_account_settings","description":"List an account's Zoom Phone settings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"setting_types","schema":{"description":"The comma separated list of the setting items you want to fetch.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_live_transcription":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"transcription_start_prompt":{"type":"object","properties":{"enable":{"type":"boolean"},"audio_id":{"type":"string"},"audio_name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}]},"local_survivability_mode":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"external_calling_on_zoom_room_common_area":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"select_outbound_caller_id":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"allow_hide_outbound_caller_id":{"type":"boolean"}},"additionalProperties":{}}]},"personal_audio_library":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"allow_music_on_hold_customization":{"type":"boolean"},"allow_voicemail_and_message_greeting_customization":{"type":"boolean"}},"additionalProperties":{}}]},"voicemail":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"allow_videomail":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_delete":{"type":"boolean"},"allow_share":{"type":"boolean"},"allow_virtual_background":{"type":"boolean"}},"additionalProperties":{}}]},"voicemail_transcription":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"voicemail_notification_by_email":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"include_voicemail_file":{"type":"boolean"},"include_voicemail_transcription":{"type":"boolean"},"forward_voicemail_to_email":{"type":"boolean"}},"additionalProperties":{}}]},"shared_voicemail_notification_by_email":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"restricted_call_hours":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"time_zone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"restricted_hours_applied":{"type":"boolean"},"restricted_holiday_hours_applied":{"type":"boolean"},"allow_internal_calls":{"type":"boolean"}},"additionalProperties":{}}]},"allowed_call_locations":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"locations_applied":{"type":"boolean"},"allow_internal_calls":{"type":"boolean"}},"additionalProperties":{}}]},"check_voicemails_over_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"auto_call_recording":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"recording_calls":{"anyOf":[{"type":"string","enum":["inbound","outbound","both"]},{"type":"string"}]},"recording_transcription":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_start_prompt_audio_id":{"type":"string"},"recording_explicit_consent":{"type":"boolean"},"allow_stop_resume_recording":{"type":"boolean"},"disconnect_on_recording_failure":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMembers","recordingUser"]},{"type":"string"}]},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]}},"additionalProperties":{}},"inbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_start_prompt_audio_id":{"type":"string"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}},"outbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_start_prompt_audio_id":{"type":"string"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}]},"ad_hoc_call_recording":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"recording_transcription":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_delete":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_explicit_consent":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMembers","recordingUser"]},{"type":"string"}]},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]}},"additionalProperties":{}}},"additionalProperties":{}}]},"international_calling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"outbound_calling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"outbound_sms":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"sms":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"international_sms":{"type":"boolean"}},"additionalProperties":{}}]},"sms_etiquette_tool":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"sms_etiquette_policy":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"rule":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"content":{"type":"string"},"action":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"active":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}}]},"zoom_phone_on_mobile":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"allow_calling_sms_mms":{"type":"boolean"}},"additionalProperties":{}}]},"zoom_phone_on_pwa":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"e2e_encryption":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"call_handling_forwarding_to_other_users":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"call_forwarding_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]}},"additionalProperties":{}}]},"call_overflow":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"call_overflow_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]}},"additionalProperties":{}}]},"call_transferring":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"call_transferring_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]}},"additionalProperties":{}}]},"elevate_to_meeting":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"call_park":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"expiration_period":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8},{"type":"number","const":9},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":35},{"type":"number","const":40},{"type":"number","const":45},{"type":"number","const":50},{"type":"number","const":55},{"type":"number","const":60}]},"call_not_picked_up_action":{"type":"number"},"forward_to":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"extension_type":{"anyOf":[{"type":"string","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},{"type":"string"}]},"id":{"type":"string"}},"additionalProperties":{}},"sequence":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]}},"additionalProperties":{}}]},"hand_off_to_room":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"mobile_switch_to_carrier":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"delegation":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"audio_intercom":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"block_calls_without_caller_id":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"block_external_calls":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"block_business_hours":{"type":"boolean"},"block_closed_hours":{"type":"boolean"},"block_holiday_hours":{"type":"boolean"},"block_call_action":{"anyOf":[{"type":"number","const":0},{"type":"number","const":9}]}},"additionalProperties":{}}]},"call_queue_opt_out_reason":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"call_queue_opt_out_reasons_list":{"maxItems":30,"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"system":{"type":"boolean"},"enable":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}}]},"auto_delete_data_after_retention_duration":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms","fax"]},{"type":"string"}]},"duration":{"type":"number"},"time_unit":{"anyOf":[{"type":"string","enum":["year","month","day"]},{"type":"string"}]}},"additionalProperties":{}}},"delete_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"permanently_delete_after_days":{"type":"number"}},"additionalProperties":{}},"auto_call_from_third_party_apps":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"override_default_port":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"min_port":{"type":"number"},"max_port":{"type":"number"}},"additionalProperties":{}}]},"peer_to_peer_media":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"advanced_encryption":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"disable_incoming_unencrypted_voicemail":{"type":"boolean"}},"additionalProperties":{}}]},"display_call_feedback_survey":{"allOf":[{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},{"type":"object","properties":{"feedback_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"feedback_mos":{"type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"string"},"max":{"type":"string"}},"additionalProperties":{}},"feedback_duration":{"type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"number"},"max":{"type":"number"}},"additionalProperties":{}}},"additionalProperties":{}}]},"block_list_for_inbound_calls_and_messaging":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"block_calls_as_threat":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"type":"string"}},"additionalProperties":{}},"online_fax":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"enable_new_fax_email_notifications":{"type":"boolean"},"include_fax_as_attachment":{"type":"boolean"}},"additionalProperties":{}},"private_call_park":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"expiration_period":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8},{"type":"number","const":9},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":35},{"type":"number","const":40},{"type":"number","const":45},{"type":"number","const":50},{"type":"number","const":55},{"type":"number","const":60}]},"call_not_picked_up_action":{"type":"number"},"forward_to":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"extension_type":{"anyOf":[{"type":"string","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},{"type":"string"}]},"id":{"type":"string"}},"additionalProperties":{}},"sequence":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"music_on_park":{"type":"object","properties":{"audio_id":{"type":"string"},"audio_name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"sms_template":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"sms_template_list":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"sms_template_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"active":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}},"call_screening":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"exclude_user_company_contacts":{"type":"boolean"}},"additionalProperties":{}},"sms_auto_reply":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"allow_end_user_edit_call_handling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"connect_to_operator":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"no_hold_conference":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"conference_dtmf":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"end_conference_call_when_originator_drops":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"chat_channel":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"desk_phone_smart_key_positions_layout":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"auto_opt_out_in_call_queue":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"prompt_before_opt_out_call_queue":{"type":"boolean"}},"additionalProperties":{}},"allow_mobile_home_phone_callout":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"use_callkit_for_incoming_call_notifications_in_ios":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"hide_phone_call_history_in_ios":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"obfuscate_sensitive_data_during_call":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"prevent_users_upload_audio_files":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"voicemail_tasks":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"voicemail_intent_based_prioritization":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"team_sms_thread_summary":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]}},"additionalProperties":{}},"customize_line_name":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"user_line_name":{"anyOf":[{"type":"string","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber","firstName;extensionNumber","firstName;lastName;extensionNumber"]},{"type":"string"}]},"common_area_line_name":{"anyOf":[{"type":"string","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber"]},{"type":"string"}]}},"additionalProperties":{}},"show_custom_disclaimer_when_using_zoom_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"display_frequency":{"anyOf":[{"type":"string","enum":["first_time_only","every_time","every_month","every_quarter","every_6_months","every_year"]},{"type":"string"}]},"custom_disclaimer_list":{"type":"array","items":{"type":"object","properties":{"language":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/auto-receptionists":{"get":{"operationId":"zoom-phone.list_auto_receptionists","description":"List auto receptionists","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The total number of records returned from a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through large result sets.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"auto_receptionists":{"type":"array","items":{"type":"object","properties":{"cost_center":{"type":"string"},"department":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"audio_prompt_language":{"type":"string"},"holiday_hours":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}},"additionalProperties":{}}},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/auto-receptionists/{autoReceptionistId}":{"get":{"operationId":"zoom-phone.get_auto_receptionist_detail","description":"Get an auto receptionist","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"autoReceptionistId","schema":{"type":"string","description":"The auto receptionist ID."},"required":true,"description":"The auto receptionist ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cost_center":{"type":"string"},"department":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"name":{"type":"string"},"timezone":{"type":"string"},"audio_prompt_language":{"anyOf":[{"type":"string","enum":["en-US","en-GB","es-US","fr-CA","da-DK","de-DE","es-ES","fr-FR","it-IT","nl-NL","pt-PT","ja","ko-KR","pt-BR","zh-CN"]},{"type":"string"}]},"holiday_hours":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}},"additionalProperties":{}}},"phone_numbers":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"recording_storage_location":{"anyOf":[{"type":"string","enum":["US","AU","CA","DE","IN","JP","SG","BR","CN","MX"]},{"type":"string"}]},"own_storage_name":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/auto-receptionists/{autoReceptionistId}/policy":{"get":{"operationId":"zoom-phone.get_auto_receptionists_policy","description":"Get an auto receptionist policy","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"autoReceptionistId","schema":{"type":"string","description":"The unique identifier of the auto receptionist."},"required":true,"description":"The unique identifier of the auto receptionist."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"voicemail_access_members":{"type":"array","items":{"type":"object","properties":{"shared_id":{"type":"string"},"access_user_id":{"type":"string"},"access_user_type":{"anyOf":[{"type":"string","enum":["commonArea","user"]},{"type":"string"}]},"delete":{"type":"boolean"},"download":{"type":"boolean"}},"additionalProperties":{}}},"voicemail_transcription":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_notification_by_email":{"type":"object","properties":{"include_voicemail_file":{"type":"boolean"},"include_voicemail_transcription":{"type":"boolean"},"forward_voicemail_to_email":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"sms":{"type":"object","properties":{"enable":{"type":"boolean"},"international_sms":{"type":"boolean"},"international_sms_countries":{"type":"array","items":{"type":"string"}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/auto-receptionists/{autoReceptionistId}/ivr":{"get":{"operationId":"zoom-phone.get_auto_receptionist_ivr","description":"Get auto receptionist IVR","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"autoReceptionistId","schema":{"type":"string","description":"The unique identifier of the auto receptionist."},"required":true,"description":"The unique identifier of the auto receptionist."},{"in":"query","name":"hours_type","schema":{"description":"The query hours type: business_hours or closed_hours, default business_hours.","type":"string"}},{"in":"query","name":"holiday_id","schema":{"description":"The auto receptionist holiday hours ID.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"audio_prompt":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"caller_enters_no_action":{"type":"object","properties":{"action":{"type":"number"},"audio_prompt_repeat":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"forward_to":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"string"},"id":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"key_actions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"number"},"key":{"type":"string"},"target":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"string"},"id":{"type":"string"},"phone_number":{"type":"string"}},"additionalProperties":{}},"voicemail_greeting":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-history":{"get":{"operationId":"zoom-phone.account_call_history","description":"Get account's call history","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"from","schema":{"description":"The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"keyword","schema":{"description":"Search by name, extension, number, email address, or call ID.","type":"string"}},{"in":"query","name":"directions","schema":{"description":"The direction filter of the call logs.","type":"string"}},{"in":"query","name":"connect_types","schema":{"description":"The connect type filter: internal or external.","type":"string"}},{"in":"query","name":"number_types","schema":{"description":"The number type filter of the caller or callee.","type":"string"}},{"in":"query","name":"call_types","schema":{"description":"The call type filter: general or emergency.","type":"string"}},{"in":"query","name":"extension_types","schema":{"description":"The extension type filter of the call logs.","type":"string"}},{"in":"query","name":"call_results","schema":{"description":"The call result filter of the call logs.","type":"string"}},{"in":"query","name":"group_ids","schema":{"description":"The primary group filter of call logs.","type":"string"}},{"in":"query","name":"site_ids","schema":{"description":"The site filter of call logs.","type":"string"}},{"in":"query","name":"department","schema":{"description":"The department where the call log belongs.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The cost center where the call log belongs.","type":"string"}},{"in":"query","name":"time_type","schema":{"description":"Search call logs by start or end time. Default: start_time.","type":"string","enum":["start_time","end_time"]}},{"in":"query","name":"recording_status","schema":{"description":"Filter by recording status.","type":"string","enum":["recorded","non_recorded"]}},{"in":"query","name":"with_voicemail","schema":{"description":"The voicemail filter of the call logs.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_logs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"call_id":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"international":{"anyOf":[{"type":"boolean","const":true},{"type":"boolean","const":false}]},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"duration":{"type":"number"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"sbc_id":{"type":"string"},"sbc_name":{"type":"string"},"sip_group_id":{"type":"string"},"sip_group_name":{"type":"string"},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"call_result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_name":{"type":"string"},"callee_email":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"department":{"type":"string"},"cost_center":{"type":"string"},"site_id":{"type":"string"},"group_id":{"type":"string"},"site_name":{"type":"string"},"spam":{"type":"string"},"recording_status":{"anyOf":[{"type":"string","enum":["recorded","non_recorded"]},{"type":"string"}]},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"call_history":{"type":"array","items":{"type":"object","properties":{"call_history_uuid":{"type":"string"},"call_id":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"international":{"anyOf":[{"type":"boolean","const":true},{"type":"boolean","const":false}]},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"duration":{"type":"number"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"sbc_id":{"type":"string"},"sbc_name":{"type":"string"},"sip_group_id":{"type":"string"},"sip_group_name":{"type":"string"},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"call_result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_name":{"type":"string"},"callee_email":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"department":{"type":"string"},"cost_center":{"type":"string"},"site_id":{"type":"string"},"group_id":{"type":"string"},"site_name":{"type":"string"},"spam":{"type":"string"},"recording_status":{"anyOf":[{"type":"string","enum":["recorded","non_recorded"]},{"type":"string"}]},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"from":{"type":"string"},"to":{"type":"string"},"page_count":{"type":"number"},"page_size":{"type":"number"},"total_records":{"type":"number"},"next_page_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-history/{callHistoryUuid}/call-path":{"get":{"operationId":"zoom-phone.get_call_path","description":"Get call history","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"callHistoryUuid","schema":{"type":"string","description":"The ID of the call history."},"required":true,"description":"The ID of the call history."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"call_history_uuid":{"type":"string"},"call_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"international":{"anyOf":[{"type":"boolean","const":true},{"type":"boolean","const":false}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_email":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_email":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"department":{"type":"string"},"cost_center":{"type":"string"},"site_id":{"type":"string"},"group_id":{"type":"string"},"site_name":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"call_path":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"call_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"client_code":{"type":"string"},"department":{"type":"string"},"cost_center":{"type":"string"},"site_id":{"type":"string"},"group_id":{"type":"string"},"site_name":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"press_key":{"type":"string"},"segment":{"type":"number"},"node":{"type":"number"},"is_node":{"type":"number"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["automatic","ad-hoc"]},{"type":"string"}]},"hold_time":{"type":"number"},"waiting_time":{"type":"number"},"voicemail_id":{"type":"string"}},"additionalProperties":{}}},"caller_acconut_code":{"type":"string"},"callee_account_code":{"type":"string"},"call_elements":{"type":"array","items":{"type":"object","properties":{"call_element_id":{"type":"string"},"call_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"client_code":{"type":"string"},"department":{"type":"string"},"cost_center":{"type":"string"},"site_id":{"type":"string"},"group_id":{"type":"string"},"site_name":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"press_key":{"type":"string"},"segment":{"type":"number"},"node":{"type":"number"},"is_node":{"type":"number"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["automatic","ad-hoc"]},{"type":"string"}]},"hold_time":{"type":"number"},"waiting_time":{"type":"number"},"voicemail_id":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/ai-call-summaries/{aiCallSummaryId}":{"get":{"operationId":"zoom-phone.get_user_ai_call_summary","description":"Get User AI Call Summary Detail","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The owner's user ID."},"required":true,"description":"The owner's user ID."},{"in":"path","name":"aiCallSummaryId","schema":{"type":"string","description":"The ID of the AI call summary."},"required":true,"description":"The ID of the AI call summary."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ai_call_summary_id":{"type":"string"},"account_id":{"type":"string"},"call_id":{"type":"string"},"user_id":{"type":"string"},"call_summary_rate":{"anyOf":[{"type":"string","enum":["thumb_up","thumb_down"]},{"type":"string"}]},"transcript_language":{"type":"string"},"call_summary":{"type":"string"},"next_steps":{"type":"string"},"detailed_summary":{"type":"string"},"created_time":{"type":"string"},"modified_time":{"type":"string"},"edited":{"type":"boolean"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/call-history":{"get":{"operationId":"zoom-phone.phone_user_call_history","description":"Get user's call history","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address. Use 'me' for authenticated user."},"required":true,"description":"The user ID or email address. Use 'me' for authenticated user."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"from","schema":{"description":"The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"keyword","schema":{"description":"Search by name, extension, number, email address, or call ID.","type":"string"}},{"in":"query","name":"directions","schema":{"description":"The direction filter of the call logs.","type":"string"}},{"in":"query","name":"connect_types","schema":{"description":"The connect type filter: internal or external.","type":"string"}},{"in":"query","name":"number_types","schema":{"description":"The number type filter of the caller or callee.","type":"string"}},{"in":"query","name":"call_types","schema":{"description":"The call type filter: general or emergency.","type":"string"}},{"in":"query","name":"extension_types","schema":{"description":"The extension type filter of the call logs.","type":"string"}},{"in":"query","name":"call_results","schema":{"description":"The call result filter of the call logs.","type":"string"}},{"in":"query","name":"group_ids","schema":{"description":"The primary group filter of call logs.","type":"string"}},{"in":"query","name":"site_ids","schema":{"description":"The site filter of call logs.","type":"string"}},{"in":"query","name":"department","schema":{"description":"The department of which the call log belongs.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The cost center of which the call log belongs.","type":"string"}},{"in":"query","name":"time_type","schema":{"description":"Search call logs by start or end time. Default: start_time.","type":"string","enum":["start_time","end_time"]}},{"in":"query","name":"recording_status","schema":{"description":"Filter by recording status.","type":"string","enum":["recorded","non_recorded"]}},{"in":"query","name":"with_voicemail","schema":{"description":"The voicemail filter of the call logs.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_logs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"call_path_id":{"type":"string"},"call_id":{"type":"string"},"group_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_employee_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_private_ip":{"type":"string"},"caller_device_public_ip":{"type":"string"},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"caller_site_id":{"type":"string"},"caller_department":{"type":"string"},"caller_cost_center":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_employee_id":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_private_ip":{"type":"string"},"callee_device_public_ip":{"type":"string"},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"callee_site_id":{"type":"string"},"callee_department":{"type":"string"},"callee_cost_center":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["ad-hoc","automatic"]},{"type":"string"}]},"voicemail_id":{"type":"string"},"talk_time":{"type":"number"},"hold_time":{"type":"number"},"wait_time":{"type":"number"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"call_elements":{"type":"array","items":{"type":"object","properties":{"call_element_id":{"type":"string"},"call_history_uuid":{"type":"string"},"call_id":{"type":"string"},"group_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_employee_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_private_ip":{"type":"string"},"caller_device_public_ip":{"type":"string"},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"caller_site_id":{"type":"string"},"caller_department":{"type":"string"},"caller_cost_center":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_employee_id":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_private_ip":{"type":"string"},"callee_device_public_ip":{"type":"string"},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"callee_site_id":{"type":"string"},"callee_department":{"type":"string"},"callee_cost_center":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["ad-hoc","automatic"]},{"type":"string"}]},"voicemail_id":{"type":"string"},"talk_time":{"type":"number"},"hold_time":{"type":"number"},"wait_time":{"type":"number"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"from":{"type":"string"},"to":{"type":"string"},"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/call-history/sync":{"get":{"operationId":"zoom-phone.sync_user_call_history","description":"Sync user's call history","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID."},"required":true,"description":"The user ID."},{"in":"query","name":"sync_type","schema":{"description":"Synchronization type: FSync (Full), ISync (Incremental), BSync (Backward).","type":"string"}},{"in":"query","name":"count","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"sync_token","schema":{"description":"The time range for returned records, used for locating next retrieval.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_logs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"call_path_id":{"type":"string"},"call_id":{"type":"string"},"group_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_employee_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_private_ip":{"type":"string"},"caller_device_public_ip":{"type":"string"},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"caller_site_id":{"type":"string"},"caller_department":{"type":"string"},"caller_cost_center":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_employee_id":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_private_ip":{"type":"string"},"callee_device_public_ip":{"type":"string"},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"callee_site_id":{"type":"string"},"callee_department":{"type":"string"},"callee_cost_center":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["ad-hoc","automatic"]},{"type":"string"}]},"voicemail_id":{"type":"string"},"talk_time":{"type":"number"},"hold_time":{"type":"number"},"wait_time":{"type":"number"},"ai_call_summary_id":{"type":"string"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"call_elements":{"type":"array","items":{"type":"object","properties":{"call_element_id":{"type":"string"},"call_history_uuid":{"type":"string"},"call_id":{"type":"string"},"group_id":{"type":"string"},"connect_type":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]},"call_type":{"anyOf":[{"type":"string","enum":["general","emergency"]},{"type":"string"}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"hide_caller_id":{"type":"boolean"},"end_to_end":{"type":"boolean"},"caller_ext_id":{"type":"string"},"caller_name":{"type":"string"},"caller_email":{"type":"string"},"caller_employee_id":{"type":"string"},"caller_did_number":{"type":"string"},"caller_ext_number":{"type":"string"},"caller_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"caller_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"caller_device_private_ip":{"type":"string"},"caller_device_public_ip":{"type":"string"},"caller_device_type":{"type":"string"},"caller_country_iso_code":{"type":"string"},"caller_country_code":{"type":"string"},"caller_site_id":{"type":"string"},"caller_department":{"type":"string"},"caller_cost_center":{"type":"string"},"callee_ext_id":{"type":"string"},"callee_name":{"type":"string"},"callee_did_number":{"type":"string"},"callee_ext_number":{"type":"string"},"callee_email":{"type":"string"},"callee_employee_id":{"type":"string"},"callee_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"callee_number_type":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"callee_device_private_ip":{"type":"string"},"callee_device_public_ip":{"type":"string"},"callee_device_type":{"type":"string"},"callee_country_iso_code":{"type":"string"},"callee_country_code":{"type":"string"},"callee_site_id":{"type":"string"},"callee_department":{"type":"string"},"callee_cost_center":{"type":"string"},"start_time":{"type":"string"},"answer_time":{"type":"string"},"end_time":{"type":"string"},"event":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result":{"anyOf":[{"type":"string","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"]},{"type":"string"}]},"result_reason":{"anyOf":[{"type":"string","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},{"type":"string"}]},"operator_ext_number":{"type":"string"},"operator_ext_id":{"type":"string"},"operator_ext_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},{"type":"string"}]},"operator_name":{"type":"string"},"recording_id":{"type":"string"},"recording_type":{"anyOf":[{"type":"string","enum":["ad-hoc","automatic"]},{"type":"string"}]},"voicemail_id":{"type":"string"},"talk_time":{"type":"number"},"hold_time":{"type":"number"},"wait_time":{"type":"number"},"ai_call_summary_id":{"type":"string"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"sync_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-queues/analytics":{"get":{"operationId":"zoom-phone.callqueueanalytics","description":"List call queue analytics","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"from","schema":{"type":"string","description":"The call start time in GMT yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format."}},{"in":"query","name":"to","schema":{"type":"string","description":"The call end time in GMT yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format."}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The unique identifier of the site.","type":"string"}},{"in":"query","name":"call_queue_ext_ids","schema":{"description":"The call queue extension ID list.","type":"string"}},{"in":"query","name":"department","schema":{"description":"The department of which the call queue belongs.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The cost center where the call queue belongs.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_queues":{"type":"array","items":{"type":"object","properties":{"call_queue_id":{"type":"string"},"call_queue_name":{"type":"string"},"call_queue_ext_id":{"type":"string"},"inbound_calls":{"type":"number"},"completed_calls":{"type":"number"},"abandoned_calls":{"type":"number"},"overflowed_calls":{"type":"number"},"avg_handle_time":{"type":"number"},"avg_wrap_up_time":{"type":"number"},"avg_in_queue_wait_time":{"type":"number"},"max_in_queue_wait_time":{"type":"number"},"outbound_calls":{"type":"number"},"outbound_connected_calls":{"type":"number"},"outbound_unconnected_calls":{"type":"number"},"site_name":{"type":"string"},"site_id":{"type":"string"}},"additionalProperties":{}}},"from":{"type":"string"},"to":{"type":"string"},"page_size":{"type":"number"},"next_page_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-queues":{"get":{"operationId":"zoom-phone.list_call_queues","description":"List call queues","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned from a single API call.","type":"number"}},{"in":"query","name":"site_id","schema":{"description":"Unique identifier of the site.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The call queue's cost center.","type":"string"}},{"in":"query","name":"department","schema":{"description":"The call queue's department.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_queues":{"type":"array","items":{"type":"object","properties":{"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"source":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]}},"additionalProperties":{}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"string"}]}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-queues/{callQueueId}":{"get":{"operationId":"zoom-phone.get_a_call_queue","description":"Get call queue details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"callQueueId","schema":{"type":"string","description":"The unique identifier of the call queue."},"required":true,"description":"The unique identifier of the call queue."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cost_center":{"type":"string"},"department":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"members":{"type":"object","properties":{"users":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"level":{"anyOf":[{"type":"string","enum":["manager","user"]},{"type":"string"}]},"name":{"type":"string"},"receive_call":{"type":"boolean"},"extension_id":{"type":"string"}},"additionalProperties":{}}},"common_areas":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension_id":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}},"name":{"type":"string"},"phone_numbers":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"source":{"anyOf":[{"type":"string","enum":["internal","external"]},{"type":"string"}]}},"additionalProperties":{}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"string"}]},"policy":{"type":"object","properties":{"voicemail_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"access_user_type":{"anyOf":[{"type":"string","enum":["commonArea","user"]},{"type":"string"}]},"allow_download":{"type":"boolean"},"allow_delete":{"type":"boolean"},"allow_sharing":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}}},"additionalProperties":{}},"timezone":{"type":"string"},"audio_prompt_language":{"anyOf":[{"type":"string","enum":["en-US","en-GB","es-US","fr-CA","da-DK","de-DE","es-ES","fr-FR","it-IT","nl-NL","pt-PT","ja","ko-KR","pt-BR","zh-CN"]},{"type":"string"}]},"recording_storage_location":{"anyOf":[{"type":"string","enum":["US","AU","CA","DE","IN","JP","SG","BR","CN","MX"]},{"type":"string"}]},"own_storage_name":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-queues/{callQueueId}/members":{"get":{"operationId":"zoom-phone.list_call_queue_members","description":"List call queue members","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"callQueueId","schema":{"type":"string","description":"The call queue ID."},"required":true,"description":"The call queue ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_queue_members":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"level":{"anyOf":[{"type":"string","enum":["commonArea","user"]},{"type":"string"}]},"name":{"type":"string"},"receive_call":{"type":"boolean"},"extension_id":{"type":"string"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-queues/{callQueueId}/recordings":{"get":{"operationId":"zoom-phone.get_call_queue_recordings","description":"Get call queue recordings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"callQueueId","schema":{"type":"string","description":"Unique identifier of the Call Queue."},"required":true,"description":"Unique identifier of the Call Queue."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"from","schema":{"description":"The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string"},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"recordings":{"type":"array","items":{"type":"object","properties":{"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"string","enum":["1","2","3"]},{"type":"string"}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"date_time":{"type":"string"},"direction":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"}},"additionalProperties":{}}},"to":{"type":"string"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/phone-numbers":{"get":{"operationId":"zoom-phone.list_cr_phone_numbers","description":"List phone numbers","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The size of the page.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The current page number of returned records.","type":"string"}},{"in":"query","name":"assigned_status","schema":{"description":"Number assignment status.","type":"string","enum":["assigned","unassigned","returned"]}},{"in":"query","name":"sub_account_id","schema":{"description":"Partner account ID from sub-account.","type":"string"}},{"in":"query","name":"keyword","schema":{"description":"Partial string of the phone number.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"carrier_reseller_numbers":{"type":"array","items":{"type":"object","properties":{"assigned_status":{"anyOf":[{"type":"string","enum":["assigned","unassigned","returned"]},{"type":"string"}]},"carrier_code":{"type":"number"},"country_iso_code":{"type":"string"},"phone_number":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["inactive","active"]},{"type":"string"}]},"sub_account_id":{"type":"string"},"sub_account_name":{"type":"string"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/metrics":{"get":{"operationId":"zoom-phone.list_call_logs_metrics","description":"List call logs","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"The start date in yyyy-mm-dd format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"The end date in yyyy-mm-dd format.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The unique identifier of the site.","type":"string"}},{"in":"query","name":"quality_type","schema":{"description":"Filter call logs by voice quality.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_logs":{"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"callee":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"}},"additionalProperties":{}},"caller":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"direction":{"type":"string"},"duration":{"type":"number"},"mos":{"type":"string"}},"additionalProperties":{}}},"from":{"type":"string"},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"to":{"type":"string"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/{callId}/qos":{"get":{"operationId":"zoom-phone.get_call_qo_s","description":"Get call QoS","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"callId","schema":{"type":"string","description":"The unique identifier of the call."},"required":true,"description":"The unique identifier of the call."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_id":{"type":"string"},"callee_qos":{"type":"object","properties":{"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"receiving":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string"},"qos":{"type":"object","properties":{"avg_loss":{"type":"string"},"bitrate":{"type":"string"},"jitter":{"type":"string"},"max_loss":{"type":"string"},"mos":{"type":"string"},"network_delay":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}},"sending":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string"},"qos":{"type":"object","properties":{"avg_loss":{"type":"string"},"bitrate":{"type":"string"},"jitter":{"type":"string"},"max_loss":{"type":"string"},"mos":{"type":"string"},"network_delay":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"additionalProperties":{}},"caller_qos":{"type":"object","properties":{"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"receiving":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string"},"qos":{"type":"object","properties":{"avg_loss":{"type":"string"},"bitrate":{"type":"string"},"jitter":{"type":"string"},"max_loss":{"type":"string"},"mos":{"type":"string"},"network_delay":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}},"sending":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string"},"qos":{"type":"object","properties":{"avg_loss":{"type":"string"},"bitrate":{"type":"string"},"jitter":{"type":"string"},"max_loss":{"type":"string"},"mos":{"type":"string"},"network_delay":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/{call_id}/metrics":{"get":{"operationId":"zoom-phone.get_call_log_metrics_details","description":"Get call details from call log","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"call_id","schema":{"type":"string","description":"The unique identifier of the phone call."},"required":true,"description":"The unique identifier of the phone call."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_id":{"type":"string"},"callee":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"},"id":{"type":"string"},"extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]},"display_name":{"type":"string"}},"additionalProperties":{}},"caller":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"},"id":{"type":"string"},"extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]},"display_name":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"direction":{"type":"string"},"duration":{"type":"number"},"mos":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/past-metrics":{"get":{"operationId":"zoom-phone.list_past_call_metrics","description":"List past call metrics","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"The start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"phone_number","schema":{"description":"Filter call logs of a specified phone number.","type":"string"}},{"in":"query","name":"extension_number","schema":{"description":"Filter call logs of a specified extension number.","type":"string"}},{"in":"query","name":"quality_type","schema":{"description":"Filter call logs by voice quality.","type":"string","enum":["good","bad"]}},{"in":"query","name":"department","schema":{"description":"The department the extension belongs to.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The cost center the extension belongs to.","type":"string"}},{"in":"query","name":"directions","schema":{"description":"The directions of the call.","type":"string"}},{"in":"query","name":"durations","schema":{"description":"The duration of the call filter.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The unique identifier of the site.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_logs":{"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"callee":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"}},"additionalProperties":{}},"caller":{"type":"object","properties":{"codec":{"type":"string"},"device_private_ip":{"type":"string"},"device_public_ip":{"type":"string"},"device_type":{"type":"string"},"extension_number":{"type":"string"},"headset":{"type":"string"},"isp":{"type":"string"},"microphone":{"type":"string"},"phone_number":{"type":"string"},"site_id":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound","internal"]},{"type":"string"}]},"duration":{"type":"number"},"mos":{"type":"string"}},"additionalProperties":{}}},"from":{"type":"string"},"to":{"type":"string"},"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/directory/users":{"get":{"operationId":"zoom-phone.list_users_from_directory","description":"List users in directory","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"in_directory","schema":{"description":"Whether the user belongs to the directory.","type":"boolean"}},{"in":"query","name":"site_id","schema":{"type":"string","description":"Unique identifier of the site."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"result":{"type":"array","items":{"type":"object","properties":{"extension_id":{"type":"string"},"display_name":{"type":"string"},"email":{"type":"string"},"extension_number":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sites/{siteId}/directory/users":{"get":{"operationId":"zoom-phone.list_users_from_directory_by_site","description":"List users in a directory by site","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"siteId","schema":{"type":"string","description":"Unique identifier of the site."},"required":true,"description":"Unique identifier of the site."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"in_directory","schema":{"description":"Whether the user belongs to the directory.","type":"boolean"}},{"in":"query","name":"site_id","schema":{"description":"Unique identifier of the site to which users belong.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"result":{"type":"array","items":{"type":"object","properties":{"extension_id":{"type":"string"},"display_name":{"type":"string"},"email":{"type":"string"},"extension_number":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/external-contacts":{"get":{"operationId":"zoom-phone.list_external_contacts","description":"List external contacts","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"external_contacts":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"email":{"type":"string"},"extension_number":{"type":"string"},"external_contact_id":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"auto_call_recorded":{"type":"boolean"},"profile_picture_download_url":{"type":"string"},"enable_internal_extension":{"type":"boolean"}},"additionalProperties":{}}},"next_page_token":{"type":"string"},"page_size":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{extensionId}/fax-logs":{"get":{"operationId":"zoom-phone.getusersfaxlogs","description":"Get extension's fax logs","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"extensionId","schema":{"type":"string","description":"The extension ID of the fax log owner."},"required":true,"description":"The extension ID of the fax log owner."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The token to retrieve the next page of results.","type":"string"}},{"in":"query","name":"sender_number","schema":{"description":"The sender's fax number in E164 format.","type":"string"}},{"in":"query","name":"receiver_number","schema":{"description":"The receiver's fax number in E164 format.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"total_records":{"type":"number"},"fax_logs":{"type":"array","items":{"type":"object","properties":{"fax_log_id":{"type":"string"},"fax_id":{"type":"string"},"site_id":{"type":"string"},"site_name":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound","inbound"]},{"type":"string"}]},"extension_id":{"type":"string"},"extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_id":{"type":"string"},"sender_extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_number":{"type":"string"},"sender_name":{"type":"string"},"sender_number":{"type":"string"},"sender_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn","email","openapi"]},{"type":"string"}]},"sender_location":{"type":"string"},"sender_user_agent":{"type":"string"},"receiver_extension_id":{"type":"string"},"receiver_extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"receiver_extension_number":{"type":"string"},"receiver_name":{"type":"string"},"receiver_number":{"type":"string"},"receiver_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn"]},{"type":"string"}]},"receiver_location":{"type":"string"},"receiver_user_agent":{"type":"string"},"file_id":{"type":"string"},"file_pages_count":{"type":"number"},"status":{"anyOf":[{"type":"string","enum":["failed","processing","submitted","sent","received"]},{"type":"string"}]},"read_status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"create_time":{"type":"string"}},"additionalProperties":{}}}},"required":["total_records","fax_logs"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/fax-logs":{"get":{"operationId":"zoom-phone.get_accounts_fax_logs","description":"Get account's fax logs","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The token to retrieve the next page of results.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The site's unique ID.","type":"string"}},{"in":"query","name":"sender_number","schema":{"description":"The sender's fax number in E164 format.","type":"string"}},{"in":"query","name":"receiver_number","schema":{"description":"The receiver's fax number in E164 format.","type":"string"}},{"in":"query","name":"extension_type","schema":{"description":"The extension type of fax's log owner.","type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"total_records":{"type":"number"},"fax_logs":{"type":"array","items":{"type":"object","properties":{"fax_log_id":{"type":"string"},"fax_id":{"type":"string"},"site_id":{"type":"string"},"site_name":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound","inbound"]},{"type":"string"}]},"extension_id":{"type":"string"},"extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_id":{"type":"string"},"sender_extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_number":{"type":"string"},"sender_name":{"type":"string"},"sender_number":{"type":"string"},"sender_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn","email","openapi"]},{"type":"string"}]},"sender_location":{"type":"string"},"sender_user_agent":{"type":"string"},"receiver_extension_id":{"type":"string"},"receiver_extension_type":{"anyOf":[{"type":"string","enum":["user","call_queue","auto_receptionist","common_area","shared_line_group"]},{"type":"string"}]},"receiver_extension_number":{"type":"string"},"receiver_name":{"type":"string"},"receiver_number":{"type":"string"},"receiver_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn"]},{"type":"string"}]},"receiver_location":{"type":"string"},"receiver_user_agent":{"type":"string"},"file_id":{"type":"string"},"file_pages_count":{"type":"number"},"status":{"anyOf":[{"type":"string","enum":["failed","processing","submitted","sent","received"]},{"type":"string"}]},"read_status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"create_time":{"type":"string"}},"additionalProperties":{}}}},"required":["total_records","fax_logs"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/fax-logs/{faxLogId}":{"get":{"operationId":"zoom-phone.get_fax_log_details","description":"Get fax log details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"faxLogId","schema":{"type":"string","description":"The fax log's unique ID."},"required":true,"description":"The fax log's unique ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"fax_log_id":{"type":"string"},"fax_id":{"type":"string"},"site_id":{"type":"string"},"site_name":{"type":"string"},"direction":{"anyOf":[{"type":"string","enum":["outbound","inbound"]},{"type":"string"}]},"extension_id":{"type":"string"},"extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_id":{"type":"string"},"sender_extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"sender_extension_number":{"type":"string"},"sender_name":{"type":"string"},"sender_number":{"type":"string"},"sender_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn","email","openapi"]},{"type":"string"}]},"sender_location":{"type":"string"},"sender_user_agent":{"type":"string"},"receiver_extension_id":{"type":"string"},"receiver_extension_type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"]},{"type":"string"}]},"receiver_extension_number":{"type":"string"},"receiver_name":{"type":"string"},"receiver_number":{"type":"string"},"receiver_type":{"anyOf":[{"type":"string","enum":["client","ata","pstn"]},{"type":"string"}]},"receiver_location":{"type":"string"},"receiver_user_agent":{"type":"string"},"file_id":{"type":"string"},"file_pages_count":{"type":"number"},"status":{"anyOf":[{"type":"string","enum":["failed","processing","submitted","sent","received"]},{"type":"string"}]},"read_status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"status_reason":{"anyOf":[{"type":"string","enum":["success","no_answer","number_busy","invalid_phone_number","failure_transmission","internal_system_error","fax_machine_not_detected"]},{"type":"string"}]},"retry_times":{"type":"number"},"node":{"type":"number"},"create_time":{"type":"string"}},"additionalProperties":{}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/fax-logs/{faxLogId}/files/{fileId}":{"get":{"operationId":"zoom-phone.downloadfaxfile","description":"Download fax file","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"faxLogId","schema":{"type":"string","description":"The fax log's unique ID."},"required":true,"description":"The fax log's unique ID."},{"in":"path","name":"fileId","schema":{"type":"string","description":"The fax file ID."},"required":true,"description":"The fax file ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/calling-plans":{"get":{"operationId":"zoom-phone.list_calling_plans","description":"List calling plans","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"calling_plans":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"assigned":{"type":"number"},"available":{"type":"number"},"name":{"type":"string"},"subscribed":{"type":"number"},"type":{"type":"number"},"billing_account_id":{"type":"string"},"billing_account_name":{"type":"string"},"billing_subscription_id":{"type":"string"},"billing_subscription_name":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/{callId}/recordings":{"get":{"operationId":"zoom-phone.get_phone_recordings_by_call_id_or_call_log_id","description":"Get recording by call ID","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string","description":"The unique ID of the call log (callLogId or callId)."},"required":true,"description":"The unique ID of the call log (callLogId or callId)."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_history_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"outgoing_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"accepted_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"direction":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"end_time":{"type":"string"},"id":{"type":"string"},"meeting_uuid":{"type":"string"},"owner":{"type":"object","properties":{"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","commonArea"]},{"type":"string"}]},"extension_status":{"anyOf":[{"type":"string","enum":["inactive","deleted"]},{"type":"string"}]},"extension_deleted_time":{"type":"string"}},"additionalProperties":{}},"deleted_time":{"type":"string"},"days_left_auto_permantely_delete":{"type":"number"},"soft_deleted_type":{"anyOf":[{"type":"string","enum":["Manual","Data Retention"]},{"type":"string"}]},"recording_type":{"anyOf":[{"type":"string","enum":["OnDemand","Automatic"]},{"type":"string"}]},"file_url":{"type":"string"},"disclaimer_status":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/recordings/{recordingId}/download":{"get":{"operationId":"zoom-phone.phone_download_recording_file","description":"Download a phone recording","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"fileId","schema":{"type":"string","description":"The file ID of the phone recording."},"required":true,"description":"The file ID of the phone recording."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/recordings/{recordingId}/transcript":{"get":{"operationId":"zoom-phone.phone_download_recording_transcript","description":"Download a phone recording transcript","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"recordingId","schema":{"type":"string","description":"The phone recording ID."},"required":true,"description":"The phone recording ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/recordings":{"get":{"operationId":"zoom-phone.get_phone_recordings","description":"Get call recordings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned. Default: 30, max: 300.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The current page number of returned records.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"owner_type","schema":{"description":"The owner type: null, user, callQueue, or commonArea.","type":"string"}},{"in":"query","name":"recording_type","schema":{"description":"The recording type: null, OnDemand, or Automatic.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The site ID. Default: All sites.","type":"string"}},{"in":"query","name":"query_date_type","schema":{"description":"Query date type: start_time or end_time. Default: start_time.","type":"string"}},{"in":"query","name":"group_id","schema":{"description":"The group ID. Default: All groups.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"recordings":{"type":"array","items":{"type":"object","properties":{"auto_delete_policy":{"type":"string"},"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"outgoing_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"accepted_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"disclaimer_status":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"string"}]},"download_url":{"type":"string"},"duration":{"type":"number"},"end_time":{"type":"string"},"id":{"type":"string"},"meeting_uuid":{"type":"string"},"owner":{"type":"object","properties":{"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","commonArea"]},{"type":"string"}]},"extension_status":{"anyOf":[{"type":"string","enum":["inactive","deleted"]},{"type":"string"}]},"extension_deleted_time":{"type":"string"}},"additionalProperties":{}},"recording_type":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"transcript_download_url":{"type":"string"},"auto_delete_enable":{"type":"boolean"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/recordings":{"get":{"operationId":"zoom-phone.phone_user_recordings","description":"Get user's recordings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address. Use 'me' for authenticated user."},"required":true,"description":"The user ID or email address. Use 'me' for authenticated user."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through large result sets.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string"},"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_size":{"type":"number"},"recordings":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_history_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"outgoing_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"accepted_by":{"type":"object","properties":{"name":{"type":"string"},"extension_number":{"type":"string"}},"additionalProperties":{}},"date_time":{"type":"string"},"direction":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"meeting_uuid":{"type":"string"},"transcript_download_url":{"type":"string"},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}},"to":{"type":"string"},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/reports/call-charges":{"get":{"operationId":"zoom-phone.get_call_charges_usage_report","description":"Get call charges usage report","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned. Default: 30, max: 300.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"billing_account_id","schema":{"description":"The billing account ID.","type":"string"}},{"in":"query","name":"show_charges_only","schema":{"description":"Show calls with charges only. Default: false.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"default":30,"type":"number"},"total_records":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"call_charges":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"call_log_id":{"type":"string"},"caller_number":{"type":"string"},"caller_billing_number":{"type":"string"},"callee_number":{"type":"string"},"callee_billing_number":{"type":"string"},"call_type":{"anyOf":[{"type":"string","enum":["voip","local","tollfree","international","callCenter"]},{"type":"string"}]},"service_type":{"anyOf":[{"type":"string","enum":["meeting","call"]},{"type":"string"}]},"calling_party_name":{"type":"string"},"cost_center":{"type":"string"},"employee_id":{"type":"string"},"department":{"type":"string"},"end_time":{"type":"string"},"duration":{"type":"number"},"charge_mode":{"anyOf":[{"type":"string","enum":["per_min","per_call","per_call_per_min","per_min_after_t_duration","per_call_per_min_after_t_duration"]},{"type":"string"}]},"rate":{"type":"string"},"currency":{"type":"string"},"total_charge":{"type":"string"},"billing_number":{"type":"string"},"forward_number_billing":{"type":"string"}},"additionalProperties":{}}}},"required":["page_size"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/reports/fax-charges":{"get":{"operationId":"zoom-phone.getfaxchargesusagereport","description":"Get fax charges usage report","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned. Default: 30, max: 300.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"fax_id","schema":{"description":"The fax ID to filter charges for a specific fax.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"fax_charges":{"type":"array","items":{"type":"object","properties":{"fax_id":{"type":"string"},"sender_number":{"type":"string"},"receiver_number":{"type":"string"},"billing_number":{"type":"string"},"end_time":{"type":"string"},"charge_mode":{"anyOf":[{"type":"string","enum":["per_page"]},{"type":"string"}]},"fax_type":{"anyOf":[{"type":"string","enum":["local","international"]},{"type":"string"}]},"unlimited":{"type":"boolean"},"total_pages":{"type":"number"},"rate":{"type":"string"},"currency":{"type":"string"},"currency_sign":{"type":"string"},"charge_status":{"anyOf":[{"type":"string","enum":["pending","calculated"]},{"type":"string"}]},"charged_pages":{"type":"number"},"total_charge":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/reports/operation-logs":{"get":{"operationId":"zoom-phone.get_ps_operation_logs","description":"Get operation logs report","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd format.","type":"string"}},{"in":"query","name":"category_type","schema":{"description":"Filter by the category of the action performed. Default: all.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"default":30,"type":"number"}},"required":["page_size"],"additionalProperties":{}},{"type":"object","properties":{"total_records":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"}},"additionalProperties":{}},{"type":"object","properties":{"operation_logs":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"category_type":{"type":"string"},"operation_detail":{"type":"string"},"operator":{"type":"string"},"time":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/reports/sms-charges":{"get":{"operationId":"zoom-phone.get_sms_charges_usage_report","description":"Get SMS/MMS charges usage report","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"page_size","schema":{"description":"The number of records returned. Default: 30, max: 300.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"show_charges_only","schema":{"description":"Show SMS/MMS with charges only. Default: false.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"total_records":{"type":"number"},"from":{"type":"string"},"to":{"type":"string"},"sms_charges":{"type":"array","items":{"type":"object","properties":{"session_id":{"type":"string"},"message_id":{"type":"string"},"message_type":{"type":"string"},"from_number":{"type":"string"},"from_extension_number":{"type":"string"},"from_display_name":{"type":"string"},"to_number":{"type":"string"},"to_extension_number":{"type":"string"},"to_display_name":{"type":"string"},"sent_time":{"type":"string"},"billing_number":{"type":"string"},"cost_center":{"type":"string"},"department":{"type":"string"},"rate":{"type":"string"},"currency":{"type":"string"},"total_charge":{"type":"string"},"delivery_status":{"anyOf":[{"type":"string","enum":["Sent","Failed to send","Delivered","Failed to deliver","Received","Unknown"]},{"type":"string"}]},"delivery_detail":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sms/sessions":{"get":{"operationId":"zoom-phone.account_sms_session","description":"Get account's SMS sessions","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The current page number of returned records.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"session_type","schema":{"description":"Filter by session type: user, call_queue, auto_receptionist, or all.","type":"string"}},{"in":"query","name":"phone_number","schema":{"description":"The sender's or receiver's phone number to filter SMS sessions.","type":"string"}},{"in":"query","name":"filter_type","schema":{"description":"Filter by message timestamp type.","type":"string","enum":["sent_message_time","received_message_time","last_message_time","sent_received_message_time"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"sms_sessions":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"last_access_time":{"type":"string"},"participants":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"},"is_session_owner":{"type":"boolean"},"extension_status":{"anyOf":[{"type":"string","enum":["inactive","deleted"]},{"type":"string"}]},"extension_deleted_time":{"type":"string"}},"additionalProperties":{}}},"session_id":{"type":"string"},"session_type":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sms/sessions/{sessionId}":{"get":{"operationId":"zoom-phone.sms_session_details","description":"Get SMS session details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","description":"The SMS session ID."},"required":true,"description":"The SMS session ID."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The current page number of returned records.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"sort","schema":{"description":"Order of SMS by creation time: 1=ascending, 2=descending.","type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"sms_histories":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"download_url":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"anyOf":[{"type":"string","enum":["OTHER","PNG","GIF","JPG","AUDIO","VIDEO"]},{"type":"string"}]}},"additionalProperties":{}}},"date_time":{"type":"string"},"direction":{"type":"string"},"message":{"type":"string"},"message_id":{"type":"string"},"message_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6}]},"sender":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}},"to_members":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}}}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sms/messages/{messageId}":{"get":{"operationId":"zoom-phone.sms_by_message_id","description":"Get SMS by message ID","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","description":"The SMS session ID."},"required":true,"description":"The SMS session ID."},{"in":"path","name":"messageId","schema":{"type":"string","description":"The SMS message ID."},"required":true,"description":"The SMS message ID."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"download_url":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"anyOf":[{"type":"string","enum":["OTHER","PNG","GIF","JPG","AUDIO","VIDEO"]},{"type":"string"}]}},"additionalProperties":{}}},"date_time":{"type":"string"},"direction":{"type":"string"},"message":{"type":"string"},"message_id":{"type":"string"},"message_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6}]},"sender":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}},"to_members":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sms/sessions/sync":{"get":{"operationId":"zoom-phone.sms_session_sync","description":"Sync SMS by session ID","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","description":"The SMS session ID."},"required":true,"description":"The SMS session ID."},{"in":"query","name":"sync_type","schema":{"description":"Synchronization type: FSync (Full), ISync (Incremental), BSync (Backward).","type":"string","enum":["FSync","ISync","BSync"]}},{"in":"query","name":"count","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"sync_token","schema":{"description":"The time range for returned records, used for locating next retrieval.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sms_histories":{"maxItems":250,"type":"array","items":{"type":"object","properties":{"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"download_url":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"anyOf":[{"type":"string","enum":["OTHER","PNG","GIF","JPG","AUDIO","VIDEO"]},{"type":"string"}]}},"additionalProperties":{}}},"date_time":{"type":"string"},"direction":{"type":"string"},"message":{"type":"string"},"message_id":{"type":"string"},"message_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6}]},"sender":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}},"to_members":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}}}},"additionalProperties":{}}},"sync_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/sms/sessions":{"get":{"operationId":"zoom-phone.user_sms_session","description":"Get user's SMS sessions","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID, user email, or 'me' when using OAuth token."},"required":true,"description":"The user ID, user email, or 'me' when using OAuth token."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The current page number of returned records.","type":"string"}},{"in":"query","name":"session_type","schema":{"description":"Filter by session type: user, call_queue, auto_receptionist, or all.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"phone_number","schema":{"description":"The sender's or receiver's phone number to filter SMS sessions.","type":"string"}},{"in":"query","name":"filter_type","schema":{"description":"Filter by message timestamp type.","type":"string","enum":["sent_message_time","received_message_time","last_message_time","sent_received_message_time"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"sms_sessions":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"last_access_time":{"type":"string"},"participants":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"},"is_session_owner":{"type":"boolean"}},"additionalProperties":{}}},"session_id":{"type":"string"},"session_type":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/sms/sessions/{sessionId}":{"get":{"operationId":"zoom-phone.get_sms_sessions","description":"List user's SMS sessions in descending order","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID, user email, or 'me' when using OAuth token."},"required":true,"description":"The user ID, user email, or 'me' when using OAuth token."},{"in":"query","name":"sync_type","schema":{"type":"string","enum":["FSync","BSync","ISync"],"description":"Sync type: FSync (Full), BSync (Backward), ISync (Forward)."}},{"in":"query","name":"sync_token","schema":{"description":"The sync token for backward or forward sync.","type":"string"}},{"in":"query","name":"count","schema":{"description":"The record count of each query.","type":"number"}},{"in":"query","name":"session_type","schema":{"description":"Filter by session type: user, call_queue, auto_receptionist, or all.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"sms_sessions":{"maxItems":250,"type":"array","items":{"type":"object","properties":{"last_access_time":{"type":"string"},"latest_message":{"type":"object","properties":{"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["OTHER","PNG","GIF","JPG/JPEG","AUDIO","VIDEO"]},{"type":"string"}]}},"additionalProperties":{}}},"date_time":{"type":"string"},"direction":{"type":"string"},"message":{"type":"string"},"message_id":{"type":"string"},"message_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6}]},"sender":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}},"to_members":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"}},"required":["phone_number"],"additionalProperties":{}}}},"additionalProperties":{}},"participants":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"owner":{"type":"object","properties":{"id":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"]},{"type":"string"}]}},"additionalProperties":{}},"phone_number":{"type":"string"},"is_session_owner":{"type":"boolean"}},"additionalProperties":{}}},"session_id":{"type":"string"},"session_type":{"type":"string"},"unread_message_count":{"type":"number"}},"additionalProperties":{}}},"sync_token":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/policy":{"get":{"operationId":"zoom-phone.get_account_policy_details","description":"Get account policy details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"policyType","schema":{"type":"string","description":"The type of policy to retrieve."},"required":true,"description":"The type of policy to retrieve."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"allow_emergency_calls":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"allow_emergency_calls_from_clients":{"type":"boolean"},"allow_emergency_calls_from_deskphones":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/settings/account":{"get":{"operationId":"zoom-phone.phone_setting","description":"Get phone account settings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"byoc":{"type":"object","properties":{"enable":{"type":"boolean"}},"additionalProperties":{}},"country":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"multiple_sites":{"type":"object","properties":{"enabled":{"type":"boolean"},"site_code":{"type":"boolean"}},"additionalProperties":{}},"show_device_ip_for_call_log":{"type":"object","properties":{"enable":{"type":"boolean"}},"additionalProperties":{}},"multiple_party_conference":{"type":"object","properties":{"enable":{"type":"boolean"}},"additionalProperties":{}},"billing_account":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/shared-line-groups":{"get":{"operationId":"zoom-phone.list_shared_line_groups","description":"List shared line groups","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"default":30,"type":"number"},"shared_line_groups":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["pending","available"]},{"type":"string"}]}},"additionalProperties":{}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"string"}]}},"additionalProperties":{}}},"total_records":{"type":"number"}},"required":["page_size"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sites":{"get":{"operationId":"zoom-phone.list_phone_sites","description":"List phone sites","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"site_name","schema":{"description":"The name of the site to search.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"type":"number"},"sites":{"type":"array","items":{"type":"object","properties":{"country":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"id":{"type":"string"},"main_auto_receptionist":{"type":"object","properties":{"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"name":{"type":"string"},"site_code":{"type":"number"}},"additionalProperties":{}}},"total_records":{"type":"number"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/sites/{siteId}":{"get":{"operationId":"zoom-phone.get_a_site","description":"Get phone site details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"siteId","schema":{"type":"string","description":"The unique identifier of the site."},"required":true,"description":"The unique identifier of the site."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"id":{"type":"string"},"main_auto_receptionist":{"type":"object","properties":{"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"name":{"type":"string"},"short_extension":{"type":"object","properties":{"length":{"default":3,"type":"number"}},"required":["length"],"additionalProperties":{}},"site_code":{"type":"number"},"policy":{"type":"object","properties":{"select_outbound_caller_id":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"allow_hide_outbound_caller_id":{"type":"boolean"}},"additionalProperties":{}},"personal_audio_library":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"allow_music_on_hold_customization":{"type":"boolean"},"allow_voicemail_and_message_greeting_customization":{"type":"boolean"}},"additionalProperties":{}},"voicemail":{"type":"object","properties":{"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_videomail":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_transcription":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_notification_by_email":{"type":"object","properties":{"include_voicemail_file":{"type":"boolean"},"include_voicemail_transcription":{"type":"boolean"},"forward_voicemail_to_email":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"shared_voicemail_notification_by_email":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"international_calling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"zoom_phone_on_mobile":{"type":"object","properties":{"allow_calling_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["ios","android","intune","blackberry"]},{"type":"string"}]}},"allow_sms_mms_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["ios","android","intune","blackberry"]},{"type":"string"}]}},"allow_calling_sms_mms":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"sms":{"type":"object","properties":{"enable":{"type":"boolean"},"international_sms":{"type":"boolean"},"international_sms_countries":{"type":"array","items":{"type":"string"}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"allow_copy":{"type":"boolean"},"allow_paste":{"type":"boolean"}},"additionalProperties":{}},"elevate_to_meeting":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"hand_off_to_room":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"mobile_switch_to_carrier":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"delegation":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"ad_hoc_call_recording":{"type":"object","properties":{"enable":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_transcription":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMember","recordingSide"]},{"type":"string"}]}},"additionalProperties":{}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"auto_call_recording":{"type":"object","properties":{"allow_stop_resume_recording":{"type":"boolean"},"disconnect_on_recording_failure":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"recording_calls":{"anyOf":[{"type":"string","enum":["inbound","outbound","both"]},{"type":"string"}]},"recording_explicit_consent":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_transcription":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMember","recordingSide"]},{"type":"string"}]}},"additionalProperties":{}},"inbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}},"outbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"call_handling_forwarding_to_other_users":{"type":"object","properties":{"enable":{"type":"boolean"},"call_forwarding_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"check_voicemails_over_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"call_queue_pickup_code":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"call_queue_opt_out_reason":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"call_queue_opt_out_reasons_list":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"system":{"type":"boolean"},"enable":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}},"show_user_last_transferred_call":{"type":"boolean"},"auto_delete_data_after_retention_duration":{"type":"object","properties":{"enable":{"type":"boolean"},"reset":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"anyOf":[{"type":"string","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms"]},{"type":"string"}]},"duration":{"type":"number"},"time_unit":{"anyOf":[{"type":"string","enum":["year","month","day"]},{"type":"string"}]}},"additionalProperties":{}}},"delete_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]}},"additionalProperties":{}},"call_park":{"type":"object","properties":{"call_not_picked_up_action":{"type":"number"},"enable":{"type":"boolean"},"expiration_period":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8},{"type":"number","const":9},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":35},{"type":"number","const":40},{"type":"number","const":45},{"type":"number","const":50},{"type":"number","const":55},{"type":"number","const":60}]},"forward_to":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"extension_type":{"anyOf":[{"type":"string","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},{"type":"string"}]},"id":{"type":"string"}},"additionalProperties":{}},"sequence":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"call_overflow":{"type":"object","properties":{"call_overflow_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"call_transferring":{"type":"object","properties":{"call_transferring_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"audio_intercom":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"block_calls_without_caller_id":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"block_external_calls":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"block_business_hours":{"type":"boolean"},"block_closed_hours":{"type":"boolean"},"block_holiday_hours":{"type":"boolean"},"block_call_action":{"anyOf":[{"type":"number","const":0},{"type":"number","const":9}]},"block_call_change_type":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1}]},"e2e_encryption":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"force_off_net":{"type":"object","properties":{"enable":{"type":"boolean"},"allow_extension_only_users_call_users_outside_site":{"type":"boolean"}},"additionalProperties":{}},"external_calling_on_zoom_room_common_area":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"zoom_phone_on_pwa":{"type":"object","properties":{"allow_calling":{"type":"boolean"},"allow_sms_mms":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"sms_auto_reply":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"allow_end_user_edit_call_handling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"allow_caller_reach_operator":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"forward_call_outside_of_site":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"allow_mobile_home_phone_callout":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"obfuscate_sensitive_data_during_call":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"prevent_users_upload_audio_files":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_tasks":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_intent_based_prioritization":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"team_sms_thread_summary":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"display_call_feedback_survey":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"feedback_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"feedback_mos":{"type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"number"},"max":{"type":"number"}},"additionalProperties":{}},"feedback_duration":{"type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"number"},"max":{"type":"number"}},"additionalProperties":{}}},"additionalProperties":{}},"call_live_transcription":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"transcription_start_prompt":{"type":"object","properties":{"enable":{"type":"boolean"},"audio_id":{"type":"string"},"audio_name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"call_screening":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"exclude_user_company_contacts":{"type":"boolean"}},"additionalProperties":{}},"sms_template":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"sms_template_list":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"sms_template_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"active":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}},"advanced_encryption":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"disable_incoming_unencrypted_voicemail":{"type":"boolean"}},"additionalProperties":{}},"customize_line_name":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"user_line_name":{"anyOf":[{"type":"string","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber","firstName;extensionNumber","firstName;lastName;extensionNumber"]},{"type":"string"}]},"common_area_line_name":{"anyOf":[{"type":"string","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber"]},{"type":"string"}]}},"additionalProperties":{}},"auto_opt_out_in_call_queue":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"prompt_before_opt_out_call_queue":{"type":"boolean"}},"additionalProperties":{}},"incoming_call_notification":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"block_type":{"anyOf":[{"type":"string","enum":["block_activity","continue_with_alert"]},{"type":"string"}]}},"additionalProperties":{}},"call_summary":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"auto_call_summary":{"type":"boolean"},"call_summary_start_prompt":{"type":"object","properties":{"enable":{"type":"boolean"},"audio_id":{"type":"string"},"audio_name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"schedule_firmware_update":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account"]},{"type":"string"}]},"modified":{"type":"boolean"},"repeat_type":{"anyOf":[{"type":"string","enum":["weekly","monthly"]},{"type":"string"}]},"repeat_setting":{"anyOf":[{"type":"object","properties":{"weekly_setting":{"type":"object","properties":{"weekday":{"anyOf":[{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},{"type":"string"}]}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"week_and_day":{"type":"object","properties":{"week_of_month":{"type":"number"},"weekday":{"anyOf":[{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},{"type":"string"}]}},"additionalProperties":{}}},"additionalProperties":{}},{"type":"object","properties":{"specific_date":{"type":"object","properties":{"day_of_month":{"type":"number"}},"additionalProperties":{}}},"additionalProperties":{}}]},"time_period_start":{"type":"number"},"time_period_end":{"type":"number"},"time_zone":{"type":"string"},"end_setting":{"type":"object","properties":{"never_end":{"type":"boolean"},"end_date":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"zoom_phone_on_desktop":{"type":"object","properties":{"allow_calling_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["mac_os","windows","vdi_client","linux"]},{"type":"string"}]}},"allow_sms_mms_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["mac_os","windows","vdi_client","linux"]},{"type":"string"}]}},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"sip_zone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"caller_id_name":{"type":"string"},"india_state_code":{"type":"string"},"india_city":{"type":"string"},"india_sdca_npa":{"type":"string"},"india_entity_name":{"type":"string"},"default_emergency_address":{"type":"object","properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"id":{"type":"string"},"is_default":{"type":"boolean"},"level":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2}]},"state_code":{"type":"string"},"status":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6}]},"zip":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users":{"get":{"operationId":"zoom-phone.list_phone_users","description":"List phone users","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned from a single API call.","type":"number"}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"site_id","schema":{"description":"The unique identifier of the site.","type":"string"}},{"in":"query","name":"calling_type","schema":{"description":"The type of calling plan.","type":"number"}},{"in":"query","name":"status","schema":{"description":"The status of the Zoom Phone user.","type":"string","enum":["activate","deactivate","pending"]}},{"in":"query","name":"department","schema":{"description":"The department where the user belongs.","type":"string"}},{"in":"query","name":"cost_center","schema":{"description":"The cost center where the user belongs.","type":"string"}},{"in":"query","name":"keyword","schema":{"description":"Search by name, extension number, or phone number.","type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string"},"page_size":{"default":30,"type":"number"},"total_records":{"type":"number"},"users":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"calling_plans":{"maxItems":150,"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"number"},"billing_account_id":{"type":"string"},"billing_account_name":{"type":"string"},"billing_subscription_id":{"type":"string"},"billing_subscription_name":{"type":"string"}},"additionalProperties":{}}},"email":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"phone_user_id":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"status":{"type":"string"},"activation_status":{"anyOf":[{"type":"string","enum":["activated","ready to activate","not ready"]},{"type":"string"}]},"phone_numbers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}},"department":{"type":"string"},"cost_center":{"type":"string"}},"additionalProperties":{}}}},"required":["page_size"],"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}":{"get":{"operationId":"zoom-phone.phone_user","description":"Get a user's profile","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address. Use 'me' for authenticated user."},"required":true,"description":"The user ID or email address. Use 'me' for authenticated user."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"calling_plans":{"maxItems":150,"type":"array","items":{"type":"object","properties":{"type":{"type":"number"},"billing_account_id":{"type":"string"},"billing_account_name":{"type":"string"},"billing_subscription_id":{"type":"string"},"billing_subscription_name":{"type":"string"}},"additionalProperties":{}}},"cost_center":{"type":"string"},"department":{"type":"string"},"email":{"type":"string"},"emergency_address":{"type":"object","properties":{"address_line1":{"type":"string"},"address_line2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"id":{"type":"string"},"state_code":{"type":"string"},"zip":{"type":"string"}},"additionalProperties":{}},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"id":{"type":"string"},"phone_numbers":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}},"phone_user_id":{"type":"string"},"policy":{"type":"object","properties":{"ad_hoc_call_recording":{"type":"object","properties":{"enable":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_transcription":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMember","recordingSide"]},{"type":"string"}]}},"additionalProperties":{}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"ad_hoc_call_recording_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}},"auto_call_recording":{"type":"object","properties":{"allow_stop_resume_recording":{"type":"boolean"},"disconnect_on_recording_failure":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"recording_calls":{"anyOf":[{"type":"string","enum":["inbound","outbound","both"]},{"type":"string"}]},"recording_explicit_consent":{"type":"boolean"},"recording_start_prompt":{"type":"boolean"},"recording_transcription":{"type":"boolean"},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"type":"boolean"},"play_beep_volume":{"anyOf":[{"type":"number","const":0},{"type":"number","const":20},{"type":"number","const":40},{"type":"number","const":60},{"type":"number","const":80},{"type":"number","const":100}]},"play_beep_time_interval":{"anyOf":[{"type":"number","const":5},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":60},{"type":"number","const":120}]},"play_beep_member":{"anyOf":[{"type":"string","enum":["allMember","recordingSide"]},{"type":"string"}]}},"additionalProperties":{}},"inbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}},"outbound_audio_notification":{"type":"object","properties":{"recording_start_prompt":{"type":"boolean"},"recording_explicit_consent":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"auto_call_recording_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}},"call_overflow":{"type":"object","properties":{"call_overflow_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"call_park":{"type":"object","properties":{"call_not_picked_up_action":{"type":"number"},"enable":{"type":"boolean"},"expiration_period":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7},{"type":"number","const":8},{"type":"number","const":9},{"type":"number","const":10},{"type":"number","const":15},{"type":"number","const":20},{"type":"number","const":25},{"type":"number","const":30},{"type":"number","const":35},{"type":"number","const":40},{"type":"number","const":45},{"type":"number","const":50},{"type":"number","const":55},{"type":"number","const":60}]},"forward_to":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"extension_type":{"anyOf":[{"type":"string","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},{"type":"string"}]},"id":{"type":"string"}},"additionalProperties":{}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"call_transferring":{"type":"object","properties":{"call_transferring_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"delegation":{"type":"boolean"},"elevate_to_meeting":{"type":"boolean"},"emergency_address_management":{"type":"object","properties":{"enable":{"type":"boolean"},"prompt_default_address":{"type":"boolean"}},"additionalProperties":{}},"emergency_calls_to_psap":{"type":"boolean"},"forwarding_to_external_numbers":{"type":"boolean"},"call_handling_forwarding_to_other_users":{"type":"object","properties":{"enable":{"type":"boolean"},"call_forwarding_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4}]},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"hand_off_to_room":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"international_calling":{"type":"boolean"},"mobile_switch_to_carrier":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"select_outbound_caller_id":{"type":"object","properties":{"enable":{"type":"boolean"},"allow_hide_outbound_caller_id":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"sms":{"type":"object","properties":{"enable":{"type":"boolean"},"international_sms":{"type":"boolean"},"international_sms_countries":{"maxItems":100,"type":"array","items":{"type":"string"}},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"allow_copy":{"type":"boolean"},"allow_paste":{"type":"boolean"}},"additionalProperties":{}},"voicemail":{"type":"object","properties":{"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_transcription":{"type":"boolean"},"allow_videomail":{"type":"boolean"},"enable":{"type":"boolean"}},"additionalProperties":{}},"voicemail_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"},"allow_sharing":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}},"zoom_phone_on_mobile":{"type":"object","properties":{"allow_calling_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["ios","android","intune","blackberry"]},{"type":"string"}]}},"allow_sms_mms_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["ios","android","intune","blackberry"]},{"type":"string"}]}},"allow_calling_sms_mms":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"personal_audio_library":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"},"allow_music_on_hold_customization":{"type":"boolean"},"allow_voicemail_and_message_greeting_customization":{"type":"boolean"}},"additionalProperties":{}},"voicemail_transcription":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_notification_by_email":{"type":"object","properties":{"include_voicemail_file":{"type":"boolean"},"include_voicemail_transcription":{"type":"boolean"},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"shared_voicemail_notification_by_email":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"check_voicemails_over_phone":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"audio_intercom":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"peer_to_peer_media":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"e2e_encryption":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"outbound_calling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"modified":{"type":"boolean"}},"additionalProperties":{}},"outbound_sms":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"modified":{"type":"boolean"}},"additionalProperties":{}},"allow_end_user_edit_call_handling":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_intent_based_prioritization":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}},"voicemail_tasks":{"type":"object","properties":{"enable":{"type":"boolean"},"locked":{"type":"boolean"},"modified":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["account","user_group","site"]},{"type":"string"}]}},"additionalProperties":{}},"zoom_phone_on_desktop":{"type":"object","properties":{"allow_calling_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["mac_os","windows","vdi_client","linux"]},{"type":"string"}]}},"allow_sms_mms_clients":{"type":"array","items":{"anyOf":[{"type":"string","enum":["mac_os","windows","vdi_client","linux"]},{"type":"string"}]}},"enable":{"type":"boolean"},"locked":{"type":"boolean"},"locked_by":{"anyOf":[{"type":"string","enum":["invalid","account","site"]},{"type":"string"}]},"modified":{"type":"boolean"}},"additionalProperties":{}}},"additionalProperties":{}},"site_admin":{"type":"boolean"},"site_id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["activate","deactivate"]},{"type":"string"}]}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/settings":{"get":{"operationId":"zoom-phone.phone_user_settings","description":"Get a user's profile settings","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address. Use 'me' for authenticated user."},"required":true,"description":"The user ID or email address. Use 'me' for authenticated user."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"area_code":{"type":"string"},"audio_prompt_language":{"type":"string"},"company_number":{"type":"string"},"country":{"type":"object","properties":{"code":{"type":"string"},"country_code":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}},"delegation":{"type":"object","properties":{"assistants":{"maxItems":15,"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string"},"extension_id":{"type":"string"},"extension_number":{"type":"number"},"extension_type":{"type":"string"},"id":{"type":"string"}},"additionalProperties":{}}},"privacy":{"type":"boolean"},"privileges":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":6},{"type":"number","const":7}]},"locked":{"type":"boolean"}},"additionalProperties":{}},"desk_phone":{"type":"object","properties":{"devices":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"device_type":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"policy":{"type":"object","properties":{"call_control":{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["unsupported","on","off"]},{"type":"string"}]}},"additionalProperties":{}},"hot_desking":{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["unsupported","on","off"]},{"type":"string"}]}},"additionalProperties":{}}},"additionalProperties":{}},"status":{"anyOf":[{"type":"string","enum":["online","offline"]},{"type":"string"}]},"mac_address":{"type":"string"},"private_ip":{"type":"string"},"public_ip":{"type":"string"}},"additionalProperties":{}}},"keys_positions":{"type":"object","properties":{"primary_number":{"type":"string"}},"additionalProperties":{}},"phone_screen_lock":{"type":"boolean"},"pin_code":{"type":"string"}},"additionalProperties":{}},"extension_number":{"type":"number"},"music_on_hold_id":{"type":"string"},"outbound_caller":{"type":"object","properties":{"number":{"type":"string"}},"additionalProperties":{}},"outbound_caller_ids":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"is_default":{"type":"boolean"},"name":{"type":"string"},"number":{"type":"string"}},"additionalProperties":{}}},"status":{"anyOf":[{"type":"string","enum":["Active","Inactive"]},{"type":"string"}]},"voice_mail":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"access_user_id":{"type":"string"},"access_user_type":{"anyOf":[{"type":"string","enum":["commonArea","user"]},{"type":"string"}]},"delete":{"type":"boolean"},"download":{"type":"boolean"},"shared_id":{"type":"string"}},"additionalProperties":{}}},"intercom":{"type":"object","properties":{"audio_intercoms":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"extension_id":{"type":"string"},"extension_number":{"type":"string"},"extension_type":{"type":"string"},"display_name":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["active","pending"]},{"type":"string"}]},"device_id":{"type":"string"},"device_status":{"anyOf":[{"type":"string","enum":["online","offline","no device"]},{"type":"string"}]}},"additionalProperties":{}}},"device":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{}},"auto_call_recording_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}},"ad_hoc_call_recording_access_members":{"maxItems":50,"type":"array","items":{"allOf":[{"type":"object","properties":{"access_user_id":{"type":"string"},"allow_delete":{"type":"boolean"},"allow_download":{"type":"boolean"}},"additionalProperties":{}},{"type":"object","properties":{"shared_id":{"type":"string"}},"additionalProperties":{}}]}},"shared_lines_call_setting":{"type":"object","properties":{"shared_line_appearances":{"type":"object","properties":{"executives":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"display_name":{"type":"string"},"receive_calls":{"type":"boolean"},"allow_opt_out":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}},"shared_line_groups":{"type":"object","properties":{"receive_calls":{"type":"boolean"},"shared_line_group":{"type":"array","items":{"type":"object","properties":{"slg_id":{"type":"string"},"display_name":{"type":"string"},"receive_calls":{"type":"boolean"}},"additionalProperties":{}}}},"additionalProperties":{}}},"additionalProperties":{}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/call-logs/{callId}/voicemails":{"get":{"operationId":"zoom-phone.get_voicemail_details_by_call_id_or_call_log_id","description":"Get user voicemail details from a call log","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address of the user."},"required":true,"description":"The user ID or email address of the user."},{"in":"path","name":"id","schema":{"type":"string","description":"The unique ID of the call log (callLogId or callId)."},"required":true,"description":"The unique ID of the call log (callLogId or callId)."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_history_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"date_time":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"transcription":{"type":"object","properties":{"content":{"type":"string"},"status":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":9},{"type":"number","const":11},{"type":"number","const":12},{"type":"number","const":13},{"type":"number","const":14},{"type":"number","const":409},{"type":"number","const":415},{"type":"number","const":422},{"type":"number","const":500},{"type":"number","const":601},{"type":"number","const":602},{"type":"number","const":603},{"type":"number","const":999}]},"engine":{"type":"string"}},"additionalProperties":{}},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/users/{userId}/voicemails":{"get":{"operationId":"zoom-phone.phone_user_voice_mails","description":"Get user's voicemails","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string","description":"The user ID or email address. Use 'me' for authenticated user."},"required":true,"description":"The user ID or email address. Use 'me' for authenticated user."},{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"status","schema":{"description":"The status of the voice mail.","type":"string","enum":["all","read","unread"]}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through large result sets.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"trash","schema":{"description":"Whether to query voicemails from trash.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string"},"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_size":{"type":"number"},"to":{"type":"string"},"total_records":{"type":"number"},"voice_mails":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_history_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"date_time":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/voicemails":{"get":{"operationId":"zoom-phone.account_voice_mails","description":"Get account voicemails","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"query","name":"page_size","schema":{"description":"The number of records returned within a single API call.","type":"number"}},{"in":"query","name":"status","schema":{"description":"The status of the voice mail.","type":"string","enum":["all","read","unread"]}},{"in":"query","name":"site_id","schema":{"description":"The site ID.","type":"string"}},{"in":"query","name":"owner_type","schema":{"description":"The owner type.","type":"string","enum":["user","callQueue","sharedLineGroup","autoReceptionist","commonArea"]}},{"in":"query","name":"voicemail_type","schema":{"description":"The voicemail type.","type":"string","enum":["normal","spam","maybeSpam"]}},{"in":"query","name":"next_page_token","schema":{"description":"The next page token paginates through a large set of results.","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"to","schema":{"description":"End time and date in yyyy-mm-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format.","type":"string"}},{"in":"query","name":"trashed","schema":{"description":"Whether to query voicemails from trash. Default: false.","type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string"},"next_page_token":{"type":"string"},"page_count":{"type":"number"},"page_size":{"type":"number"},"to":{"type":"string"},"total_records":{"type":"number"},"voice_mails":{"type":"array","items":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"date_time":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"owner":{"type":"object","properties":{"extension_number":{"type":"number"},"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["user","callQueue","sharedLineGroup","autoReceptionist","commonArea"]},{"type":"string"}]},"extension_status":{"anyOf":[{"type":"string","enum":["inactive","deleted"]},{"type":"string"}]},"extension_deleted_time":{"type":"string"}},"additionalProperties":{}},"deleted_time":{"type":"string"},"days_left_auto_permantely_delete":{"type":"number"},"soft_deleted_type":{"anyOf":[{"type":"string","enum":["Manual","Data Retention"]},{"type":"string"}]},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/voicemails/{voicemailId}/download":{"get":{"operationId":"zoom-phone.phone_download_voicemail_file","description":"Download a phone voicemail","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"fileId","schema":{"type":"string","description":"The file ID of the phone voicemail."},"required":true,"description":"The file ID of the phone voicemail."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}},"/api/v1/zoom-phone/voicemails/{voicemailId}":{"get":{"operationId":"zoom-phone.get_voicemail_details","description":"Get voicemail details","tags":["zoom-phone"],"security":[{"oauth2":[]},{"bearerApiKey":[]}],"parameters":[{"in":"path","name":"voicemailId","schema":{"type":"string","description":"The unique identifier of the voicemail."},"required":true,"description":"The unique identifier of the voicemail."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"call_id":{"type":"string"},"call_log_id":{"type":"string"},"call_history_id":{"type":"string"},"call_element_id":{"type":"string"},"callee_name":{"type":"string"},"callee_number":{"type":"string"},"callee_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":3}]},"caller_name":{"type":"string"},"caller_number":{"type":"string"},"caller_number_type":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"date_time":{"type":"string"},"download_url":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["read","unread"]},{"type":"string"}]},"transcription":{"type":"object","properties":{"content":{"type":"string"},"status":{"anyOf":[{"type":"number","const":0},{"type":"number","const":1},{"type":"number","const":2},{"type":"number","const":4},{"type":"number","const":5},{"type":"number","const":9},{"type":"number","const":11},{"type":"number","const":12},{"type":"number","const":13},{"type":"number","const":14},{"type":"number","const":409},{"type":"number","const":415},{"type":"number","const":422},{"type":"number","const":500},{"type":"number","const":601},{"type":"number","const":602},{"type":"number","const":603},{"type":"number","const":999}]},"engine":{"type":"string"}},"additionalProperties":{}},"deleted_time":{"type":"string"},"days_left_auto_permantely_delete":{"type":"number"},"soft_deleted_type":{"anyOf":[{"type":"string","enum":["Manual","Data Retention"]},{"type":"string"}]},"intent_detect_status":{"anyOf":[{"type":"string","enum":["not_started","processing","success","ai_detection_failed","unknown_reason_failed"]},{"type":"string"}]},"intent_results":{"type":"array","items":{"type":"object","properties":{"intent_id":{"type":"string"},"confidence_score":{"type":"number"}},"additionalProperties":{}}},"voice_mail_task":{"type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["processing","success","no_task","failure"]},{"type":"string"}]},"content":{"type":"string"},"feedback":{"anyOf":[{"type":"string","enum":["none","thumbs_up","thumbs_down"]},{"type":"string"}]}},"additionalProperties":{}},"caller_account_code":{"type":"string"},"callee_account_code":{"type":"string"}},"additionalProperties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}},"502":{"description":"Upstream error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"boolean"},"code":{"type":"string"},"message":{"type":"string"}},"required":["error","code","message"],"additionalProperties":false}}}}}}}},"webhooks":{},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}},"bearerApiKey":{"type":"http","scheme":"bearer","description":"API key authentication. Pass a Ferrule API key as a Bearer token."}}}}