{"openapi":"3.1.0","info":{"title":"Phone","description":"The Zoom Phone webhooks allow developers to receive events for [Zoom Phone](https://developers.zoom.us/docs/zoom-phone/) features.","version":"1.0.0"},"webhooks":{"phone.recording_deleted":{"post":{"tags":["phone"],"operationId":"phone.recording_deleted","requestBody":{"description":"# phone.recording_deleted\n\nThe **Call recording has been deleted** event triggers when a recording has been deleted.\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording has been deleted** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account to which the recording belongs."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The recording ID."},"call_id":{"type":"string","description":"The call ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account to which the recording belongs."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The recording ID."},"call_id":{"type":"string","description":"The call ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}}}}},"phone.caller_call_log_completed":{"post":{"tags":["phone"],"operationId":"phone.caller_call_log_completed","requestBody":{"description":"# phone.caller_call_log_completed\n---\nThe **Caller call log is completed** event triggers every time the outgoing call log record for a call is made available for the Caller to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Caller call log is completed\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.caller_call_log_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_log_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"User Id of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_type","caller_number","caller_number_type","callee_number","callee_number_type","result","has_voicemail","call_id","date_time","path"],"properties":{"id":{"type":"string","description":"Unique Identifier of the call log."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"caller_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when caller_number_type = 1."},"caller_name":{"type":"string","description":"Name of the caller."},"caller_location":{"type":"string","description":"Location of the caller."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"caller_country_code":{"type":"string","description":"Caller's country code."},"caller_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2,3],"description":"The callee's phone number type:\n* 1 — extension number.\n* 2 — phone number.\n* 3 — Customized emergency number."},"callee_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when callee_number_type = 1."},"callee_name":{"type":"string","description":"Name of the callee."},"callee_location":{"type":"string","description":"Location of the callee."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_country_code":{"type":"string","description":"Callee's country code."},"callee_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"duration":{"type":"integer","description":"Duration of the call."},"result":{"type":"string","description":"Status of the call."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"path":{"type":"string","description":"Path of the call log."},"site":{"type":"object","properties":{"id":{"type":"string","description":"The phone number's assigned target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). Sites allow you to organize the phone users in your organization. For example, sites created and based on different office locations."}}},"has_recording":{"type":"boolean","description":"Indicates whether the call log includes recording or not."},"recording_id":{"type":"string","description":"ID of this recording."},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"has_voicemail":{"type":"boolean","description":"Indicates whether the call log includes voicemail or not."},"call_id":{"type":"string","description":"Unique identifier of the call."},"client_code":{"type":"string","description":"Client code."},"call_type":{"type":"string","description":"The type of call:\n* voip (Voice over IP)\n* pstn (Public Switched Telephone Network)\n* tollfree\n* international\n* contactCenter","enum":["voip","pstn","tollfree","international","contactCenter"]},"call_end_time":{"type":"string","format":"date-time","description":"End time of the call."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"forwarded_to":{"description":"Indicates who the call was forwarded to.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup","pstn"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"forwarded_by":{"description":"Indicates where the call was forwarded from.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"hold_time":{"description":"Hold time during a call in seconds.","type":"integer"},"department":{"description":"Department name.","type":"string"},"cost_center":{"description":"Cost center name.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_log_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"4a4ed8ec-6be4-4e42-96e6-352a4396204d\",\n          \"call_type\": \"voip\",\n          \"caller_number\": \"1045\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"usersubsetting0001@testapi.com\",\n          \"callee_number\": \"1026\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"ZOOM_API Test\",\n          \"caller_did_number\" : \"+12055967465\",\n          \"caller_country_code\" : \"1\",\n          \"caller_country_iso_code\" : \"US\",\n          \"callee_did_number\" : \"+15104381494\",\n          \"callee_country_code\" : \"1\",\n          \"callee_country_iso_code\" : \"US\",\n          \"direction\": \"inbound\",\n          \"duration\": 0,\n          \"result\": \"outbound\",\n          \"date_time\": \"2021-06-09T05:55:07Z\",\n          \"path\": \"extension\",\n          \"has_recording\": false,\n          \"has_voicemail\": false,\n          \"call_id\": \"6971668473388011511\",\n          \"client_code\" : \"741\",\n          \"call_end_time\": \"2021-06-09T05:55:12Z\",\n          \"forwarded_by\" : {\n            \"extension_number\" : \"820004\",\n            \"name\" : \"SLG Test\",\n            \"extension_type\" : \"sharedLineGroup\"\n          }\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_log_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"User Id of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_type","caller_number","caller_number_type","callee_number","callee_number_type","result","has_voicemail","call_id","date_time","path"],"properties":{"id":{"type":"string","description":"Unique Identifier of the call log."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"caller_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when caller_number_type = 1."},"caller_name":{"type":"string","description":"Name of the caller."},"caller_location":{"type":"string","description":"Location of the caller."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"caller_country_code":{"type":"string","description":"Caller's country code."},"caller_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2,3],"description":"The callee's phone number type:\n* 1 — extension number.\n* 2 — phone number.\n* 3 — Customized emergency number."},"callee_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when callee_number_type = 1."},"callee_name":{"type":"string","description":"Name of the callee."},"callee_location":{"type":"string","description":"Location of the callee."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_country_code":{"type":"string","description":"Callee's country code."},"callee_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"duration":{"type":"integer","description":"Duration of the call."},"result":{"type":"string","description":"Status of the call."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"path":{"type":"string","description":"Path of the call log."},"site":{"type":"object","properties":{"id":{"type":"string","description":"The phone number's assigned target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). Sites allow you to organize the phone users in your organization. For example, sites created and based on different office locations."}}},"has_recording":{"type":"boolean","description":"Indicates whether the call log includes recording or not."},"recording_id":{"type":"string","description":"ID of this recording."},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"has_voicemail":{"type":"boolean","description":"Indicates whether the call log includes voicemail or not."},"call_id":{"type":"string","description":"Unique identifier of the call."},"client_code":{"type":"string","description":"Client code."},"call_type":{"type":"string","description":"The type of call:\n* voip (Voice over IP)\n* pstn (Public Switched Telephone Network)\n* tollfree\n* international\n* contactCenter","enum":["voip","pstn","tollfree","international","contactCenter"]},"call_end_time":{"type":"string","format":"date-time","description":"End time of the call."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"forwarded_to":{"description":"Indicates who the call was forwarded to.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup","pstn"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"forwarded_by":{"description":"Indicates where the call was forwarded from.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"hold_time":{"description":"Hold time during a call in seconds.","type":"integer"},"department":{"description":"Department name.","type":"string"},"cost_center":{"description":"Cost center name.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_log_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"4a4ed8ec-6be4-4e42-96e6-352a4396204d\",\n          \"call_type\": \"voip\",\n          \"caller_number\": \"1045\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"usersubsetting0001@testapi.com\",\n          \"callee_number\": \"1026\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"ZOOM_API Test\",\n          \"caller_did_number\" : \"+12055967465\",\n          \"caller_country_code\" : \"1\",\n          \"caller_country_iso_code\" : \"US\",\n          \"callee_did_number\" : \"+15104381494\",\n          \"callee_country_code\" : \"1\",\n          \"callee_country_iso_code\" : \"US\",\n          \"direction\": \"inbound\",\n          \"duration\": 0,\n          \"result\": \"outbound\",\n          \"date_time\": \"2021-06-09T05:55:07Z\",\n          \"path\": \"extension\",\n          \"has_recording\": false,\n          \"has_voicemail\": false,\n          \"call_id\": \"6971668473388011511\",\n          \"client_code\" : \"741\",\n          \"call_end_time\": \"2021-06-09T05:55:12Z\",\n          \"forwarded_by\" : {\n            \"extension_number\" : \"820004\",\n            \"name\" : \"SLG Test\",\n            \"extension_type\" : \"sharedLineGroup\"\n          }\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.recording_completed_for_access_member":{"post":{"tags":["phone"],"operationId":"phone.recording_completed_for_access_member","requestBody":{"description":"# phone.recording_completed_for_access_member\n---\n\nThe **Call recording is completed for access member** event triggers when a recording of a Zoom phone call completes. The access members of the recording owner will receive this event.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording is completed for access member** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_completed_for_access_member`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_completed_for_access_member"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","duration","download_url","date_time"],"properties":{"id":{"type":"string","description":"The recording ID is the unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"The name of the caller."},"caller_did_number":{"type":"string","description":"The caller's DID number."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number."},"duration":{"type":"integer","description":"The duration of the call in seconds."},"download_url":{"type":"string","description":"The URL to download the call recording.\n\nTo download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below:\n\nhttps://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"user_id":{"type":"string","description":"The unique identifier of the user."},"call_id":{"type":"string","description":"The unique identifier of the call."},"call_log_id":{"type":"string","description":"The call log id."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"The recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"The site of the call.","properties":{"id":{"type":"string","description":"The site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"The owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner type. This value field can be user or callQueue."},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"The owner name."},"extension_number":{"description":"The extension number of the owner","type":"integer"},"has_access_permission":{"type":"boolean","description":"Whether the owner has the access permission to this recording."}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"The user name.","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"The user extension number.","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_completed_for_access_member\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"AAAAAABBBB\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"abcD3ojfdbjfg\",\n          \"user_id\": \"w0RChiauQeqRlv5fgxYULQ\",\n          \"caller_number\": \"1026\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"Caller Name\",\n          \"caller_did_number\": \"+12055967465\",\n          \"callee_number\": \"1045\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"Callee Name\",\n          \"callee_did_number\": \"+15104381494\",\n          \"duration\": 43,\n          \"download_url\": \"https://some.url.com\",\n          \"direction\": \"outbound\",\n          \"date_time\": \"2021-06-09T06:09:24Z\",\n          \"recording_type\": \"OnDemand\",\n          \"call_id\": \"6971672158469969953\",\n          \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"call_history_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"end_time\": \"2021-06-09T06:10:07Z\",\n          \"site\": {\n            \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n          },\n          \"owner\": {\n            \"type\": \"user\",\n            \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"name\": \"usersubsetting0001\",\n            \"extension_number\": 6666,\n            \"has_access_permission\": true\n          }\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_completed_for_access_member"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","duration","download_url","date_time"],"properties":{"id":{"type":"string","description":"The recording ID is the unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"The name of the caller."},"caller_did_number":{"type":"string","description":"The caller's DID number."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number."},"duration":{"type":"integer","description":"The duration of the call in seconds."},"download_url":{"type":"string","description":"The URL to download the call recording.\n\nTo download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below:\n\nhttps://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"user_id":{"type":"string","description":"The unique identifier of the user."},"call_id":{"type":"string","description":"The unique identifier of the call."},"call_log_id":{"type":"string","description":"The call log id."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"The recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"The site of the call.","properties":{"id":{"type":"string","description":"The site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"The owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner type. This value field can be user or callQueue."},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"The owner name."},"extension_number":{"description":"The extension number of the owner","type":"integer"},"has_access_permission":{"type":"boolean","description":"Whether the owner has the access permission to this recording."}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"The user name.","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"The user extension number.","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_completed_for_access_member\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"AAAAAABBBB\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"abcD3ojfdbjfg\",\n          \"user_id\": \"w0RChiauQeqRlv5fgxYULQ\",\n          \"caller_number\": \"1026\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"Caller Name\",\n          \"caller_did_number\": \"+12055967465\",\n          \"callee_number\": \"1045\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"Callee Name\",\n          \"callee_did_number\": \"+15104381494\",\n          \"duration\": 43,\n          \"download_url\": \"https://some.url.com\",\n          \"direction\": \"outbound\",\n          \"date_time\": \"2021-06-09T06:09:24Z\",\n          \"recording_type\": \"OnDemand\",\n          \"call_id\": \"6971672158469969953\",\n          \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"call_history_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n          \"end_time\": \"2021-06-09T06:10:07Z\",\n          \"site\": {\n            \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n          },\n          \"owner\": {\n            \"type\": \"user\",\n            \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"name\": \"usersubsetting0001\",\n            \"extension_number\": 6666,\n            \"has_access_permission\": true\n          }\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.recording_resumed":{"post":{"tags":["phone"],"operationId":"phone.recording_resumed","requestBody":{"description":"# phone.recording_resumed\n---\nThe **Call recording has resumed** event triggers when the owner resumes the recording during a phone call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording has resumed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_resumed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","owner"],"properties":{"id":{"type":"string","description":"The recording ID."},"user_id":{"type":"string","description":"The user ID."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or the extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or the extension number of the callee."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call: inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"The time and date when the recording has resumed."},"recording_type":{"type":"string","description":"The type of the recording: OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name","extension_number"],"properties":{"type":{"type":"string","description":"The owner type: user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"Display name of the owner."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_resumed\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","owner"],"properties":{"id":{"type":"string","description":"The recording ID."},"user_id":{"type":"string","description":"The user ID."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or the extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or the extension number of the callee."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call: inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"The time and date when the recording has resumed."},"recording_type":{"type":"string","description":"The type of the recording: OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name","extension_number"],"properties":{"type":{"type":"string","description":"The owner type: user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"Display name of the owner."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_resumed\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}}}}},"phone.fax_log_deleted":{"post":{"tags":["phone"],"operationId":"phone.fax_log_deleted","requestBody":{"description":"# phone.fax_log_deleted\n---\nThe **Fax Log Deleted** event triggers when one or more fax logs are deleted from a Zoom Phone account.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Fax Log Deleted** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone:write`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin`,`phone:read:list_fax_log:master`\n\n**Event type**: `phone.fax_log_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_log_deleted"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_logs"],"description":"object","properties":{"fax_logs":{"type":"array","description":"The deleted fax logs information.","items":{"type":"object","required":["fax_log_id"],"properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_log_deleted\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_logs\": [\n        {\n          \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\"\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_log_deleted"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_logs"],"description":"object","properties":{"fax_logs":{"type":"array","description":"The deleted fax logs information.","items":{"type":"object","required":["fax_log_id"],"properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_log_deleted\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_logs\": [\n        {\n          \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\"\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.fax_log_permanently_deleted":{"post":{"tags":["phone"],"operationId":"phone.fax_log_permanently_deleted","requestBody":{"description":"# phone.fax_log_permanently_deleted\n---\nThe **Fax Log Permanently Deleted** event triggers when one or more fax logs are permanently deleted from a Zoom Phone account.\n\nThis event occurs when fax logs are removed permanently, typically after being deleted from the trash or recycle bin.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Fax Log Permanently Deleted** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone:write`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin`,`phone:read:list_fax_log:master`\n\n**Event type**: `phone.fax_log_permanently_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_log_permanently_deleted"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_logs"],"description":"object","properties":{"fax_logs":{"type":"array","description":"The list of permanently deleted fax logs.","items":{"type":"object","required":["fax_log_id"],"properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_log_permanently_deleted\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_logs\": [\n        {\n          \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\"\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_log_permanently_deleted"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_logs"],"description":"object","properties":{"fax_logs":{"type":"array","description":"The list of permanently deleted fax logs.","items":{"type":"object","required":["fax_log_id"],"properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_log_permanently_deleted\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_logs\": [\n        {\n          \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\"\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.transfer_recipient_updated":{"post":{"tags":["phone"],"operationId":"phone.transfer_recipient_updated","requestBody":{"description":"# phone.transfer_recipient_updated\n---\n\nThe **Recipient of warm/blind transfer call updated** event triggers when the recipient of warm/blind transfer call is updated, to inform that the call connector has changed.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Recipient of warm/blind transfer call updated\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.transfer_recipient_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in int64 format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","recipient","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the recipient update for the warm/blind transfer call failed. An empty string indicates success."},"call_id":{"type":"string","description":"The unique identifier for the call."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","format":"int64","example":"1001019"},"id":{"description":"The unique identifier for the owner.","type":"string","example":"z8yCxjabcdEFGHfp8uQ"},"name":{"description":"The name of the owner.","type":"string","example":"Tom Jones"},"type":{"description":"The extension type of the owner.","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"],"type":"string","example":"user"}},"description":"The owner of this event.","type":"object"},"recipient":{"properties":{"extension_number":{"description":"The recipient's extension number.","type":"integer","format":"int64","example":"1001020"},"phone_number":{"description":"The phone number of the recipient in E164 format.","type":"string","example":"+12192818492"},"name":{"description":"The name of the recipient.","type":"string","example":"Jane Smith"},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}},"description":"The recipient who received the warm/blind transfer call from the event owner.","type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the recipient of the warm/blind transfer call was updated, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.transfer_recipient_updated\",\n  \"event_ts\": 1712558722775,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"Tom Jones\",\n        \"extension_number\": 1001019\n      },\n      \"recipient\": {\n        \"extension_number\": 1001020,\n        \"phone_number\": \"+12192818492\",\n        \"name\": \"Jane Smith\",\n        \"connection_type\": \"pstn_on_net\"\n      },\n      \"date_time\": \"2024-04-08T14:45:22Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in int64 format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","recipient","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the recipient update for the warm/blind transfer call failed. An empty string indicates success."},"call_id":{"type":"string","description":"The unique identifier for the call."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","format":"int64","example":"1001019"},"id":{"description":"The unique identifier for the owner.","type":"string","example":"z8yCxjabcdEFGHfp8uQ"},"name":{"description":"The name of the owner.","type":"string","example":"Tom Jones"},"type":{"description":"The extension type of the owner.","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"],"type":"string","example":"user"}},"description":"The owner of this event.","type":"object"},"recipient":{"properties":{"extension_number":{"description":"The recipient's extension number.","type":"integer","format":"int64","example":"1001020"},"phone_number":{"description":"The phone number of the recipient in E164 format.","type":"string","example":"+12192818492"},"name":{"description":"The name of the recipient.","type":"string","example":"Jane Smith"},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}},"description":"The recipient who received the warm/blind transfer call from the event owner.","type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the recipient of the warm/blind transfer call was updated, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.transfer_recipient_updated\",\n  \"event_ts\": 1712558722775,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"Tom Jones\",\n        \"extension_number\": 1001019\n      },\n      \"recipient\": {\n        \"extension_number\": 1001020,\n        \"phone_number\": \"+12192818492\",\n        \"name\": \"Jane Smith\",\n        \"connection_type\": \"pstn_on_net\"\n      },\n      \"date_time\": \"2024-04-08T14:45:22Z\"\n    }\n  }\n}"}}}}}}}},"phone.recording_transcript_completed":{"post":{"tags":["phone"],"operationId":"phone.recording_transcript_completed","requestBody":{"description":"# phone.recording_transcript_completed\n---\n\nThe **Call recording transcription is complete** event triggers when a transcription of a call recording has completed.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Call recording transcription is complete\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:recording_transcript:master`,`phone:read:recording_transcript`,`phone:read:recording_transcript:admin`\n\n**Event type**: `phone.recording_transcript_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_transcript_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","transcript_download_url","date_time"],"properties":{"id":{"type":"string","description":"Recording ID: Unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"Name of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"Name of the callee."},"duration":{"type":"integer","description":"Duration of the call in seconds."},"transcript_download_url":{"type":"string","description":"URL using which the call recording transcript can be downloaded.\n\nTo download the recording transcript via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording_transcript/download/abcD666T”, the complete URL path to download the recording trancsript will be as below:\n\nhttps://zoom.us/v2/phone/recording_transcript/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"user_id":{"type":"string","description":"Unique identifier of the user."},"call_id":{"type":"string","description":"Unique identifier of the call."},"call_log_id":{"type":"string","description":"Call log id."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"Site of the call.","required":["id"],"properties":{"id":{"type":"string","description":"Site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"Owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Owner type. This value field can be user or callQueue."},"id":{"type":"string","description":"Owner id."},"name":{"type":"string","description":"Owner name."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"User extension number","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"User extension number","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_transcript_completed\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\t\t\"object\": {\n          \"recordings\": [{\n                \"id\": \"abcD3ojfdbjfg\",\n                \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n                \"caller_number\": \"1026\",\n                \"caller_number_type\": 1,\n                \"caller_name\": \"Caller Name\",\n                \"callee_number\": \"1045\",\n                \"callee_number_type\": 1,\n                \"callee_name\": \"Callee Name\",\n                \"duration\": 43,\n                \"transcript_download_url\": \"https://some.url.com\",\n                \"direction\": \"outbound\",\n                \"date_time\": \"2021-06-09T06:09:24Z\",\n                \"recording_type\": \"OnDemand\",\n                \"call_id\": \"6971672158469969953\",\n                \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                \"end_time\": \"2021-06-09T06:10:07Z\",\n                \"site\": {\n                    \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n                },\n                \"owner\" : {\n                    \"type\" : \"user\",\n                    \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                    \"name\" : \"usersubsetting0001\",\n                    \"extension_number\": 6666\n                }\n          }]\n\t\t}\n\t}\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_transcript_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","transcript_download_url","date_time"],"properties":{"id":{"type":"string","description":"Recording ID: Unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"Name of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"Name of the callee."},"duration":{"type":"integer","description":"Duration of the call in seconds."},"transcript_download_url":{"type":"string","description":"URL using which the call recording transcript can be downloaded.\n\nTo download the recording transcript via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording_transcript/download/abcD666T”, the complete URL path to download the recording trancsript will be as below:\n\nhttps://zoom.us/v2/phone/recording_transcript/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"user_id":{"type":"string","description":"Unique identifier of the user."},"call_id":{"type":"string","description":"Unique identifier of the call."},"call_log_id":{"type":"string","description":"Call log id."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"Site of the call.","required":["id"],"properties":{"id":{"type":"string","description":"Site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"Owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Owner type. This value field can be user or callQueue."},"id":{"type":"string","description":"Owner id."},"name":{"type":"string","description":"Owner name."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"User extension number","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"User name","type":"string"},"extension_number":{"description":"User extension number","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_transcript_completed\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\t\t\"object\": {\n          \"recordings\": [{\n                \"id\": \"abcD3ojfdbjfg\",\n                \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n                \"caller_number\": \"1026\",\n                \"caller_number_type\": 1,\n                \"caller_name\": \"Caller Name\",\n                \"callee_number\": \"1045\",\n                \"callee_number_type\": 1,\n                \"callee_name\": \"Callee Name\",\n                \"duration\": 43,\n                \"transcript_download_url\": \"https://some.url.com\",\n                \"direction\": \"outbound\",\n                \"date_time\": \"2021-06-09T06:09:24Z\",\n                \"recording_type\": \"OnDemand\",\n                \"call_id\": \"6971672158469969953\",\n                \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                \"end_time\": \"2021-06-09T06:10:07Z\",\n                \"site\": {\n                    \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n                },\n                \"owner\" : {\n                    \"type\" : \"user\",\n                    \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                    \"name\" : \"usersubsetting0001\",\n                    \"extension_number\": 6666\n                }\n          }]\n\t\t}\n\t}\n}"}}}}}}}},"phone.call_log_permanently_deleted":{"post":{"tags":["phone"],"operationId":"phone.call_log_permanently_deleted","requestBody":{"description":"# phone.call_log_permanently_deleted\n---\nThe **Call log has been permanently deleted** event triggers each time a call log is permanently deleted from the trash.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Call log has been permanently deleted\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.call_log_permanently_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_log_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The unique identifier of the call log."},"call_id":{"type":"string","description":"The unique identifier of the call."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_log_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\"\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_log_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The unique identifier of the call log."},"call_id":{"type":"string","description":"The unique identifier of the call."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_log_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\"\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}}}}},"phone.transfer_call_to_voicemail_initiated":{"post":{"tags":["phone"],"operationId":"phone.transfer_call_to_voicemail_initiated","requestBody":{"description":"# phone.transfer_call_to_voicemail_initiated\n---\n\nThe **Transfer call to voicemail initiated** event triggers when a call begins transferring to voicemail.\n\n## Prerequisites\n* [Zoom Phone plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Transfer call to voicemail is initiated\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.transfer_call_to_voicemail_initiated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event.","enum":["phone.transfer_call_to_voicemail_initiated"]},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for transfer call to voicemail. If it is an empty string, it means success."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the transfer call to voicemail. It may be the user's phone number, extension number or the user's phone number that displays in E164 format."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) at which the transfer call to voicemail was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.transfer_call_to_voicemail_initiated\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event.","enum":["phone.transfer_call_to_voicemail_initiated"]},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for transfer call to voicemail. If it is an empty string, it means success."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the transfer call to voicemail. It may be the user's phone number, extension number or the user's phone number that displays in E164 format."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) at which the transfer call to voicemail was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.transfer_call_to_voicemail_initiated\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.callee_missed":{"post":{"tags":["phone"],"operationId":"phone.callee_missed","requestBody":{"description":"# phone.callee_missed\n---\nThe **Callee missed a phone call** event triggers every time a callee misses a phone call.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Callee missed a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_missed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492\n\nNote: phone_number and extension_number can't be empty at the same time."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The GMT time at which the call was ended, in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}},"handup_result":{"type":"string","description":"The reason the call was missed. Values: No Answer | Busy | Call Cancel"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_missed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252731812285292\",\n      \"channel_id\": \"768efc81-4d27-4d05-ac27-768579b090d4\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:15:29Z\",\n      \"call_end_time\": \"2021-08-19T21:15:42Z\"\n    }\n  },\n  \"event_ts\": 1629407755259\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492\n\nNote: phone_number and extension_number can't be empty at the same time."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The GMT time at which the call was ended, in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}},"handup_result":{"type":"string","description":"The reason the call was missed. Values: No Answer | Busy | Call Cancel"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_missed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252731812285292\",\n      \"channel_id\": \"768efc81-4d27-4d05-ac27-768579b090d4\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:15:29Z\",\n      \"call_end_time\": \"2021-08-19T21:15:42Z\"\n    }\n  },\n  \"event_ts\": 1629407755259\n}"}}}}}}}},"phone.caller_ringing":{"post":{"tags":["phone"],"operationId":"phone.caller_ringing","requestBody":{"description":"# phone.caller_ringing\n---\n\nThe **Caller hears a ringback tone** event triggers every time your account user or app user dials a call over Zoom Phone and hears a ringing tone on the phone device. To receive this notification, you must meet the prerequisites listed below.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event Notification Endpoint URL**.\n\t* **\"Caller hears a ringback tone\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_ringing`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"Unique identifier of the call."},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"Zoom User ID of the caller."},"name":{"type":"string","description":"Caller's user name."},"phone_number":{"type":"string","description":"Phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the caller."},"timezone":{"type":"string","description":"Timezone of the caller."},"device_type":{"type":"string","description":"Device type of the caller."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"Callee's user name."},"phone_number":{"type":"string","description":"Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_ringing\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"channel_id\": \"1df42be1-8420-4396-9e78-0a7ee7bc5aab\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"pstn_off_net\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"sip_id\": \"example.com\"\n    }\n  },\n  \"event_ts\": 1629334712756\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"Unique identifier of the call."},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"Zoom User ID of the caller."},"name":{"type":"string","description":"Caller's user name."},"phone_number":{"type":"string","description":"Phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the caller."},"timezone":{"type":"string","description":"Timezone of the caller."},"device_type":{"type":"string","description":"Device type of the caller."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"Callee's user name."},"phone_number":{"type":"string","description":"Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_ringing\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"channel_id\": \"1df42be1-8420-4396-9e78-0a7ee7bc5aab\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"pstn_off_net\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"sip_id\": \"example.com\"\n    }\n  },\n  \"event_ts\": 1629334712756\n}"}}}}}}}},"phone.voicemail_received":{"post":{"tags":["phone"],"operationId":"phone.voicemail_received","requestBody":{"description":"# phone.voicemail_received\n---\n\nThe **Voicemail is received** event triggers each time a callee (the person called by a caller over Zoom Phone) misses a call and receives a voicemail from the caller.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A **Voicemail is received** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:master`,`phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**Event type**: `phone.voicemail_received`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_received"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["id","date_time","download_url","duration","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name","callee_extension_type","callee_id"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"download_url":{"type":"string","format":"url","description":"The URL at which the voicemail can be downloaded."},"duration":{"type":"integer","description":"The duration of the voicemail."},"caller_user_id":{"type":"string","description":"The caller's user ID. This field will only exist if the caller is a user of this account."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"duration\": 3,\n      \"caller_user_id\": \"9Y0sGVcgRrW_9eV6kwLf7w\",\n      \"caller_name\": \"Rascoe Thomas\",\n      \"caller_did_number\": \"+12055967465\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_did_number\": \"+15104381494\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"download_url\": \"https://example.com/v2/phone/voice_mails/download/6q6cLeR8Q4WCdWGmGxCLEw\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_received\"\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_received"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["id","date_time","download_url","duration","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name","callee_extension_type","callee_id"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"download_url":{"type":"string","format":"url","description":"The URL at which the voicemail can be downloaded."},"duration":{"type":"integer","description":"The duration of the voicemail."},"caller_user_id":{"type":"string","description":"The caller's user ID. This field will only exist if the caller is a user of this account."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"duration\": 3,\n      \"caller_user_id\": \"9Y0sGVcgRrW_9eV6kwLf7w\",\n      \"caller_name\": \"Rascoe Thomas\",\n      \"caller_did_number\": \"+12055967465\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_did_number\": \"+15104381494\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"download_url\": \"https://example.com/v2/phone/voice_mails/download/6q6cLeR8Q4WCdWGmGxCLEw\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_received\"\n}"}}}}}}}},"phone.sms_sent":{"post":{"tags":["phone"],"operationId":"phone.sms_sent","requestBody":{"description":"# phone.sms_sent\n---\nThe **SMS sent from Zoom phone** event triggers when a user account sends an SMS message. The sender must either be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom phone users can send text messages [(SMS)](https://support.zoom.us/hc/en-us/articles/360054155112-Using-SMS) using the Zoom desktop client or a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n\n\n\n## **Prerequisites**\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS sent from Zoom phone** subscription enabled under the **Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message:master`,`phone:read:sms_message`,`phone:read:sms_message:admin`\n\n**Event type**: `phone.sms_sent`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_sent"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of SMS/MMS message that was sent.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason for SMS send failure. An empty field means the SMS send was successful."},"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"SMS sender's user ID."},"type":{"type":"string","description":"The type of sender:\n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's ID."},"type":{"type":"string","description":"The type of receiver:\n*user\n*callQueue\n*autoReceptionist.","enum":["user","callQueue","autoReceptionist"]},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS.","type":"object","properties":{"type":{"type":"string","description":"The owner type:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The owner ID."},"sms_sender_user_id":{"type":"string","description":"The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique Identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was sent."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+12094XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_sent\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"1101-phone message error send\",\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\",\n        \"type\": \"user\",\n        \"display_name\": \"Jackson\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"id\": \"RMIThhijkxyzyuyyi3Kfg\",\n          \"type\": \"user\",\n          \"display_name\": \"Tom\"\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\",\n        \"sms_sender_user_id\": \"JduDVJJXTS6VGXiJiro7ZQ\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_sent"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of SMS/MMS message that was sent.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason for SMS send failure. An empty field means the SMS send was successful."},"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"SMS sender's user ID."},"type":{"type":"string","description":"The type of sender:\n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's ID."},"type":{"type":"string","description":"The type of receiver:\n*user\n*callQueue\n*autoReceptionist.","enum":["user","callQueue","autoReceptionist"]},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS.","type":"object","properties":{"type":{"type":"string","description":"The owner type:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The owner ID."},"sms_sender_user_id":{"type":"string","description":"The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique Identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was sent."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+12094XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_sent\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"1101-phone message error send\",\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\",\n        \"type\": \"user\",\n        \"display_name\": \"Jackson\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"id\": \"RMIThhijkxyzyuyyi3Kfg\",\n          \"type\": \"user\",\n          \"display_name\": \"Tom\"\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\",\n        \"sms_sender_user_id\": \"JduDVJJXTS6VGXiJiro7ZQ\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.voicemail_deleted":{"post":{"tags":["phone"],"operationId":"phone.voicemail_deleted","requestBody":{"description":"# phone.voicemail_deleted\n---\nThe **Voicemail has been deleted** event triggers each time a voicemail is deleted. When a voicemail is deleted, it is sent to the trash.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Voicemail has been deleted\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:master`,`phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**Event type**: `phone.voicemail_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["voice_mails"],"properties":{"voice_mails":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the voice mail."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.voicemail_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"voice_mails\": [\n        {\n          \"id\": \"0388975092074598b47330a6a87e9a7b\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["voice_mails"],"properties":{"voice_mails":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the voice mail."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.voicemail_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"voice_mails\": [\n        {\n          \"id\": \"0388975092074598b47330a6a87e9a7b\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}}}}},"phone.voicemail_transcript_completed":{"post":{"tags":["phone"],"operationId":"phone.voicemail_transcript_completed","requestBody":{"description":"# phone.voicemail_transcript_completed\n---\n\nThe **Voicemail transcription is complete** event triggers when a voicemail transcription has completed.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Voicemail transcription is complete** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:master`,`phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**Event type**: `phone.voicemail_transcript_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_transcript_completed"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["id","date_time","transcription","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."},"transcription":{"type":"object","description":"Voicemail transcript","required":["status","content"],"properties":{"status":{"type":"integer","enum":[0,1,2,4,5,9,11,12,13,14,409,415,422,500,601,602,603,999],"description":"Status of the voicemail transcript:\n* 0 — Transcript is not available.\n* 1 — Transcript is processing.\n* 2 - Transcript processed successfully\n* 4 — Transcript is disabled.\n* 5 — Transcript is enabled.\n* 9 — Transcript web error.\n* 11 — Transcript download error.\n* 12 — Transcript upload error.\n* 13 — Transcript web database error.\n* 14 — Transcript BYOS (Bring Your Own Storage) upload error.\n* 409 — Transcript duplicate processing request error.\n* 415 — Transcript unsupported media error.\n* 422 — Transcript is unprocessable.\n* 500 — Transcript server error.\n* 601 — Transcript AISense after retry error.\n* 602 — Transcript AISense upload file error.\n* 603 — Transcript AISense download file error.\n* 999 — Transcript AISense error.\n"},"content":{"type":"string","description":"Content of the voicemail transcript"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"caller_name\": \"Rascoe Thomas\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2,\n      \"transcription\": {\n        \"status\": 2,\n        \"content\": \"Some Transcript content\"\n      }\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_transcript_completed\"\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_transcript_completed"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["id","date_time","transcription","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."},"transcription":{"type":"object","description":"Voicemail transcript","required":["status","content"],"properties":{"status":{"type":"integer","enum":[0,1,2,4,5,9,11,12,13,14,409,415,422,500,601,602,603,999],"description":"Status of the voicemail transcript:\n* 0 — Transcript is not available.\n* 1 — Transcript is processing.\n* 2 - Transcript processed successfully\n* 4 — Transcript is disabled.\n* 5 — Transcript is enabled.\n* 9 — Transcript web error.\n* 11 — Transcript download error.\n* 12 — Transcript upload error.\n* 13 — Transcript web database error.\n* 14 — Transcript BYOS (Bring Your Own Storage) upload error.\n* 409 — Transcript duplicate processing request error.\n* 415 — Transcript unsupported media error.\n* 422 — Transcript is unprocessable.\n* 500 — Transcript server error.\n* 601 — Transcript AISense after retry error.\n* 602 — Transcript AISense upload file error.\n* 603 — Transcript AISense download file error.\n* 999 — Transcript AISense error.\n"},"content":{"type":"string","description":"Content of the voicemail transcript"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"caller_name\": \"Rascoe Thomas\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2,\n      \"transcription\": {\n        \"status\": 2,\n        \"content\": \"Some Transcript content\"\n      }\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_transcript_completed\"\n}"}}}}}}}},"phone.recording_permanently_deleted":{"post":{"tags":["phone"],"operationId":"phone.recording_permanently_deleted","requestBody":{"description":"# phone.recording_permanently_deleted\n\nThe **Call recording has been permenently deleted** event triggers when a recording has been deleted permanently.\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording has been permanently deleted** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_permanently_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account to which the recording belongs."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The recording ID."},"call_id":{"type":"string","description":"The call ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account to which the recording belongs."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The recording ID."},"call_id":{"type":"string","description":"The call ID."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"recordings\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}}}}},"phone.peering_number_emergency_address_updated":{"post":{"tags":["phone"],"operationId":"phone.peering_number_emergency_address_updated","requestBody":{"description":"# phone.peering_number_emergency_address_updated\n---\n\nThe **Emergency address has changed** event triggers when the emergency addresses associated with PSTN phone numbers have been updated.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Emergency address has changed\"** subscription must be enabled under the **Zoom Phone** event.\n\n> This event is for use by partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, please submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_peering:read:admin`,`phone_peering:write:admin`,`phone_peering:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:emergency_location:master`,`phone:read:emergency_location:admin`\n\n**Event type**: `phone.peering_number_emergency_address_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the customer using provider exchange."},"object":{"type":"object","required":["carrier_code","phone_numbers"],"properties":{"emergency_address":{"type":"object","description":"The emergency address info.","required":["address_line1"],"properties":{"country":{"type":"string","description":"Abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country."},"address_line1":{"type":"string","description":"Emergency address(house number and street name)."},"address_line2":{"type":"string","description":"Additional emergency address information (building, floor or unit number). "},"city":{"type":"string","description":"The city."},"zip":{"type":"string","description":"Zip code."},"state_code":{"type":"string","description":"Abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state."}},"additionalProperties":false},"carrier_code":{"type":"integer","description":"The carrier code."},"phone_numbers":{"type":"array","description":"The phone numbers with emergency address updates."}},"additionalProperties":false}},"additionalProperties":false}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.peering_number_emergency_address_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"emergency_address\": {\n        \"address_line1\": \"55 ALMADEN BLVD\",\n        \"address_line2\": \"13F\",\n        \"city\": \"SAN JOSE\",\n        \"country\": \"US\",\n        \"state_code\": \"CA\",\n        \"zip\": \"95113\"\n      },\n      \"carrier_code\": 3457,\n      \"phone_numbers\": [\n       \"18008001000\"\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the customer using provider exchange."},"object":{"type":"object","required":["carrier_code","phone_numbers"],"properties":{"emergency_address":{"type":"object","description":"The emergency address info.","required":["address_line1"],"properties":{"country":{"type":"string","description":"Abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of country."},"address_line1":{"type":"string","description":"Emergency address(house number and street name)."},"address_line2":{"type":"string","description":"Additional emergency address information (building, floor or unit number). "},"city":{"type":"string","description":"The city."},"zip":{"type":"string","description":"Zip code."},"state_code":{"type":"string","description":"Abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the state."}},"additionalProperties":false},"carrier_code":{"type":"integer","description":"The carrier code."},"phone_numbers":{"type":"array","description":"The phone numbers with emergency address updates."}},"additionalProperties":false}},"additionalProperties":false}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.peering_number_emergency_address_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"emergency_address\": {\n        \"address_line1\": \"55 ALMADEN BLVD\",\n        \"address_line2\": \"13F\",\n        \"city\": \"SAN JOSE\",\n        \"country\": \"US\",\n        \"state_code\": \"CA\",\n        \"zip\": \"95113\"\n      },\n      \"carrier_code\": 3457,\n      \"phone_numbers\": [\n       \"18008001000\"\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}}}}},"phone.sms_campaign_number_opt_out":{"post":{"tags":["phone"],"operationId":"phone.sms_campaign_number_opt_out","requestBody":{"description":"# phone.sms_campaign_number_opt_out\nThe **SMS Opt-out event from Zoom phone** triggers when an account user receives an SMS message with text of an opt-out keyword, such as **STOP**. The recipient must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom Phone admins can receive opt-out-status event using a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n\n## **Prerequisites**:\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS Opt-out event from Zoom phone** subscription enabled under the **Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign_number_opt_status:master`,`phone:read:sms_campaign_number_opt_status:admin`\n\n**Event type**: `phone.sms_campaign_number_opt_out`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_campaign_number_opt_out"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The phone number campaign opt status payload","required":["phone_number_campaign_opt_statuses","date_time"],"properties":{"phone_number_campaign_opt_statuses":{"type":"array","description":"The list of phone number pairs.","items":{"type":"object","description":"A phone-number pair.","required":["consumer_phone_number","zoom_phone_user_number"],"properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-out keyword to the Zoom Phone number."},"zoom_phone_user_number":{"type":"string","description":"Zoom user's phone number in E164 format that receives the Opt-out keyword from the end user."}},"additionalProperties":false},"maxItems":1,"uniqueItems":true,"additionalProperties":false},"date_time":{"type":"string","format":"date_time","description":"The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_campaign_number_opt_out\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+15043449240\",\n          \"zoom_phone_user_number\": \"+12094436304\"\n        }\n      ],\n      \"date_time\": \"2021-07-19T18:43:43Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_campaign_number_opt_out"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The phone number campaign opt status payload","required":["phone_number_campaign_opt_statuses","date_time"],"properties":{"phone_number_campaign_opt_statuses":{"type":"array","description":"The list of phone number pairs.","items":{"type":"object","description":"A phone-number pair.","required":["consumer_phone_number","zoom_phone_user_number"],"properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-out keyword to the Zoom Phone number."},"zoom_phone_user_number":{"type":"string","description":"Zoom user's phone number in E164 format that receives the Opt-out keyword from the end user."}},"additionalProperties":false},"maxItems":1,"uniqueItems":true,"additionalProperties":false},"date_time":{"type":"string","format":"date_time","description":"The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_campaign_number_opt_out\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+15043449240\",\n          \"zoom_phone_user_number\": \"+12094436304\"\n        }\n      ],\n      \"date_time\": \"2021-07-19T18:43:43Z\"\n    }\n  }\n}"}}}}}}}},"phone.caller_ended":{"post":{"tags":["phone"],"operationId":"phone.caller_ended","requestBody":{"description":"# phone.caller_ended\n---\nThe **Caller ended a phone call** event triggers whenever a caller, who is also a user in your account or app, ends a phone call on Zoom Phone.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Caller ended a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_ended`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"Thr unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Thr extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492\n\nNote: phone_number and extension_number can't be empty at the same time."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started,\"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time at which the call was answered, \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The GMT time at which the call was ended.\"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"handup_result":{"type":"string","description":"The reason the call was ended. Values: Call connected | Call Cancel | Voicemail"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_ended\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"call_end_time\": \"2021-08-19T00:59:11Z\"\n    }\n  },\n  \"event_ts\": 1629334764287\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"Thr unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Thr extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492\n\nNote: phone_number and extension_number can't be empty at the same time."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started,\"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time at which the call was answered, \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The GMT time at which the call was ended.\"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"handup_result":{"type":"string","description":"The reason the call was ended. Values: Call connected | Call Cancel | Voicemail"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_ended\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"call_end_time\": \"2021-08-19T00:59:11Z\"\n    }\n  },\n  \"event_ts\": 1629334764287\n}"}}}}}}}},"phone.callee_ended":{"post":{"tags":["phone"],"operationId":"phone.callee_ended","requestBody":{"description":"# phone.callee_ended\n---\nThe **Callee ended the phone call** event triggers whenever the callee, who is either a user on your account or a user of your app, terminates a call on Zoom Phone.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Callee ended a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_ended`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time( in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format) at which the call was answered."},"call_end_time":{"type":"string","description":"The GMT time( in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format) at which the call was ended by the callee."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_ended\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"channel_id\": \"b21dee06-ddaa-4578-ab90-1dd6e50ea4ba\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\",\n      \"answer_start_time\": \"2021-08-19T21:12:38Z\",\n      \"call_end_time\": \"2021-08-19T21:12:44Z\",\n      \"handup_result\": \"Call connected\",\n      \"sip_id\": \"168296889_92138195@50.232.196.82\"\n    }\n  },\n  \"event_ts\": 1629407576754\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time( in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format) at which the call was answered."},"call_end_time":{"type":"string","description":"The GMT time( in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format) at which the call was ended by the callee."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_ended\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"channel_id\": \"b21dee06-ddaa-4578-ab90-1dd6e50ea4ba\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\",\n      \"answer_start_time\": \"2021-08-19T21:12:38Z\",\n      \"call_end_time\": \"2021-08-19T21:12:44Z\",\n      \"handup_result\": \"Call connected\",\n      \"sip_id\": \"168296889_92138195@50.232.196.82\"\n    }\n  },\n  \"event_ts\": 1629407576754\n}"}}}}}}}},"phone.callee_call_history_completed":{"post":{"tags":["phone"],"operationId":"phone.callee_call_history_completed","requestBody":{"description":"# phone.callee_call_history_completed\n---\nThe **Callee call history is completed** event triggers every time the incoming call history record for a call is made available for the callee to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Callee call history is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.callee_call_history_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_history_completed"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id","call_path_id","result","start_time"],"properties":{"id":{"type":"string","description":"The ID of the call history."},"call_path_id":{"type":"string","description":"The call path ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_history_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_path_id\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_history_completed"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id","call_path_id","result","start_time"],"properties":{"id":{"type":"string","description":"The ID of the call history."},"call_path_id":{"type":"string","description":"The call path ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_history_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_path_id\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.call_element_deleted":{"post":{"tags":["phone"],"operationId":"phone.call_element_deleted","requestBody":{"description":"# phone.call_element_deleted\n\nThe **Call element has been deleted** event triggers each time a call element is deleted.\n\nWhen the account has the call log trash setting enabled, the deleted log will be sent to trash.\n\n## Prerequisites\n* Pro or higher account with [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call element has been deleted** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read:admin`,`phone_call_log:read`,`phone_call_log:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.call_element_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_element_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"move_to_trash":{"type":"boolean","description":"If the account has enabled call log trash, this value is true."},"execute_time":{"type":"string","description":"The delete event time in GMT date-time format. All call logs prior to this user have been deleted."},"delete_all":{"type":"boolean","description":"The value is true if the user delete all call logs"},"call_element_ids":{"type":"array","description":"The deleted call element ID list. This will be empty when the delete_all is true.","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_element_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_element_ids\": [\n        \"20240724-9a0887ca-da53-4c62-b32a-563789ef264e\"\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\",\n      \"execute_time\": \"2024-10-09T08:10:11.128Z\",\n      \"move_to_trash\": true,\n      \"delete_all\": false\n    }\n  },\n  \"event_ts\": 1721799823000\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_element_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"move_to_trash":{"type":"boolean","description":"If the account has enabled call log trash, this value is true."},"execute_time":{"type":"string","description":"The delete event time in GMT date-time format. All call logs prior to this user have been deleted."},"delete_all":{"type":"boolean","description":"The value is true if the user delete all call logs"},"call_element_ids":{"type":"array","description":"The deleted call element ID list. This will be empty when the delete_all is true.","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_element_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_element_ids\": [\n        \"20240724-9a0887ca-da53-4c62-b32a-563789ef264e\"\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\",\n      \"execute_time\": \"2024-10-09T08:10:11.128Z\",\n      \"move_to_trash\": true,\n      \"delete_all\": false\n    }\n  },\n  \"event_ts\": 1721799823000\n}"}}}}}}}},"phone.voicemail_permanently_deleted":{"post":{"tags":["phone"],"operationId":"phone.voicemail_permanently_deleted","requestBody":{"description":"# phone.voicemail_permanently_deleted\n---\nThe **Voicemail has been permanently deleted** event triggers each time a voicemail is permanently deleted from the trash.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Voicemail has been permanently deleted\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:master`,`phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**Event type**: `phone.voicemail_permanently_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["voice_mails"],"properties":{"voice_mails":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the voice mail."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.voicemail_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"voice_mails\": [\n        {\n          \"id\": \"0388975092074598b47330a6a87e9a7b\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_permanently_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["voice_mails"],"properties":{"voice_mails":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of the voice mail."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.voicemail_permanently_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"voice_mails\": [\n        {\n          \"id\": \"0388975092074598b47330a6a87e9a7b\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}}}}},"phone.sms_campaign_number_opt_in":{"post":{"tags":["phone"],"operationId":"phone.sms_campaign_number_opt_in","requestBody":{"description":"# phone.sms_campaign_number_opt_in\nThe **Opt-in-status event received by Zoom phone** triggers when an account user receives an SMS message with text of an opt-in keyword, such as **START**. The recipient must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom Phone admins can receive opt-in-status event using a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n## **Prerequisites**:\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **Opt-in-status event received by Zoom phone** subscription enabled under the **Phone** event.\n\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_campaign_number_opt_status:master`,`phone:read:sms_campaign_number_opt_status:admin`\n\n**Event type**: `phone.sms_campaign_number_opt_in`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_campaign_number_opt_in"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The phone number campaign opt-status payload.","required":["phone_number_campaign_opt_statuses","date_time"],"properties":{"phone_number_campaign_opt_statuses":{"type":"array","description":"The list of phone number pairs.","items":{"type":"object","description":"A phone number pair.","required":["consumer_phone_number","zoom_phone_user_number"],"properties":{"consumer_phone_number":{"type":"string","description":"End user's phone number in E164 format that sends the Opt-in keyword to the Zoom Phone number."},"zoom_phone_user_number":{"type":"string","description":"Zoom user's phone number in E164 format that receives Opt-in keyword from the end user."}},"additionalProperties":false},"maxItems":1,"uniqueItems":true,"additionalProperties":false},"date_time":{"type":"string","format":"date-time","description":"The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_campaign_number_opt_in\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+15043449240\",\n          \"zoom_phone_user_number\": \"+12094436304\"\n        }\n      ],\n      \"date_time\": \"2021-07-19T18:43:43Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_campaign_number_opt_in"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The phone number campaign opt-status payload.","required":["phone_number_campaign_opt_statuses","date_time"],"properties":{"phone_number_campaign_opt_statuses":{"type":"array","description":"The list of phone number pairs.","items":{"type":"object","description":"A phone number pair.","required":["consumer_phone_number","zoom_phone_user_number"],"properties":{"consumer_phone_number":{"type":"string","description":"End user's phone number in E164 format that sends the Opt-in keyword to the Zoom Phone number."},"zoom_phone_user_number":{"type":"string","description":"Zoom user's phone number in E164 format that receives Opt-in keyword from the end user."}},"additionalProperties":false},"maxItems":1,"uniqueItems":true,"additionalProperties":false},"date_time":{"type":"string","format":"date-time","description":"The date time at which the event occurred. The value of this field is returned in format FMT_DATE_ISO_2 according to the account's timezone. Otherwise it would be in UTC timezone."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_campaign_number_opt_in\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+15043449240\",\n          \"zoom_phone_user_number\": \"+12094436304\"\n        }\n      ],\n      \"date_time\": \"2021-07-19T18:43:43Z\"\n    }\n  }\n}"}}}}}}}},"phone.fax_received":{"post":{"tags":["phone"],"operationId":"phone.fax_received","requestBody":{"description":"# phone.fax_received\n---\nThe **Fax Received** event triggers when a fax is received.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Fax Received** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone:write`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin`,`phone:read:list_fax_log:master`\n\n**Event type**: `phone.fax_received`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_received"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_log_id","fax_id","site_id","site_name","extension_id","extension_type","direction","sender_extension_id","sender_extension_type","sender_extension_number","sender_name","sender_number","sender_type","receiver_extension_id","receiver_extension_type","receiver_extension_number","receiver_name","receiver_number","receiver_type","file_id","file_pages_count","status","create_time"],"description":"object","properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."},"fax_id":{"type":"string","description":"The unique fax session ID."},"site_id":{"type":"string","description":"The site ID."},"site_name":{"type":"string","description":"The site name."},"extension_id":{"type":"string","description":"The owner's extension ID."},"extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The owner's extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The fax log's direction:\n* inbound\n* outbound"},"sender_extension_id":{"type":"string","description":"The sender extension ID."},"sender_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The sender extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"sender_extension_number":{"type":"string","description":"The sender extension number."},"sender_name":{"type":"string","description":"The sender name."},"sender_number":{"type":"string","description":"The sender fax number."},"sender_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The sender endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"sender_location":{"type":"string","description":"The sender location."},"receiver_extension_id":{"type":"string","description":"The receiver extension ID."},"receiver_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The receiver extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"receiver_extension_number":{"type":"string","description":"The receiver extension number."},"receiver_name":{"type":"string","description":"The receiver name."},"receiver_number":{"type":"string","description":"The receiver fax number."},"receiver_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The receiver endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"receiver_location":{"type":"string","description":"The receiver location."},"file_id":{"type":"string","description":"The fax PDF file ID."},"file_pages_count":{"type":"integer","description":"The number of pages in the fax file."},"status":{"type":"string","enum":["failed","processing","submitted","sent","received"],"description":"The fax status:\n* failed\n* processing\n* submitted\n* sent\n* received"},"create_time":{"type":"string","format":"date-time","description":"The fax creation time in UTC."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_received\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\",\n      \"fax_id\": \"6A2BE84EE494479B9AFA29F4BB8A8EA6\",\n      \"site_id\": \"rtZRykrtTmKSWXJeW-xsBg\",\n      \"site_name\": \"Main Site\",\n      \"extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"extension_type\": \"callQueue\",\n      \"direction\": \"inbound\",\n      \"sender_extension_id\": \"iKBkkqgGQV-bEttrhP5T0g\",\n      \"sender_extension_type\": \"user\",\n      \"sender_extension_number\": \"456\",\n      \"sender_name\": \"Tester 1\",\n      \"sender_number\": \"+12092080933\",\n      \"sender_type\": \"client\",\n      \"sender_location\": \"California\",\n      \"receiver_extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"receiver_extension_type\": \"callQueue\",\n      \"receiver_extension_number\": \"123\",\n      \"receiver_name\": \"Support Queue\",\n      \"receiver_number\": \"+14085551234\",\n      \"receiver_type\": \"ata\",\n      \"receiver_location\": \"Alabama\",\n      \"file_id\": \"bayEy0y9RsadUbuEGrZBYA\",\n      \"file_pages_count\": 6,\n      \"status\": \"received\",\n      \"create_time\": \"2021-10-08T16:12:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_received"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_log_id","fax_id","site_id","site_name","extension_id","extension_type","direction","sender_extension_id","sender_extension_type","sender_extension_number","sender_name","sender_number","sender_type","receiver_extension_id","receiver_extension_type","receiver_extension_number","receiver_name","receiver_number","receiver_type","file_id","file_pages_count","status","create_time"],"description":"object","properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."},"fax_id":{"type":"string","description":"The unique fax session ID."},"site_id":{"type":"string","description":"The site ID."},"site_name":{"type":"string","description":"The site name."},"extension_id":{"type":"string","description":"The owner's extension ID."},"extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The owner's extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The fax log's direction:\n* inbound\n* outbound"},"sender_extension_id":{"type":"string","description":"The sender extension ID."},"sender_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The sender extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"sender_extension_number":{"type":"string","description":"The sender extension number."},"sender_name":{"type":"string","description":"The sender name."},"sender_number":{"type":"string","description":"The sender fax number."},"sender_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The sender endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"sender_location":{"type":"string","description":"The sender location."},"receiver_extension_id":{"type":"string","description":"The receiver extension ID."},"receiver_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The receiver extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"receiver_extension_number":{"type":"string","description":"The receiver extension number."},"receiver_name":{"type":"string","description":"The receiver name."},"receiver_number":{"type":"string","description":"The receiver fax number."},"receiver_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The receiver endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"receiver_location":{"type":"string","description":"The receiver location."},"file_id":{"type":"string","description":"The fax PDF file ID."},"file_pages_count":{"type":"integer","description":"The number of pages in the fax file."},"status":{"type":"string","enum":["failed","processing","submitted","sent","received"],"description":"The fax status:\n* failed\n* processing\n* submitted\n* sent\n* received"},"create_time":{"type":"string","format":"date-time","description":"The fax creation time in UTC."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_received\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\",\n      \"fax_id\": \"6A2BE84EE494479B9AFA29F4BB8A8EA6\",\n      \"site_id\": \"rtZRykrtTmKSWXJeW-xsBg\",\n      \"site_name\": \"Main Site\",\n      \"extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"extension_type\": \"callQueue\",\n      \"direction\": \"inbound\",\n      \"sender_extension_id\": \"iKBkkqgGQV-bEttrhP5T0g\",\n      \"sender_extension_type\": \"user\",\n      \"sender_extension_number\": \"456\",\n      \"sender_name\": \"Tester 1\",\n      \"sender_number\": \"+12092080933\",\n      \"sender_type\": \"client\",\n      \"sender_location\": \"California\",\n      \"receiver_extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"receiver_extension_type\": \"callQueue\",\n      \"receiver_extension_number\": \"123\",\n      \"receiver_name\": \"Support Queue\",\n      \"receiver_number\": \"+14085551234\",\n      \"receiver_type\": \"ata\",\n      \"receiver_location\": \"Alabama\",\n      \"file_id\": \"bayEy0y9RsadUbuEGrZBYA\",\n      \"file_pages_count\": 6,\n      \"status\": \"received\",\n      \"create_time\": \"2021-10-08T16:12:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.callee_call_element_completed":{"post":{"tags":["phone"],"operationId":"phone.callee_call_element_completed","requestBody":{"description":"# phone.callee_call_element_completed\n---\nThe **Callee call element is completed** event triggers every time the incoming call element record for a call is made available for the callee to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Callee call element is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_call_element_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_element_completed"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_elements","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_elements":{"type":"array","additionalItems":false,"items":{"type":"object","required":["call_element_id","call_history_uuid","call_id","result","start_time"],"properties":{"call_element_id":{"type":"string","description":"The ID of the call element."},"call_history_uuid":{"type":"string","description":"The call history ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_element_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_elements\": [\n        {\n          \"call_element_id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_history_uuid\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_element_completed"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_elements","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_elements":{"type":"array","additionalItems":false,"items":{"type":"object","required":["call_element_id","call_history_uuid","call_id","result","start_time"],"properties":{"call_element_id":{"type":"string","description":"The ID of the call element."},"call_history_uuid":{"type":"string","description":"The call history ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_element_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_elements\": [\n        {\n          \"call_element_id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_history_uuid\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.warm_transfer_completed":{"post":{"tags":["phone"],"operationId":"phone.warm_transfer_completed","requestBody":{"description":"# phone.warm_transfer_completed\n---\n\nThe **Warm transfer is completed** event triggers when a call warm transfer is completed.\n**Note**: Applicable only to Zoom desktop clients (version 6.1.0 or later) using Zoom native phone numbers. Not applicable to IP phones or BYOC numbers.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Warm transfer is completed\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.warm_transfer_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the webhook event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the warm transfer failed to complete. An empty string indicates success."},"call_id":{"type":"string","description":"The unique identifier of the call."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be the user's phone number, extension number, or phone number in E164 format."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The unique identifier of the owner.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The name of the owner.","type":"string","example":"123@test.com"},"type":{"description":"The owner type. Possible values: user, callQueue, autoReceptionist, commonAreaPhone, sharedLineGroup.","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the call warm transfer was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_completed\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"transfer_phone_number\": \"+12055432724\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the webhook event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the warm transfer failed to complete. An empty string indicates success."},"call_id":{"type":"string","description":"The unique identifier of the call."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be the user's phone number, extension number, or phone number in E164 format."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The unique identifier of the owner.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The name of the owner.","type":"string","example":"123@test.com"},"type":{"description":"The owner type. Possible values: user, callQueue, autoReceptionist, commonAreaPhone, sharedLineGroup.","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the call warm transfer was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_completed\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"transfer_phone_number\": \"+12055432724\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.callee_mute":{"post":{"tags":["phone"],"operationId":"phone.callee_mute","requestBody":{"description":"# phone.callee_mute\n\nThe **Callee mutes a phone call** event triggers when the callee mutes themselves during a call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Callee mutes a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n `phone.callee_mute`\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_mute`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the callee muted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_mute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the callee muted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_mute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.sms_etiquette_warn":{"post":{"tags":["phone"],"operationId":"phone.sms_etiquette_warn","requestBody":{"description":"# phone.sms_etiquette_warn\nThe **SMS etiquette warn event from Zoom phone** triggers when an account user's outbound text violates a SMS etiquette warn policy defined in Zoom phone web admin portal. The recipient must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom Phone admins can receive the sms-etiquette-warn event using a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n\n## **Prerequisites**:\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS etiquette warn event from Zoom phone** subscription enabled under the **Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:master`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message:admin`,`phone:read:sms_message:master`\n\n**Event type**: `phone.sms_etiquette_warn`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_etiquette_warn"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The sms etiquette event payload.","required":["email","message","policy_name","date_time"],"properties":{"email":{"type":"string","description":"an email of a zoom phone user that violated SMS Etiquette warn policy.","additionalProperties":false},"message":{"type":"string","description":"Message content that violated SMS Etiquette warn policy.","additionalProperties":false},"policy_name":{"type":"string","description":"SMS Etiquette warn policy that was violated.","additionalProperties":false},"date_time":{"type":"string","description":"The date time at which the event occurred.","format":"date_time"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_etiquette_warn\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"email\": \"user.email@company.com\",\n      \"message\": \"this is my SSN 123-45-6789\",\n      \"policy_name\": \"Company's SSN warning policy\",\n      \"date_time\": \"2025-03-15T18:43:43Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_etiquette_warn"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The sms etiquette event payload.","required":["email","message","policy_name","date_time"],"properties":{"email":{"type":"string","description":"an email of a zoom phone user that violated SMS Etiquette warn policy.","additionalProperties":false},"message":{"type":"string","description":"Message content that violated SMS Etiquette warn policy.","additionalProperties":false},"policy_name":{"type":"string","description":"SMS Etiquette warn policy that was violated.","additionalProperties":false},"date_time":{"type":"string","description":"The date time at which the event occurred.","format":"date_time"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_etiquette_warn\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"email\": \"user.email@company.com\",\n      \"message\": \"this is my SSN 123-45-6789\",\n      \"policy_name\": \"Company's SSN warning policy\",\n      \"date_time\": \"2025-03-15T18:43:43Z\"\n    }\n  }\n}"}}}}}}}},"phone.call_history_deleted":{"post":{"tags":["phone"],"operationId":"phone.call_history_deleted","requestBody":{"description":"# phone.call_history_deleted\n\nThe **Call history has been deleted** event triggers each time a call history is deleted.\n\nWhen the account has the call log trash setting enabled, the deleted log will be sent to trash.\n\n## Prerequisites\n* Pro or higher account with [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call history has been deleted** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_call_log:read:admin`,`phone_call_log:read`,`phone_call_log:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.call_history_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_history_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"move_to_trash":{"type":"boolean","description":"If the account has enabled call log trash, this value is true."},"execute_time":{"type":"string","description":"The delete event time in GMT date-time format. All call logs prior to this user have been deleted."},"delete_all":{"type":"boolean","description":"The value is true if the user delete all call logs"},"call_log_ids":{"type":"array","description":"The deleted call log ID list. This will be empty when the delete_all is true.","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_history_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_log_ids\": [\n        \"20240724-9a0887ca-da53-4c62-b32a-563789ef264e\"\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\",\n      \"execute_time\": \"2024-10-09T08:10:11.128Z\",\n      \"move_to_trash\": true,\n      \"delete_all\": false\n    }\n  },\n  \"event_ts\": 1721799823000\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_history_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"move_to_trash":{"type":"boolean","description":"If the account has enabled call log trash, this value is true."},"execute_time":{"type":"string","description":"The delete event time in GMT date-time format. All call logs prior to this user have been deleted."},"delete_all":{"type":"boolean","description":"The value is true if the user delete all call logs"},"call_log_ids":{"type":"array","description":"The deleted call log ID list. This will be empty when the delete_all is true.","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_history_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_log_ids\": [\n        \"20240724-9a0887ca-da53-4c62-b32a-563789ef264e\"\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\",\n      \"execute_time\": \"2024-10-09T08:10:11.128Z\",\n      \"move_to_trash\": true,\n      \"delete_all\": false\n    }\n  },\n  \"event_ts\": 1721799823000\n}"}}}}}}}},"phone.sms_etiquette_block":{"post":{"tags":["phone"],"operationId":"phone.sms_etiquette_block","requestBody":{"description":"# phone.sms_etiquette_block\nThe **SMS etiquette block event from Zoom phone** triggers when an account user's outbound text violates a SMS etiquette block policy defined in the Zoom phone web admin portal. The recipient must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom Phone admins can receive the sms-etiquette-block event using a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n\n## **Prerequisites**:\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS etiquette block event from Zoom phone** subscription enabled under the **Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:master`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message:admin`,`phone:read:sms_message:master`\n\n**Event type**: `phone.sms_etiquette_block`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_etiquette_block"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The sms etiquette event payload.","required":["email","message","policy_name","date_time"],"properties":{"email":{"type":"string","description":"an email of a zoom phone user that violated SMS Etiquette block policy.","additionalProperties":false},"message":{"type":"string","description":"Message content that violated SMS Etiquette block policy.","additionalProperties":false},"policy_name":{"type":"string","description":"SMS Etiquette block policy that was violated.","additionalProperties":false},"date_time":{"type":"string","description":"The date time at which the event occurred.","format":"date_time"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_etiquette_block\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"email\": \"user.email@company.com\",\n      \"message\": \"this is my SSN 123-45-6789\",\n      \"policy_name\": \"Company's SSN blocking policy\",\n      \"date_time\": \"2025-03-15T18:43:43Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_etiquette_block"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"type":"object","description":"The sms etiquette event payload.","required":["email","message","policy_name","date_time"],"properties":{"email":{"type":"string","description":"an email of a zoom phone user that violated SMS Etiquette block policy.","additionalProperties":false},"message":{"type":"string","description":"Message content that violated SMS Etiquette block policy.","additionalProperties":false},"policy_name":{"type":"string","description":"SMS Etiquette block policy that was violated.","additionalProperties":false},"date_time":{"type":"string","description":"The date time at which the event occurred.","format":"date_time"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_etiquette_block\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"email\": \"user.email@company.com\",\n      \"message\": \"this is my SSN 123-45-6789\",\n      \"policy_name\": \"Company's SSN blocking policy\",\n      \"date_time\": \"2025-03-15T18:43:43Z\"\n    }\n  }\n}"}}}}}}}},"phone.call_log_deleted":{"post":{"tags":["phone"],"operationId":"phone.call_log_deleted","requestBody":{"description":"# phone.call_log_deleted\n\nThe **Call log has been deleted** event triggers each time a call log is deleted. When a log is deleted, it is sent to the trash.\n\n## Prerequisites\n* Pro or higher account with [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Call log has been deleted\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.call_log_deleted`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_log_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The unique identifier of the call log."},"call_id":{"type":"string","description":"The unique identifier of the call."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_log_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\"\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.call_log_deleted"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the call log."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the call log owner."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id"],"properties":{"id":{"type":"string","description":"The unique identifier of the call log."},"call_id":{"type":"string","description":"The unique identifier of the call."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.call_log_deleted\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"9a0887ca-da53-4c62-b32a-563789ef264e\",\n          \"call_id\": \"6954218111457544837\"\n        }\n      ],\n      \"user_id\": \"DYHrdpjrS3uaOf7dPkkg8w\"\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}}}}},"phone.caller_hold":{"post":{"tags":["phone"],"operationId":"phone.caller_hold","requestBody":{"description":"# phone.caller_hold\n---\n\nThe **Caller hold a phone call** event triggers every time a caller over Zoom Phone puts a phone call on hold.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be an account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Caller hold a phone call**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_hold`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.caller_hold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.caller_hold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.caller_connected":{"post":{"tags":["phone"],"operationId":"phone.caller_connected","requestBody":{"description":"# phone.caller_connected\n---\n\nThe **Caller is connected to the callee** event triggers when a connection starts between the caller and callee on Zoom Phone after the caller hears the ringing tone. To receive this notification, you must meet the prerequisites listed below.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Caller is connected to the callee** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_connected`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","connected_start_time"],"properties":{"call_id":{"type":"string","description":"Unique identifier of the call."},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"Zoom User ID of the caller."},"name":{"type":"string","description":"Caller's user name."},"phone_number":{"type":"string","description":"Phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the caller."},"timezone":{"type":"string","description":"Timezone of the caller."},"device_type":{"type":"string","description":"The type of device on which the Zoom client is installed.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"Callee's user name."},"phone_number":{"type":"string","description":"Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"connected_start_time":{"type":"string","description":"The GMT time at which the connection was established between the caller and the Zoom Phone network in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_connected\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"channel_id\": \"1df42be1-8420-4396-9e78-0a7ee7bc5aab\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"connected_start_time\": \"2021-08-19T00:58:20Z\"\n    }\n  },\n  \"event_ts\": 1629334712775\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","connected_start_time"],"properties":{"call_id":{"type":"string","description":"Unique identifier of the call."},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"Zoom User ID of the caller."},"name":{"type":"string","description":"Caller's user name."},"phone_number":{"type":"string","description":"Phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the caller."},"timezone":{"type":"string","description":"Timezone of the caller."},"device_type":{"type":"string","description":"The type of device on which the Zoom client is installed.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"Callee's user name."},"phone_number":{"type":"string","description":"Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"Extension number of the callee."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"connected_start_time":{"type":"string","description":"The GMT time at which the connection was established between the caller and the Zoom Phone network in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_connected\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6997939173429971528\",\n      \"channel_id\": \"1df42be1-8420-4396-9e78-0a7ee7bc5aab\",\n      \"caller\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_number\": 12092592844,\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-19T00:58:02Z\",\n      \"connected_start_time\": \"2021-08-19T00:58:20Z\"\n    }\n  },\n  \"event_ts\": 1629334712775\n}"}}}}}}}},"phone.recording_completed":{"post":{"tags":["phone"],"operationId":"phone.recording_completed","requestBody":{"description":"# phone.recording_completed\n---\n\nThe **Call recording is completed** event triggers when a recording of a Zoom phone call completes.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","duration","download_url","date_time"],"properties":{"id":{"type":"string","description":"The recording ID is the unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"The name of the caller."},"caller_did_number":{"type":"string","description":"The caller's DID number."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number."},"duration":{"type":"integer","description":"The duration of the call in seconds."},"download_url":{"type":"string","description":"The URL to download the call recording.\n\nTo download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below:\n\nhttps://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"user_id":{"type":"string","description":"The unique identifier of the user."},"call_id":{"type":"string","description":"The unique identifier of the call."},"call_log_id":{"type":"string","description":"The call log ID."},"call_history_id":{"type":"string","description":"The call history ID."},"call_element_id":{"type":"string","description":"The call element ID."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"The recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"The site of the call.","properties":{"id":{"type":"string","description":"The site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"The owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner's type. This value field can be user or callQueue."},"id":{"type":"string","description":"The owner's ID."},"name":{"type":"string","description":"The owner's name."},"extension_number":{"description":"The extension number of the owner","type":"integer"},"has_access_permission":{"type":"boolean","description":"Whether the owner has the access permission to this recording."}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"The user's name.","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"The user's name","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n    \"event\": \"phone.recording_completed\",\n    \"event_ts\": 1626230691572,\n    \"payload\": {\n        \"account_id\": \"AAAAAABBBB\",\n        \"object\": {\n            \"recordings\": [\n                {\n                    \"id\": \"abcD3ojfdbjfg\",\n                    \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n                    \"caller_number\": \"1026\",\n                    \"caller_number_type\": 1,\n                    \"caller_name\": \"Caller Name\",\n                    \"caller_did_number\": \"+12055967465\",\n                    \"callee_number\": \"1045\",\n                    \"callee_number_type\": 1,\n                    \"callee_name\": \"Callee Name\",\n                    \"callee_did_number\": \"+15104381494\",\n                    \"duration\": 43,\n                    \"download_url\": \"https://some.url.com\",\n                    \"direction\": \"outbound\",\n                    \"date_time\": \"2021-06-09T06:09:24Z\",\n                    \"recording_type\": \"OnDemand\",\n                    \"call_id\": \"6971672158469969953\",\n                    \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"call_history_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"end_time\": \"2021-06-09T06:10:07Z\",\n                    \"site\": {\n                        \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n                    },\n                    \"owner\": {\n                        \"type\": \"user\",\n                        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n                        \"name\": \"usersubsetting0001\",\n                        \"extension_number\": 6666,\n                        \"has_access_permission\": true\n                    }\n                }\n            ]\n        }\n    }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.recording_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user who recorded the call."},"object":{"type":"object","required":["recordings"],"properties":{"recordings":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","callee_name","direction","duration","download_url","date_time"],"properties":{"id":{"type":"string","description":"The recording ID is the unique Identifier of the call recording."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the caller. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"caller_name":{"type":"string","description":"The name of the caller."},"caller_did_number":{"type":"string","description":"The caller's DID number."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The phone number type of the callee. The value can be one of the following:\n* 1 - internal \n* 2 - external"},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number."},"duration":{"type":"integer","description":"The duration of the call in seconds."},"download_url":{"type":"string","description":"The URL to download the call recording.\n\nTo download the recording via this URL, you must add an “access_token” query parameter to the download URL and provide either the user's OAuth access token or your app's **JWT** as the value of the “access_token” parameter.\n\nFor example, if the value of this field is \"https://zoom.us/v2/phone/recording/download/abcD666T”, the complete URL path to download the recording will be as below:\n\nhttps://zoom.us/v2/phone/recording/download/abcD666T?access_token={YOUR_ACCESS_TOKEN_HERE}"},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"user_id":{"type":"string","description":"The unique identifier of the user."},"call_id":{"type":"string","description":"The unique identifier of the call."},"call_log_id":{"type":"string","description":"The call log ID."},"call_history_id":{"type":"string","description":"The call history ID."},"call_element_id":{"type":"string","description":"The call element ID."},"end_time":{"type":"string","description":"The recording's end time.","format":"date-time"},"recording_type":{"type":"string","description":"The recording type of the call. This value field can be OnDemand or Automatic."},"site":{"type":"object","description":"The site of the call.","properties":{"id":{"type":"string","description":"The site ID of the call."}},"additionalProperties":false},"owner":{"type":"object","description":"The owner of the call.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner's type. This value field can be user or callQueue."},"id":{"type":"string","description":"The owner's ID."},"name":{"type":"string","description":"The owner's name."},"extension_number":{"description":"The extension number of the owner","type":"integer"},"has_access_permission":{"type":"boolean","description":"Whether the owner has the access permission to this recording."}},"additionalProperties":false},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"outgoing_by":{"description":"The call-initiating user. The current recording must belong to the initiator and call queue for it to be available.","properties":{"name":{"description":"The user's name.","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"},"accepted_by":{"description":"The call-receiving user. The current recording must belong to the receiver and call queue for it to be available.","properties":{"name":{"description":"The user's name","type":"string"},"extension_number":{"description":"The user's extension number.","type":"string"}},"type":"object"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n    \"event\": \"phone.recording_completed\",\n    \"event_ts\": 1626230691572,\n    \"payload\": {\n        \"account_id\": \"AAAAAABBBB\",\n        \"object\": {\n            \"recordings\": [\n                {\n                    \"id\": \"abcD3ojfdbjfg\",\n                    \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n                    \"caller_number\": \"1026\",\n                    \"caller_number_type\": 1,\n                    \"caller_name\": \"Caller Name\",\n                    \"caller_did_number\": \"+12055967465\",\n                    \"callee_number\": \"1045\",\n                    \"callee_number_type\": 1,\n                    \"callee_name\": \"Callee Name\",\n                    \"callee_did_number\": \"+15104381494\",\n                    \"duration\": 43,\n                    \"download_url\": \"https://some.url.com\",\n                    \"direction\": \"outbound\",\n                    \"date_time\": \"2021-06-09T06:09:24Z\",\n                    \"recording_type\": \"OnDemand\",\n                    \"call_id\": \"6971672158469969953\",\n                    \"call_log_id\": \"a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"call_history_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n                    \"end_time\": \"2021-06-09T06:10:07Z\",\n                    \"site\": {\n                        \"id\": \"qORJkxNDTA25_VfJ3GK9KA\"\n                    },\n                    \"owner\": {\n                        \"type\": \"user\",\n                        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n                        \"name\": \"usersubsetting0001\",\n                        \"extension_number\": 6666,\n                        \"has_access_permission\": true\n                    }\n                }\n            ]\n        }\n    }\n}"}}}}}}}},"phone.recording_started":{"post":{"tags":["phone"],"operationId":"phone.recording_started","requestBody":{"description":"# phone.recording_started\n---\nThe **Call recording has started** event triggers when the recordings has been initiated in a phone call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording has started** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_started`\n","content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"ID of the recording"},"user_id":{"type":"string","description":"ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"channel_id":{"type":"string","description":"ID of the channel"},"sip_id":{"type":"string","description":"ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Type of the owner. This value field can be user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"ID of the owner."},"name":{"type":"string","description":"Display name of the owner"},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_started\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n            \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"ID of the recording"},"user_id":{"type":"string","description":"ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"channel_id":{"type":"string","description":"ID of the channel"},"sip_id":{"type":"string","description":"ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Type of the owner. This value field can be user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"ID of the owner."},"name":{"type":"string","description":"Display name of the owner"},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_started\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n            \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}}}}},"phone.sms_sent_failed":{"post":{"tags":["phone"],"operationId":"phone.sms_sent_failed","requestBody":{"description":"# phone.sms_sent_failed\n---\n\nThe **SMS sent failed from Zoom phone** event triggers when a user account fails to send the SMS message. The sender must either be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\n## **Prerequisites**\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS sent failed from Zoom phone** subscription enabled under the **Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message:master`,`phone:read:sms_message`,`phone:read:sms_message:admin`\n\n**Event type**: `phone.sms_sent_failed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_sent_failed"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of SMS/MMS message that failed to be sent.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason for an SMS send failure."},"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"SMS sender's user ID."},"type":{"type":"string","description":"The type of sender:\n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's user ID."},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."},"is_message_owner":{"type":"boolean","description":"Whether it is the owner of the message."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS.","type":"object","properties":{"type":{"type":"string","description":"The owner type:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The owner ID."},"sms_sender_user_id":{"type":"string","description":"The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL to use to download the file."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was sent."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+120944XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_sent_failed\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"1101-phone message error send\",\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"is_message_owner\": true\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_sent_failed"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of SMS/MMS message that failed to be sent.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason for an SMS send failure."},"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"SMS sender's user ID."},"type":{"type":"string","description":"The type of sender:\n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's user ID."},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."},"is_message_owner":{"type":"boolean","description":"Whether it is the owner of the message."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS.","type":"object","properties":{"type":{"type":"string","description":"The owner type:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The owner ID."},"sms_sender_user_id":{"type":"string","description":"The user ID of the call queue or auto receptionist member who sent the SMS when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL to use to download the file."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The unique identifier for a media file."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was sent."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+120944XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_sent_failed\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"1101-phone message error send\",\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"is_message_owner\": true\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.callee_call_log_completed":{"post":{"tags":["phone"],"operationId":"phone.callee_call_log_completed","requestBody":{"description":"# phone.callee_call_log_completed\n---\nThe **Callee call log is completed** event triggers every time the incoming call log record for a call is made available for the callee to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Callee call log is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.callee_call_log_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_log_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the callee."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"User Id of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","has_voicemail","call_id","result","date_time","path"],"properties":{"id":{"type":"string","description":"Unique Identifier of the call log."},"caller_user_id":{"type":"string","description":"The caller's user ID. This field will only exist if the caller is a user of this account."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"caller_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when caller_number_type = 1."},"caller_name":{"type":"string","description":"Name of the caller."},"caller_location":{"type":"string","description":"Location of the caller."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"caller_country_code":{"type":"string","description":"Caller's country code."},"caller_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the callee. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"callee_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when callee_number_type = 1."},"callee_name":{"type":"string","description":"Name of the callee."},"callee_location":{"type":"string","description":"Location of the callee."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_country_code":{"type":"string","description":"Callee's country code."},"callee_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"duration":{"type":"integer","description":"Duration of the call."},"result":{"type":"string","description":"Status of the call. The value of this field can be one of the following:<br>\n* Answered by another Member: This value will be returned if  simultaneous distribution option is enabled for a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-call-queues) and a member of the queue answers the call. \n* Busy: This value is returned if the phone line of the callee is busy.\n\n* Call Cancel: This value is returned if the call was cancelled. \n\n* No Answer: This value is returned if the callee did not answer the call. \n\n* Park: This value is returned if the call was [parked](https://support.zoom.us/hc/en-us/articles/360042175291-Using-call-park).\n\n* Rejected: This value is returned if the callee declined the call."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"path":{"type":"string","description":"Path of the call log."},"site":{"type":"object","properties":{"id":{"type":"string","description":"The phone number's assigned target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). Sites allow you to organize the phone users in your organization. For example, sites created and based on different office locations."}}},"has_recording":{"type":"boolean","description":"Indicates whether the call log includes recording or not."},"recording_id":{"type":"string","description":"ID of this recording."},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"has_voicemail":{"type":"boolean","description":"Indicates whether the call log includes voicemail or not."},"call_id":{"type":"string","description":"Unique identifier of the call."},"client_code":{"type":"string","description":"Client code."},"call_type":{"type":"string","description":"The type of call:\n* voip (Voice over IP)\n* pstn (Public Switched Telephone Network)\n* tollfree\n* international\n* contactCenter","enum":["voip","pstn","tollfree","international","contactCenter"]},"call_end_time":{"type":"string","format":"date-time","description":"End time of the call."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"answer_start_time":{"type":"string","description":"The GMT time in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format at which the callee answered the call."},"waiting_time":{"type":"integer","description":"Waiting time of the call."},"forwarded_to":{"description":"Indicates who the call was forwarded to.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"forwarded_by":{"description":"Indicates where the call was forwarded from.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"hold_time":{"description":"Hold time during a call in seconds.","type":"integer"},"department":{"description":"Department name.","type":"string"},"cost_center":{"description":"Cost center name.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_log_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"4a4ed8ec-6be4-4e42-96e6-352a4396204d\",\n          \"call_type\": \"voip\",\n          \"caller_number\": \"1045\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"usersubsetting0001@testapi.com\",\n          \"caller_country_iso_code\" : \"US\",\n          \"callee_number\": \"1026\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"ZOOM_API Test\",\n          \"caller_did_number\" : \"+12055967465\",\n          \"caller_country_code\" : \"1\",\n          \"callee_did_number\" : \"+15104381494\",\n          \"callee_country_code\" : \"1\",\n          \"callee_country_iso_code\" : \"US\",\n          \"direction\": \"inbound\",\n          \"duration\": 0,\n          \"result\": \"Rejected\",\n          \"date_time\": \"2021-06-09T05:55:07Z\",\n          \"path\": \"extension\",\n          \"has_recording\": false,\n          \"has_voicemail\": false,\n          \"call_id\": \"6971668473388011511\",\n          \"client_code\" : \"741\",\n          \"call_end_time\": \"2021-06-09T05:55:12Z\",\n          \"forwarded_by\": {\n                    \"extension_number\": \"1009\",\n                    \"extension_type\": \"callQueue\",\n                    \"location\": \"Glendale     CA\",\n                    \"name\": \"Display name\",\n                    \"number_type\": 1,\n                    \"phone_number\": \"+12055432724\"\n                  }\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.callee_call_log_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the callee."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"User Id of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","caller_number","caller_number_type","callee_number","callee_number_type","has_voicemail","call_id","result","date_time","path"],"properties":{"id":{"type":"string","description":"Unique Identifier of the call log."},"caller_user_id":{"type":"string","description":"The caller's user ID. This field will only exist if the caller is a user of this account."},"caller_number":{"type":"string","description":"Phone number of the caller."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the caller. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"caller_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when caller_number_type = 1."},"caller_name":{"type":"string","description":"Name of the caller."},"caller_location":{"type":"string","description":"Location of the caller."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"caller_country_code":{"type":"string","description":"Caller's country code."},"caller_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_number":{"type":"string","description":"Phone number of the callee."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"Phone number type of the callee. The value can be one of the following:\n* 1 - extension number.\n* 2 - phone number."},"callee_number_source":{"type":"string","enum":["internal","external","byop"],"description":"Phone number source of the caller. The value can be one of the following:\n* internal - ZP native.\n* external — BYOC or Provider Exchange.\n* byop — Premise peering.\nNot available when callee_number_type = 1."},"callee_name":{"type":"string","description":"Name of the callee."},"callee_location":{"type":"string","description":"Location of the callee."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_country_code":{"type":"string","description":"Callee's country code."},"callee_country_iso_code":{"type":"string","description":"ISO alpha2 country code."},"duration":{"type":"integer","description":"Duration of the call."},"result":{"type":"string","description":"Status of the call. The value of this field can be one of the following:<br>\n* Answered by another Member: This value will be returned if  simultaneous distribution option is enabled for a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-call-queues) and a member of the queue answers the call. \n* Busy: This value is returned if the phone line of the callee is busy.\n\n* Call Cancel: This value is returned if the call was cancelled. \n\n* No Answer: This value is returned if the callee did not answer the call. \n\n* Park: This value is returned if the call was [parked](https://support.zoom.us/hc/en-us/articles/360042175291-Using-call-park).\n\n* Rejected: This value is returned if the callee declined the call."},"date_time":{"type":"string","format":"date-time","description":"Start date and time of the call."},"path":{"type":"string","description":"Path of the call log."},"site":{"type":"object","properties":{"id":{"type":"string","description":"The phone number's assigned target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites). Sites allow you to organize the phone users in your organization. For example, sites created and based on different office locations."}}},"has_recording":{"type":"boolean","description":"Indicates whether the call log includes recording or not."},"recording_id":{"type":"string","description":"ID of this recording."},"recording_type":{"type":"string","description":"Recording type of the call. This value field can be OnDemand or Automatic."},"has_voicemail":{"type":"boolean","description":"Indicates whether the call log includes voicemail or not."},"call_id":{"type":"string","description":"Unique identifier of the call."},"client_code":{"type":"string","description":"Client code."},"call_type":{"type":"string","description":"The type of call:\n* voip (Voice over IP)\n* pstn (Public Switched Telephone Network)\n* tollfree\n* international\n* contactCenter","enum":["voip","pstn","tollfree","international","contactCenter"]},"call_end_time":{"type":"string","format":"date-time","description":"End time of the call."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"answer_start_time":{"type":"string","description":"The GMT time in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format at which the callee answered the call."},"waiting_time":{"type":"integer","description":"Waiting time of the call."},"forwarded_to":{"description":"Indicates who the call was forwarded to.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"forwarded_by":{"description":"Indicates where the call was forwarded from.","properties":{"extension_number":{"type":"string"},"extension_type":{"enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"number_type":{"description":"Phone number types: 1 - Extension 2- E164 number 3 - Custom number.","type":"integer"},"phone_number":{"type":"string"}},"type":"object"},"hold_time":{"description":"Hold time during a call in seconds.","type":"integer"},"department":{"description":"Department name.","type":"string"},"cost_center":{"description":"Cost center name.","type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_call_log_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"4a4ed8ec-6be4-4e42-96e6-352a4396204d\",\n          \"call_type\": \"voip\",\n          \"caller_number\": \"1045\",\n          \"caller_number_type\": 1,\n          \"caller_name\": \"usersubsetting0001@testapi.com\",\n          \"caller_country_iso_code\" : \"US\",\n          \"callee_number\": \"1026\",\n          \"callee_number_type\": 1,\n          \"callee_name\": \"ZOOM_API Test\",\n          \"caller_did_number\" : \"+12055967465\",\n          \"caller_country_code\" : \"1\",\n          \"callee_did_number\" : \"+15104381494\",\n          \"callee_country_code\" : \"1\",\n          \"callee_country_iso_code\" : \"US\",\n          \"direction\": \"inbound\",\n          \"duration\": 0,\n          \"result\": \"Rejected\",\n          \"date_time\": \"2021-06-09T05:55:07Z\",\n          \"path\": \"extension\",\n          \"has_recording\": false,\n          \"has_voicemail\": false,\n          \"call_id\": \"6971668473388011511\",\n          \"client_code\" : \"741\",\n          \"call_end_time\": \"2021-06-09T05:55:12Z\",\n          \"forwarded_by\": {\n                    \"extension_number\": \"1009\",\n                    \"extension_type\": \"callQueue\",\n                    \"location\": \"Glendale     CA\",\n                    \"name\": \"Display name\",\n                    \"number_type\": 1,\n                    \"phone_number\": \"+12055432724\"\n                  }\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.callee_ringing":{"post":{"tags":["phone"],"operationId":"phone.callee_ringing","requestBody":{"description":"# phone.callee_ringing\n---\n\nThe **Callee phone is ringing** event triggers whenever the caller starts a Zoom Phone call, and the callee receives a call notification or hears the phone ring..\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Callee phone is ringing** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_ringing`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_type":{"type":"string","description":"This field indicates the specific type of device the Zoom client installs on.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client installs on."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"The caller's user name."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_ringing\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\"\n    }\n  },\n  \"event_ts\": 1629407561742\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_type":{"type":"string","description":"This field indicates the specific type of device the Zoom client installs on.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client installs on."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"The caller's user name."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_ringing\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\"\n    }\n  },\n  \"event_ts\": 1629407561742\n}"}}}}}}}},"phone.caller_unhold":{"post":{"tags":["phone"],"operationId":"phone.caller_unhold","requestBody":{"description":"# phone.caller_unhold\n---\n\nThe **Caller unhold a phone call** event triggers every time the person who is being called by the caller over Zoom Phone unholds the phone call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Caller unhold a phone call**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_unhold`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold ended, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.caller_unhold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold ended, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.caller_unhold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.callee_hold":{"post":{"tags":["phone"],"operationId":"phone.callee_hold","requestBody":{"description":"# phone.callee_hold\n---\n\nThe **Callee hold a phone call** event triggers every time the person who is being called by the caller over Zoom Phone puts a phone call on hold.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be an account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Callee hold a phone call**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_hold`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) when the call hold began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_hold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) when the call hold began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_hold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.callee_answered":{"post":{"tags":["phone"],"operationId":"phone.callee_answered","requestBody":{"description":"# phone.callee_answered\n---\n\nThe **Callee Answered** event triggers whenever the recipient of a Zoom Phone call answers the incoming call..\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n  * **Callee answered a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_answered`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","answer_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_type":{"type":"string","description":"The type of device on which the Zoom client is installed.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the entity that initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"The caller's user name."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format at which the callee answered the call."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_answered\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"channel_id\": \"b21dee06-ddaa-4578-ab90-1dd6e50ea4ba\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\",\n      \"answer_start_time\": \"2021-08-19T21:12:38Z\",\n      \"sip_id\": \"168296889_92138195@50.232.196.82\"\n    }\n  },\n  \"event_ts\": 1629407570749\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","answer_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"name":{"type":"string","description":"The callee's user name."},"phone_number":{"type":"string","description":"The phone number of the callee in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_type":{"type":"string","description":"The type of device on which the Zoom client is installed.\n\n<b>Note:</b> For desk phones, the value is applicable to limited devices."},"device_name":{"type":"string","description":"The name of device on which the Zoom Client is installed."},"device_id":{"type":"string","description":"An ID generated by Zoom clients when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the entity that initiated the call.","properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"name":{"type":"string","description":"The caller's user name."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"answer_start_time":{"type":"string","description":"The GMT time in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format at which the callee answered the call."},"forwarded_by":{"type":"object","description":"The webhook displays this field if the call was routed from a call queue, shared line group, shared lines, or auto receptionist. See [Setting up call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation) for more information.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: callQueue | sharedLineGroup | sharedLines | autoReceptionist"}}},"redirect_forwarded_by":{"type":"object","description":"The webhook displays this field if the call was indirectly routed from an auto receptionist. A routing path example is selected as A->auto receptionist->call queue->B, where A and B are users. In this case, the call is indirectly forwarded by auto receptionist.","properties":{"name":{"type":"string","description":"The name of the extension the call was forwarded from."},"extension_number":{"type":"string","description":"The extension number the call was forwarded from."},"phone_number":{"type":"string","description":"The phone number the call was forwarded from."},"extension_type":{"type":"string","description":"The type of extension the call was forwarded from. Values: autoReceptionist"}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_answered\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998252113337041462\",\n      \"channel_id\": \"b21dee06-ddaa-4578-ab90-1dd6e50ea4ba\",\n      \"caller\": {\n        \"phone_number\": \"+12092592844\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_number\": 1002,\n        \"phone_number\": \"+12058945456\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"MAC_Client(5.7.5.1123)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"forwarded_by\": {\n        \"name\": \"TestCAP01\",\n        \"extension_type\": \"callQueue\",\n        \"extension_number\": \"1022\"\n      },\n      \"redirect_forwarded_by\": {\n        \"name\": \"TestAR01\",\n        \"extension_type\": \"autoReceptionist\",\n        \"extension_number\": \"100154\",\n        \"phone_number\": \"+12053953655\"\n      },\n      \"ringing_start_time\": \"2021-08-19T21:12:28Z\",\n      \"answer_start_time\": \"2021-08-19T21:12:38Z\",\n      \"sip_id\": \"168296889_92138195@50.232.196.82\"\n    }\n  },\n  \"event_ts\": 1629407570749\n}"}}}}}}}},"phone.warm_transfer_initiated":{"post":{"tags":["phone"],"operationId":"phone.warm_transfer_initiated","requestBody":{"description":"# phone.warm_transfer_initiated\n---\n\nThe **Warm transfer is initiated** event triggers when a call warm transfer is initiated.\n**Note**: Applicable only to Zoom desktop clients (version 6.1.0 or later) using Zoom native phone numbers. Not applicable to IP phones or BYOC numbers.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Warm transfer is initiated\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.warm_transfer_initiated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for the warm transfer. An empty string indicates a successful transfer."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner's name or identifier.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n* user\n* callQueue\n* autoReceptionist\n* commonAreaPhone\n* sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be a user's phone number, extension number, or phone number in E164 format."},"transfer_call_id":{"type":"string","description":"The newly generated call ID when the call is transferred."},"date_time":{"type":"string","description":"The date and time (GMT) when the call warm transfer was answered, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_initiated\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"transfer_call_id\": \"6986878782238080584\",\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for the warm transfer. An empty string indicates a successful transfer."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner's name or identifier.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n* user\n* callQueue\n* autoReceptionist\n* commonAreaPhone\n* sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be a user's phone number, extension number, or phone number in E164 format."},"transfer_call_id":{"type":"string","description":"The newly generated call ID when the call is transferred."},"date_time":{"type":"string","description":"The date and time (GMT) when the call warm transfer was answered, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_initiated\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"transfer_call_id\": \"6986878782238080584\",\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.caller_unmute":{"post":{"tags":["phone"],"operationId":"phone.caller_unmute","requestBody":{"description":"# phone.caller_unmute\n\nThe **Caller unmutes a phone call** event triggers when the caller unmutes during a call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Caller unmutes a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n`phone.caller_unmute`\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_unmute`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the caller unmuted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_unmute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the caller unmuted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_unmute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.device_registration":{"post":{"tags":["phone"],"operationId":"phone.device_registration","requestBody":{"description":"# phone.device_registration\n---\n\nThe **Desk phone registered** event triggers the first time a *new* desk phone or device is registered.\n\nTo receive this notification, you must meet the prerequisites listed below:\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event Notification Endpoint URL**.\n\t* **\"Desk phone registered\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:device:master`,`phone:read:device:admin`\n\n**Event type**: `phone.device_registration`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event.","default":"phone.device_registration"},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["device_id","device_name","mac_address"],"properties":{"device_id":{"type":"string","description":"The device ID."},"device_name":{"type":"string","description":"Device name."},"mac_address":{"type":"string","description":"MAC address or serial number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.device_registration\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"device_id\": \"JOZmuJ30Spyrw-v9vUzIrA\",\n      \"device_name\": \"New_DeskPhone\",\n      \"mac_address\": \"012345678912\"\n      }\n  },\n  \"event_ts\": 1625034680324\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event.","default":"phone.device_registration"},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["device_id","device_name","mac_address"],"properties":{"device_id":{"type":"string","description":"The device ID."},"device_name":{"type":"string","description":"Device name."},"mac_address":{"type":"string","description":"MAC address or serial number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.device_registration\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"device_id\": \"JOZmuJ30Spyrw-v9vUzIrA\",\n      \"device_name\": \"New_DeskPhone\",\n      \"mac_address\": \"012345678912\"\n      }\n  },\n  \"event_ts\": 1625034680324\n}"}}}}}}}},"phone.blind_transfer_initiated":{"post":{"tags":["phone"],"operationId":"phone.blind_transfer_initiated","requestBody":{"description":"# phone.blind_transfer_initiated\n---\n\nThe **Blind transfer is initiated** event triggers when a call blind transfer is initiated.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Blind transfer is initiated\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.blind_transfer_initiated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for blind transfer. If it is an empty string, it means success."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_phone_number":{"type":"string","description":"The phone number required for the blind transfer. It may be the user's phone number, extension number or the user's phone number that displays in E164 format."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call warm transfer was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.blind_transfer_initiated\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"failure_reason\": \"\",\n      \"call_id\" : \"6986878782238080581\",\n      \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","transfer_phone_number","date_time"],"properties":{"failure_reason":{"type":"string","description":"The failure reason for blind transfer. If it is an empty string, it means success."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_phone_number":{"type":"string","description":"The phone number required for the blind transfer. It may be the user's phone number, extension number or the user's phone number that displays in E164 format."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call warm transfer was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.blind_transfer_initiated\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"failure_reason\": \"\",\n      \"call_id\" : \"6986878782238080581\",\n      \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            },\n      \"transfer_phone_number\": \"+12055432724\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.caller_call_element_completed":{"post":{"tags":["phone"],"operationId":"phone.caller_call_element_completed","requestBody":{"description":"# phone.caller_call_element_completed\n---\nThe **Caller call element is completed** event triggers every time the outgoing call element record for a call is made available for the caller to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Caller call element is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.caller_call_element_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_element_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_elements","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_elements":{"type":"array","additionalItems":false,"items":{"type":"object","required":["call_element_id","call_history_uuid","call_id","result","start_time"],"properties":{"call_element_id":{"type":"string","description":"The ID of the call element."},"call_history_uuid":{"type":"string","description":"The call history ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_element_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_elements\": [\n        {\n          \"call_element_id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_history_uuid\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_element_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_elements","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_elements":{"type":"array","additionalItems":false,"items":{"type":"object","required":["call_element_id","call_history_uuid","call_id","result","start_time"],"properties":{"call_element_id":{"type":"string","description":"The ID of the call element."},"call_history_uuid":{"type":"string","description":"The call history ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_element_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_elements\": [\n        {\n          \"call_element_id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_history_uuid\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.account_settings_updated":{"post":{"tags":["phone"],"operationId":"phone.account_settings_updated","requestBody":{"description":"# phone.account_settings_updated\n---\n\nThe **Account settings updated** event is triggered every time an Account's settings are updated.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n* **\"Account settings updated\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:settings:master`,`phone:read:settings`,`phone:read:settings:admin`\n\n**Event type**: `phone.account_settings_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.account_settings_updated"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long (int64) format."},"payload":{"type":"object","required":["account_id","object","old_object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the account settings."},"object":{"type":"object","description":"Information about the account's updated settings.","required":["id","settings"],"properties":{"id":{"type":"string","description":"The updated account's ID."},"settings":{"type":"object","properties":{"call_live_transcription":{"description":"Whether to let users turn on live transcriptions for a call.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"transcription_start_prompt":{"type":"object","description":"Whether to play a prompt to call participants when the transcription has started.","properties":{"enable":{"type":"boolean","example":true},"audio_id":{"description":"The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, removed_vWby3OZaQlS1nAdmEAqgwA for example. You can still use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"description":"The audio prompt file name.","type":"string","example":"example.mp3"}}}}},"local_survivability_mode":{"type":"object","description":"Whether to allow user or extension to have core phone services in the event of an outage.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"external_calling_on_zoom_room_common_area":{"type":"object","description":"Whether to allow Zoom Rooms to call external phone numbers based on the calling plans and other Zoom Phone policies.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"select_outbound_caller_id":{"type":"object","description":"Whether to allow extensions to change outbound caller ID when placing calls.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_hide_outbound_caller_id":{"description":"Whether to allow extensions to hide outbound caller ID.","type":"boolean","example":true}}},"personal_audio_library":{"type":"object","description":"This field allows users to change their own Audio Library.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_music_on_hold_customization":{"description":"Whether to allow music on hold customization.","type":"boolean","example":true},"allow_voicemail_and_message_greeting_customization":{"description":"Whether to allow voicemail and message greeting customization.","type":"boolean","example":true}}},"voicemail":{"type":"object","description":"This field allows users to access, share, download, and to delete voicemail and videomail","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_videomail":{"description":"This setting allows videomail","type":"boolean","example":true},"allow_download":{"description":"This setting allows users to download their own voicemail or videomail.","type":"boolean","example":false},"allow_delete":{"description":"This setting allows users to delete their own voicemail or videomail.","type":"boolean","example":true},"allow_share":{"description":"This setting allows users to share their own voicemail.","type":"boolean","example":true},"allow_virtual_background":{"description":"This setting allows virtual background for voicemail or videomail greeting","type":"boolean","example":true}}},"voicemail_transcription":{"type":"object","description":"Whether to enable voicemail or videomail transcription feature for User, Auto Receptionist, Call Queue and Shared Line Groups.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"voicemail_notification_by_email":{"type":"object","description":"Whether to enable voicemail or videomail transcription feature for User, Auto Receptionist, Call Queue and Shared Line Groups.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"include_voicemail_file":{"description":"Whether to include the voicemail file.","type":"boolean","example":true},"include_voicemail_transcription":{"description":"Whether to include the voicemail transcription.","type":"boolean","example":false},"forward_voicemail_to_email":{"description":"Whether to forward the voicemail to email.","type":"boolean","example":true}}},"shared_voicemail_notification_by_email":{"type":"object","description":"Once enabled, users receive email notification when there is a new shared voicemail or videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, then users do not receive notifications. It only displays when the voicemail policy is using the new policy framework.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"restricted_call_hours":{"type":"object","description":"Once enabled, define when the extension or user cannot make or accept calls and send SMS.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"time_zone":{"type":"object","description":"This field sets either time zone id or set_by_extension.","properties":{"id":{"description":"The [time zone list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats.","type":"string","example":"America/Adak"},"name":{"description":"The time zone name. If time zone id is empty, it shows as setByExtension.","type":"string","example":"(GMT-9:00) Adak"}}},"restricted_hours_applied":{"description":"Whether restricted hours has been applied.","type":"boolean","example":false},"restricted_holiday_hours_applied":{"description":"Whether restricted holiday hours has been applied.","type":"boolean","example":false},"allow_internal_calls":{"description":"Whether to allow internal calls/SMS during restricted hours.","type":"boolean","example":true}}},"allowed_call_locations":{"type":"object","description":"Once enabled, define whether the extension or user can make and accept calls and send SMS.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"locations_applied":{"description":"Whether locations have been applied.","type":"boolean","example":false},"allow_internal_calls":{"description":"Whether to allow internal calls when outside of allowed locations","type":"boolean","example":true}}},"check_voicemails_over_phone":{"type":"object","description":"Whether to allow extension owners or members of a shared line group to check voicemails for extension numbers over the phone using PIN code.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"auto_call_recording":{"description":"Whether to allow automatic recording of all inbound and outbound calls.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"recording_calls":{"description":"The type of calls automatically recorded: \n* inbound \n* outbound \n* both","enum":["inbound","outbound","both"],"type":"string","example":"inbound"},"recording_transcription":{"description":"Whether call recording transcription is enabled.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_start_prompt_audio_id":{"description":"The audio that plays when the recording has started. You can use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"yCT14TwySDGVUypVlKNEyA"},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"allow_stop_resume_recording":{"description":"Whether the stop and resume of automatic call recording is enabled.","type":"boolean","example":true},"disconnect_on_recording_failure":{"description":"Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","description":"Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework.","properties":{"enable":{"description":"Whether to play a side tone beep for recorded users while recording.","type":"boolean","example":true},"play_beep_member":{"description":"Whether to play the recording beep tone all participants in the call or only the recording user. It displays only when enable is true.","type":"string","enum":["allMembers","recordingUser"],"example":"allMembers"},"play_beep_volume":{"description":"The volume of the side tone beep. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when enable is true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15}}}}},"ad_hoc_call_recording":{"type":"object","description":"Whether to allow extensions to record and save calls in the cloud.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"recording_transcription":{"description":"Whether to call recording transcription is enabled.","type":"boolean","example":true},"allow_download":{"description":"Whether to allow user to download their own ad-hoc recording.","type":"boolean","example":true},"allow_delete":{"description":"Whether to allow user to delete their own ad-hoc recording.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_explicit_consent":{"description":"Whether the Press 1 option for recording consent is enabled.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","description":"Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.","properties":{"enable":{"description":"Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_member":{"description":"Whether to  play the recording beep tone all participants in the call or only the recording user. It displays only when enable is true.","type":"string","enum":["allMembers","recordingUser"],"example":"allMembers"},"play_beep_volume":{"description":"The side tone beep volume. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when the enable is set to true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15}}}}},"international_calling":{"type":"object","description":"Whether to allow extensions to place international calls outside of the calling plan.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"outbound_calling":{"type":"object","description":"Whether to define calling rules to restrict user or extension from calling specific countries, cities, or numbers. \nNote: Only for use by customers who opted for OP flag Enable New Version Outbound Blocked List.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"outbound_sms":{"type":"object","description":"Whether to allow users to send and receive messages. You will need to assign a valid calling plan and phone number to each user for them to send and receive messages. \nNote: Only for use by customers who opted for OP flag Enable New Version Outbound Blocked List.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"sms":{"type":"object","description":"Whether to allow users to send and receive messages. You will need to assign a valid calling plan and phone number to each user for them to send and receive messages.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"international_sms":{"description":"Whether users can send and receive international messages. You can set this only if sms is enabled.","type":"boolean","example":true}}},"sms_etiquette_tool":{"type":"object","description":"This field identifies defined keywords and text patterns over SMS and prevents users from sharing unwanted messages.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"sms_etiquette_policy":{"type":"array","description":"The SMS etiquette policy. The maximum size is 50.","items":{"properties":{"id":{"description":"The SMS etiquette policy ID.","type":"string","example":"PdPtFFDbQhKr05WepCHhWQ"},"name":{"description":"The SMS etiquette policy name.","type":"string","example":"invalid symbol"},"description":{"description":"The SMS etiquette policy description.","type":"string","example":"invalid symbol"},"rule":{"description":"The SMS etiquette policy rule, 1 - Keywords, 2 - Regular Expression.","type":"integer","enum":[1,2],"example":1},"content":{"description":"The SMS etiquette policy content. For rule 1, add keywords separated by comma, the following characters are supported A-Z, a-z, 0-9. For rule 2, add regular expressions, back references and zero-width assertions area not supported.","type":"string","example":"test"},"action":{"description":"The actions taken when a policy is triggered, 1 - ask user to confirm sending of message, 2 - block the message.","type":"integer","enum":[1,2],"example":1},"active":{"description":"Whether active or not.","type":"boolean","example":true}},"type":"object"}}}},"zoom_phone_on_mobile":{"description":"Whether to allow users to use Zoom Phone on mobile clients (iOS, iPad OS and Android).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_calling_sms_mms":{"description":"This field allows calling and SMS or MMS functions on mobile.","type":"boolean","example":true,"deprecated":true},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is:\r\nios\r\nandroid\r\nintune\r\nblackberry","example":"ios","enum":["ios","android","intune","blackberry"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nios\r\nandroid\r\nintune\r\nblackberry.","example":"ios","enum":["ios","android","intune","blackberry"]}}}},"zoom_phone_on_pwa":{"description":"Whether to allow users to use Zoom Phone on Zoom Progressive Web App.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"e2e_encryption":{"description":"Whether to allow users to switch their calls to End-to-End Encryption. If users have Automatic Call Recording turned on, they will not be able to use End-to-End Encryption.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"call_handling_forwarding_to_other_users":{"description":"Whether to allow users to forward their calls to other numbers.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_forwarding_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"call_overflow":{"description":"Whether to allow users to forward their calls to other numbers when a call is not answered","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_overflow_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"call_transferring":{"description":"This setting allows users to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_transferring_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"elevate_to_meeting":{"description":"Whether to allow users to elevate their phone calls to a meeting.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"call_park":{"type":"object","description":"Whether to allow calls placed on hold to be resumed from another location using a retrieval code.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"expiration_period":{"description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60],"type":"integer","example":3},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer","example":50},"forward_to":{"description":"The extension's forwarding information.","properties":{"display_name":{"description":"The extension's name.","type":"string","example":"ZOOM_API Test"},"extension_id":{"description":"The extension ID.","type":"string","example":"TO586CYlQFC_WCUvPRXytA"},"extension_number":{"description":"The extension number.","type":"integer","example":100014},"extension_type":{"description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"],"type":"string","example":"user"},"id":{"description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","type":"string","example":"oG_nYRFuTJiY1tu0Fur_4Q"}},"type":"object"},"sequence":{"description":"This field is only used in the new policy framework. Choose how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment will park the call at the next available BLF key. Random assignment will park the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","type":"integer","enum":[0,1],"example":1},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}}}},"hand_off_to_room":{"description":"Whether to allow users to send a call to a Zoom Room.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"mobile_switch_to_carrier":{"description":"Whether to allow users to switch from a Zoom Phone to their native carrier.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"delegation":{"description":"Whether the user can use [call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation-shared-lines-appearance-).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"audio_intercom":{"description":"Whether to allow hands-free peer-to-peer conversations. When an intercom call is received, the phone beeps to notify the user of the incoming intercom call, and the user's phone automatically answers the intercom call.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"block_calls_without_caller_id":{"description":"Whether calls without caller ID will be blocked.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"block_external_calls":{"description":"This field allows you to set rules for blocking external calls during business, closed, and holiday hours. This feature is only available for user, Zoom Room, and common areas.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"block_business_hours":{"type":"boolean","description":"This field blocks external calls during business hours","example":true},"block_closed_hours":{"type":"boolean","description":"This field blocks external calls during closed hours","example":true},"block_holiday_hours":{"type":"boolean","description":"This field blocks external calls during holiday hours","example":true},"block_call_action":{"description":"The action when a call is blocked. 9 - Disconnect, 0- Forward to voicemail/videomail.","enum":[0,9],"type":"integer","example":0}}},"call_queue_opt_out_reason":{"description":"This field sets the opt-out reasons for call queues. When enabled, call queue members will need to select an opt-out reason when they turn off the receive queue call feature.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_queue_opt_out_reasons_list":{"type":"array","description":"The opt-out reasons list","items":{"type":"object","properties":{"code":{"type":"string","description":"Opt out code.","example":"Break"},"system":{"type":"boolean","description":"The system default reason. It cannot be edited.","example":true},"enable":{"type":"boolean","example":true}}}}}},"auto_delete_data_after_retention_duration":{"description":"This field allows Zoom to automatically delete data after the retention duration has lapsed.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"items":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The data types.","type":"string","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms","fax"],"example":"callLog"},"duration":{"description":"The retention duration where -1 means unlimited. For units of time, see the time_unit below. For year, the duration:-1, 1-10; for day, the duration:-1, 1-60; for month, the duration:-1, 1-18.","type":"integer","example":-1},"time_unit":{"description":"The unit of time.","type":"string","enum":["year","month","day"],"example":"year"}}}},"delete_type":{"description":"The deletion policy. <br>* 1 - soft delete <br>* 2 - permanent delete","type":"integer","enum":[1,2],"example":1},"permanently_delete_after_days":{"description":"Number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.","type":"integer","example":-1}}},"auto_call_from_third_party_apps":{"description":"This setting allows users to perform call control actions from authorized Zoom Marketplace apps.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"override_default_port":{"description":"This field sets a range for port assignment. Ports are used by Zoom desktop, mobile clients, Zoom Rooms and Zoom Phone Appliances during a call. The range should be between 9,000 and 9,999. At least 50 ports need to be configured to make sure the functionality is not affected..","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"min_port":{"type":"integer","description":"Min port.","example":9000},"max_port":{"type":"integer","description":"Max port.","example":9998}}},"peer_to_peer_media":{"description":"Whether to allow Zoom clients to send media directly to each other. Users or devices that have certain features like recording or monitoring enabled might not be able to use Peer to Peer Media.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"advanced_encryption":{"description":"Whether to allow voicemail to be encrypted with keys which are not accessible to Zoom servers. These voicemails can be decrypted only by the intended user recipient. Shared Line Appearance, Shared Line Group, Call Queue, or Auto Receptionist voicemail will not be encrypted, but can still be played. Email to voicemail, transcriptions, and the ability to check voicemails by dialing into the voicemail system or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user inherits this policy and does not have a Power Pack license, the policy will not be applied. Settings is only available with client version 5.12 or later.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"disable_incoming_unencrypted_voicemail":{"description":"Whether to disable incoming unencrypted voicemail","type":"boolean","example":true}}},"display_call_feedback_survey":{"description":"Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"feedback_type":{"description":"This field allows you to display feedback survey, 1 - display for every call, 2 - display when call quality issues are detected. Default 1, if set with value 2, need to set feed_back_mos or feedback_duration.","type":"integer","enum":[1,2],"example":1},"feedback_mos":{"description":"The MOS score. Min: 1.0, Max: 3.0, format one decimal point.","type":"object","properties":{"enable":{"type":"boolean","example":true},"min":{"type":"string","description":"Min","example":"1.1"},"max":{"type":"string","description":"Max","example":"3.0"}}},"feedback_duration":{"description":"The call duration, in seconds, 0-60.","type":"object","properties":{"enable":{"type":"boolean","example":true},"min":{"type":"integer","example":0},"max":{"type":"integer","example":60}}}}},"zoom_phone_on_desktop":{"description":"Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}}}},"allowed_device_locations":{"type":"object","description":"Define when hardware devices will be blocked. Devices can be disconnected and blocked from accessing the Zoom service when a device is detected outside an allowed network or when any network change is detected.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"block_devices_type":{"type":"string","description":"Block devices condition.","example":"network_change_detected","enum":["network_change_detected","outside_allowed_location"]}}},"allow_emergency_calls":{"type":"object","description":"Enables users to place emergency calls through the system. Disabling this setting will deactivate emergency call functionality.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"allow_emergency_calls_from_clients":{"type":"boolean","description":"Allow emergency calls for Zoom clients","example":true},"allow_emergency_calls_from_deskphones":{"type":"boolean","description":"Allow emergency calls for desk phone and Zoom Phone Appliances","example":true}}},"online_fax":{"type":"object","description":"Allow user to send and receive faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"enable_new_fax_email_notifications":{"type":"boolean","description":"Enable email notifications when a new fax is received","example":true},"include_fax_as_attachment":{"type":"boolean","description":"Include fax as an attachment in the email notification","example":false}}},"private_call_park":{"type":"object","description":"Allow calls placed on hold to be resumed by allowed users with the retrieval code.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"expiration_period":{"type":"integer","description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code generates.","example":3,"enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60]},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer","example":50},"forward_to":{"type":"object","properties":{"display_name":{"type":"string","description":"The extension's name.","example":"ZOOM_API Test"},"extension_id":{"type":"string","description":"The extension ID.","example":"TO586CYlQFC_WCUvPRXytA"},"extension_number":{"type":"integer","description":"The extension number.","format":"int64","example":100014},"extension_type":{"type":"string","description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","example":"user","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},"id":{"type":"string","description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","example":"oG_nYRFuTJiY1tu0Fur_4Q"}},"description":"The extension's forwarding information."},"sequence":{"type":"integer","description":"This field chooses how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment parks the call at the next available BLF key. Random assignment parks the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","example":1,"enum":[0,1]},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}}}},"sms_template":{"type":"object","description":"Use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"sms_template_list":{"maxItems":50,"type":"array","description":"The SMS template list.","items":{"type":"object","properties":{"sms_template_id":{"type":"string","description":"The SMS template ID.","example":"0qWIP8S8QXmo6KShUIyvZA"},"name":{"type":"string","description":"The SMS template name.","example":"name"},"description":{"type":"string","description":"The SMS template description.","example":"description"},"content":{"type":"string","description":"Text to Display. This text will be editable by users. Customer input fields may be added by using the buttons below. Customer information will be removed if not available. ","example":"content"},"active":{"type":"boolean","description":"Whether it is active.","example":true}}}}}},"call_screening":{"type":"object","description":"Incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"exclude_user_company_contacts":{"type":"boolean","description":"Exclude user and company contacts from call screening, calls will reach users as normal","example":true}}},"sms_auto_reply":{"type":"object","description":"Enable SMS Auto Reply feature for User, Auto Receptionist, and Call Queue. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"allow_end_user_edit_call_handling":{"type":"object","description":"Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"connect_to_operator":{"type":"object","description":"Once disabled, users will not be able to route their calls to an operator as part of the 'When a call is not answered' setting.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"no_hold_conference":{"type":"object","description":"Users can set up a conference call without any interruption in the current call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"conference_dtmf":{"type":"object","description":"This allows users to interact with automated systems, input access codes, or perform other functions without disrupting the call.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"end_conference_call_when_originator_drops":{"type":"object","description":"Once enabled, a personal conference call will end when the originator, who first merges other participant(s) into the conference call, drops. This will not affect the conference barge feature of Shared Line Group.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"chat_channel":{"type":"object","description":"Enable chat channel functionality for call queues","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"desk_phone_smart_key_positions_layout":{"type":"object","description":"Allow Zoom to move your frequently used line keys to your pre-programmed smart keys layout. Smart keys will be updated on a weekly basis.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"auto_opt_out_in_call_queue":{"type":"object","description":"Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"prompt_before_opt_out_call_queue":{"type":"boolean","description":"Always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom","example":true}}},"allow_mobile_home_phone_callout":{"type":"object","description":"Allow users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. Users' Call Me On phone number will be masked with Zoom Phone caller ID.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"use_callkit_for_incoming_call_notifications_in_ios":{"type":"object","description":"Use CallKit always for Incoming call notifications on iOS/iPadOS devices. When this feature is enabled for a user or common area, their iOS/iPadOS device will always use CallKit for incoming call notifications no matter if the Zoom App is running in the foreground or background, preventing interruptions when receiving inbound calls on the device. This setting only applies to iOS/iPadOS devices with CallKit enabled. If a user modifies this setting on their client, the value will be updated on this policy. Locking this policy will prevent users from making changes to the setting. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"hide_phone_call_history_in_ios":{"type":"object","description":"Hide Zoom Phone calls in iOS/iPadOS device call history. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"obfuscate_sensitive_data_during_call":{"type":"object","description":"Obfuscate sensitive data during a call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"prevent_users_upload_audio_files":{"type":"object","description":"Prevent users from uploading audio files","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"voicemail_tasks":{"type":"object","description":"Voicemail tasks with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"voicemail_intent_based_prioritization":{"type":"object","description":"Voicemail prioritization with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"team_sms_thread_summary":{"type":"object","description":"Team SMS thread summary with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"customize_line_name":{"type":"object","description":"Customize Line Name","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"user_line_name":{"type":"string","description":"The user line name.","example":"phoneNumber","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber","firstName;extensionNumber","firstName;lastName;extensionNumber"]},"common_area_line_name":{"type":"string","description":"The common area line name.","example":"phoneNumber","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber"]}}},"show_custom_disclaimer_when_using_zoom_phone":{"type":"object","description":"Show a custom disclaimer when starting to use Zoom Phone service","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"display_frequency":{"type":"string","description":"Display frequency","example":"first_time_only","enum":["first_time_only","every_time","every_month","every_quarter","every_6_months","every_year"]},"custom_disclaimer_list":{"type":"array","description":"Custom disclaimer list","items":{"type":"object","properties":{"language":{"type":"string","description":"The audio prompt language code.  \n  American English: en-US  \n \nBritish English: en-GB  \n \nEspa&ntilde;ol americano: es-US  \n \nFran&ccedil;ais canadien: fr-CA  \n \nDansk: da-DK  \n \nDeutsch: de-DE  \n \nEspa&ntilde;ol: es-ES  \n \nFran&ccedil;ais: fr-FR  \n \nItaliano: it-IT  \n \nNederlands: nl-NL  \n \nPortugues portugal: pt-PT  \n \nJapanese: ja-JP  \n \nKorean: ko-KO  \n \nPortugues brasil: pt-BR  \n \nChinese: zh-CN  \n \nTaiwanese: zh-TW  \n ","example":"en-GB"},"title":{"type":"string","description":"Custom disclaimer title","example":"tilte"},"body":{"type":"string","description":"Custom disclaimer body","example":"body"}}}}}}}}}},"old_object":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/properties/object"}},"restrictions_type":{"description":"1 - lowRestriction - Low restriction (external numbers not allowed)<br>\n2 - mediumRestriction - Medium restriction (external numbers and external contacts not allowed)<br>\n3 - highRestriction - High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed)<br>\n4 - noRestriction - No restriction","type":"integer","enum":[1,2,3,4],"example":1}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.account_settings_updated\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"id\": \"eUblMKLnTMKX0pVvNAlA0Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": false,\n            \"audio_id\": \"_rG7uKlJRAWn-013nTD1bA\",\n            \"audio_name\": \"hello1.mp3\"\n          }\n        }\n      }\n    },\n    \"old_object\": {\n      \"id\": \"eUblMKLnTMKX0pVvNAlA0Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": false,\n            \"audio_id\": \"tB-zbQ_WTIeYHFT7A9hPvw\",\n            \"audio_name\": \"congrats.mp3\"\n          }\n        }\n      }\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.account_settings_updated"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long (int64) format."},"payload":{"type":"object","required":["account_id","object","old_object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the account settings."},"object":{"type":"object","description":"Information about the account's updated settings.","required":["id","settings"],"properties":{"id":{"type":"string","description":"The updated account's ID."},"settings":{"type":"object","properties":{"call_live_transcription":{"description":"Whether to let users turn on live transcriptions for a call.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"transcription_start_prompt":{"type":"object","description":"Whether to play a prompt to call participants when the transcription has started.","properties":{"enable":{"type":"boolean","example":true},"audio_id":{"description":"The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, removed_vWby3OZaQlS1nAdmEAqgwA for example. You can still use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"description":"The audio prompt file name.","type":"string","example":"example.mp3"}}}}},"local_survivability_mode":{"type":"object","description":"Whether to allow user or extension to have core phone services in the event of an outage.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"external_calling_on_zoom_room_common_area":{"type":"object","description":"Whether to allow Zoom Rooms to call external phone numbers based on the calling plans and other Zoom Phone policies.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"select_outbound_caller_id":{"type":"object","description":"Whether to allow extensions to change outbound caller ID when placing calls.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_hide_outbound_caller_id":{"description":"Whether to allow extensions to hide outbound caller ID.","type":"boolean","example":true}}},"personal_audio_library":{"type":"object","description":"This field allows users to change their own Audio Library.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_music_on_hold_customization":{"description":"Whether to allow music on hold customization.","type":"boolean","example":true},"allow_voicemail_and_message_greeting_customization":{"description":"Whether to allow voicemail and message greeting customization.","type":"boolean","example":true}}},"voicemail":{"type":"object","description":"This field allows users to access, share, download, and to delete voicemail and videomail","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_videomail":{"description":"This setting allows videomail","type":"boolean","example":true},"allow_download":{"description":"This setting allows users to download their own voicemail or videomail.","type":"boolean","example":false},"allow_delete":{"description":"This setting allows users to delete their own voicemail or videomail.","type":"boolean","example":true},"allow_share":{"description":"This setting allows users to share their own voicemail.","type":"boolean","example":true},"allow_virtual_background":{"description":"This setting allows virtual background for voicemail or videomail greeting","type":"boolean","example":true}}},"voicemail_transcription":{"type":"object","description":"Whether to enable voicemail or videomail transcription feature for User, Auto Receptionist, Call Queue and Shared Line Groups.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"voicemail_notification_by_email":{"type":"object","description":"Whether to enable voicemail or videomail transcription feature for User, Auto Receptionist, Call Queue and Shared Line Groups.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"include_voicemail_file":{"description":"Whether to include the voicemail file.","type":"boolean","example":true},"include_voicemail_transcription":{"description":"Whether to include the voicemail transcription.","type":"boolean","example":false},"forward_voicemail_to_email":{"description":"Whether to forward the voicemail to email.","type":"boolean","example":true}}},"shared_voicemail_notification_by_email":{"type":"object","description":"Once enabled, users receive email notification when there is a new shared voicemail or videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, then users do not receive notifications. It only displays when the voicemail policy is using the new policy framework.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"restricted_call_hours":{"type":"object","description":"Once enabled, define when the extension or user cannot make or accept calls and send SMS.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"time_zone":{"type":"object","description":"This field sets either time zone id or set_by_extension.","properties":{"id":{"description":"The [time zone list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats.","type":"string","example":"America/Adak"},"name":{"description":"The time zone name. If time zone id is empty, it shows as setByExtension.","type":"string","example":"(GMT-9:00) Adak"}}},"restricted_hours_applied":{"description":"Whether restricted hours has been applied.","type":"boolean","example":false},"restricted_holiday_hours_applied":{"description":"Whether restricted holiday hours has been applied.","type":"boolean","example":false},"allow_internal_calls":{"description":"Whether to allow internal calls/SMS during restricted hours.","type":"boolean","example":true}}},"allowed_call_locations":{"type":"object","description":"Once enabled, define whether the extension or user can make and accept calls and send SMS.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"locations_applied":{"description":"Whether locations have been applied.","type":"boolean","example":false},"allow_internal_calls":{"description":"Whether to allow internal calls when outside of allowed locations","type":"boolean","example":true}}},"check_voicemails_over_phone":{"type":"object","description":"Whether to allow extension owners or members of a shared line group to check voicemails for extension numbers over the phone using PIN code.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"auto_call_recording":{"description":"Whether to allow automatic recording of all inbound and outbound calls.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"recording_calls":{"description":"The type of calls automatically recorded: \n* inbound \n* outbound \n* both","enum":["inbound","outbound","both"],"type":"string","example":"inbound"},"recording_transcription":{"description":"Whether call recording transcription is enabled.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_start_prompt_audio_id":{"description":"The audio that plays when the recording has started. You can use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"yCT14TwySDGVUypVlKNEyA"},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"allow_stop_resume_recording":{"description":"Whether the stop and resume of automatic call recording is enabled.","type":"boolean","example":true},"disconnect_on_recording_failure":{"description":"Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","description":"Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework.","properties":{"enable":{"description":"Whether to play a side tone beep for recorded users while recording.","type":"boolean","example":true},"play_beep_member":{"description":"Whether to play the recording beep tone all participants in the call or only the recording user. It displays only when enable is true.","type":"string","enum":["allMembers","recordingUser"],"example":"allMembers"},"play_beep_volume":{"description":"The volume of the side tone beep. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when enable is true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15}}}}},"ad_hoc_call_recording":{"type":"object","description":"Whether to allow extensions to record and save calls in the cloud.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"recording_transcription":{"description":"Whether to call recording transcription is enabled.","type":"boolean","example":true},"allow_download":{"description":"Whether to allow user to download their own ad-hoc recording.","type":"boolean","example":true},"allow_delete":{"description":"Whether to allow user to delete their own ad-hoc recording.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_explicit_consent":{"description":"Whether the Press 1 option for recording consent is enabled.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","description":"Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.","properties":{"enable":{"description":"Whether to play the side tone beep for recorded users while recording. It displays only when auto call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_member":{"description":"Whether to  play the recording beep tone all participants in the call or only the recording user. It displays only when enable is true.","type":"string","enum":["allMembers","recordingUser"],"example":"allMembers"},"play_beep_volume":{"description":"The side tone beep volume. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when the enable is set to true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15}}}}},"international_calling":{"type":"object","description":"Whether to allow extensions to place international calls outside of the calling plan.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"outbound_calling":{"type":"object","description":"Whether to define calling rules to restrict user or extension from calling specific countries, cities, or numbers. \nNote: Only for use by customers who opted for OP flag Enable New Version Outbound Blocked List.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"outbound_sms":{"type":"object","description":"Whether to allow users to send and receive messages. You will need to assign a valid calling plan and phone number to each user for them to send and receive messages. \nNote: Only for use by customers who opted for OP flag Enable New Version Outbound Blocked List.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"sms":{"type":"object","description":"Whether to allow users to send and receive messages. You will need to assign a valid calling plan and phone number to each user for them to send and receive messages.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"international_sms":{"description":"Whether users can send and receive international messages. You can set this only if sms is enabled.","type":"boolean","example":true}}},"sms_etiquette_tool":{"type":"object","description":"This field identifies defined keywords and text patterns over SMS and prevents users from sharing unwanted messages.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"sms_etiquette_policy":{"type":"array","description":"The SMS etiquette policy. The maximum size is 50.","items":{"properties":{"id":{"description":"The SMS etiquette policy ID.","type":"string","example":"PdPtFFDbQhKr05WepCHhWQ"},"name":{"description":"The SMS etiquette policy name.","type":"string","example":"invalid symbol"},"description":{"description":"The SMS etiquette policy description.","type":"string","example":"invalid symbol"},"rule":{"description":"The SMS etiquette policy rule, 1 - Keywords, 2 - Regular Expression.","type":"integer","enum":[1,2],"example":1},"content":{"description":"The SMS etiquette policy content. For rule 1, add keywords separated by comma, the following characters are supported A-Z, a-z, 0-9. For rule 2, add regular expressions, back references and zero-width assertions area not supported.","type":"string","example":"test"},"action":{"description":"The actions taken when a policy is triggered, 1 - ask user to confirm sending of message, 2 - block the message.","type":"integer","enum":[1,2],"example":1},"active":{"description":"Whether active or not.","type":"boolean","example":true}},"type":"object"}}}},"zoom_phone_on_mobile":{"description":"Whether to allow users to use Zoom Phone on mobile clients (iOS, iPad OS and Android).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_calling_sms_mms":{"description":"This field allows calling and SMS or MMS functions on mobile.","type":"boolean","example":true,"deprecated":true},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is:\r\nios\r\nandroid\r\nintune\r\nblackberry","example":"ios","enum":["ios","android","intune","blackberry"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nios\r\nandroid\r\nintune\r\nblackberry.","example":"ios","enum":["ios","android","intune","blackberry"]}}}},"zoom_phone_on_pwa":{"description":"Whether to allow users to use Zoom Phone on Zoom Progressive Web App.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"e2e_encryption":{"description":"Whether to allow users to switch their calls to End-to-End Encryption. If users have Automatic Call Recording turned on, they will not be able to use End-to-End Encryption.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"call_handling_forwarding_to_other_users":{"description":"Whether to allow users to forward their calls to other numbers.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_forwarding_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"call_overflow":{"description":"Whether to allow users to forward their calls to other numbers when a call is not answered","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_overflow_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"call_transferring":{"description":"This setting allows users to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_transferring_type":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/restrictions_type"}}},"elevate_to_meeting":{"description":"Whether to allow users to elevate their phone calls to a meeting.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"call_park":{"type":"object","description":"Whether to allow calls placed on hold to be resumed from another location using a retrieval code.","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"expiration_period":{"description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60],"type":"integer","example":3},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer","example":50},"forward_to":{"description":"The extension's forwarding information.","properties":{"display_name":{"description":"The extension's name.","type":"string","example":"ZOOM_API Test"},"extension_id":{"description":"The extension ID.","type":"string","example":"TO586CYlQFC_WCUvPRXytA"},"extension_number":{"description":"The extension number.","type":"integer","example":100014},"extension_type":{"description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"],"type":"string","example":"user"},"id":{"description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","type":"string","example":"oG_nYRFuTJiY1tu0Fur_4Q"}},"type":"object"},"sequence":{"description":"This field is only used in the new policy framework. Choose how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment will park the call at the next available BLF key. Random assignment will park the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","type":"integer","enum":[0,1],"example":1},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}}}},"hand_off_to_room":{"description":"Whether to allow users to send a call to a Zoom Room.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"mobile_switch_to_carrier":{"description":"Whether to allow users to switch from a Zoom Phone to their native carrier.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"delegation":{"description":"Whether the user can use [call delegation](https://support.zoom.us/hc/en-us/articles/360032881731-Setting-up-call-delegation-shared-lines-appearance-).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"audio_intercom":{"description":"Whether to allow hands-free peer-to-peer conversations. When an intercom call is received, the phone beeps to notify the user of the incoming intercom call, and the user's phone automatically answers the intercom call.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"block_calls_without_caller_id":{"description":"Whether calls without caller ID will be blocked.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"block_external_calls":{"description":"This field allows you to set rules for blocking external calls during business, closed, and holiday hours. This feature is only available for user, Zoom Room, and common areas.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"block_business_hours":{"type":"boolean","description":"This field blocks external calls during business hours","example":true},"block_closed_hours":{"type":"boolean","description":"This field blocks external calls during closed hours","example":true},"block_holiday_hours":{"type":"boolean","description":"This field blocks external calls during holiday hours","example":true},"block_call_action":{"description":"The action when a call is blocked. 9 - Disconnect, 0- Forward to voicemail/videomail.","enum":[0,9],"type":"integer","example":0}}},"call_queue_opt_out_reason":{"description":"This field sets the opt-out reasons for call queues. When enabled, call queue members will need to select an opt-out reason when they turn off the receive queue call feature.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"call_queue_opt_out_reasons_list":{"type":"array","description":"The opt-out reasons list","items":{"type":"object","properties":{"code":{"type":"string","description":"Opt out code.","example":"Break"},"system":{"type":"boolean","description":"The system default reason. It cannot be edited.","example":true},"enable":{"type":"boolean","example":true}}}}}},"auto_delete_data_after_retention_duration":{"description":"This field allows Zoom to automatically delete data after the retention duration has lapsed.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"items":{"type":"array","items":{"type":"object","properties":{"type":{"description":"The data types.","type":"string","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms","fax"],"example":"callLog"},"duration":{"description":"The retention duration where -1 means unlimited. For units of time, see the time_unit below. For year, the duration:-1, 1-10; for day, the duration:-1, 1-60; for month, the duration:-1, 1-18.","type":"integer","example":-1},"time_unit":{"description":"The unit of time.","type":"string","enum":["year","month","day"],"example":"year"}}}},"delete_type":{"description":"The deletion policy. <br>* 1 - soft delete <br>* 2 - permanent delete","type":"integer","enum":[1,2],"example":1},"permanently_delete_after_days":{"description":"Number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.","type":"integer","example":-1}}},"auto_call_from_third_party_apps":{"description":"This setting allows users to perform call control actions from authorized Zoom Marketplace apps.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"override_default_port":{"description":"This field sets a range for port assignment. Ports are used by Zoom desktop, mobile clients, Zoom Rooms and Zoom Phone Appliances during a call. The range should be between 9,000 and 9,999. At least 50 ports need to be configured to make sure the functionality is not affected..","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"min_port":{"type":"integer","description":"Min port.","example":9000},"max_port":{"type":"integer","description":"Max port.","example":9998}}},"peer_to_peer_media":{"description":"Whether to allow Zoom clients to send media directly to each other. Users or devices that have certain features like recording or monitoring enabled might not be able to use Peer to Peer Media.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"}}},"advanced_encryption":{"description":"Whether to allow voicemail to be encrypted with keys which are not accessible to Zoom servers. These voicemails can be decrypted only by the intended user recipient. Shared Line Appearance, Shared Line Group, Call Queue, or Auto Receptionist voicemail will not be encrypted, but can still be played. Email to voicemail, transcriptions, and the ability to check voicemails by dialing into the voicemail system or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user inherits this policy and does not have a Power Pack license, the policy will not be applied. Settings is only available with client version 5.12 or later.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"disable_incoming_unencrypted_voicemail":{"description":"Whether to disable incoming unencrypted voicemail","type":"boolean","example":true}}},"display_call_feedback_survey":{"description":"Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong.","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"feedback_type":{"description":"This field allows you to display feedback survey, 1 - display for every call, 2 - display when call quality issues are detected. Default 1, if set with value 2, need to set feed_back_mos or feedback_duration.","type":"integer","enum":[1,2],"example":1},"feedback_mos":{"description":"The MOS score. Min: 1.0, Max: 3.0, format one decimal point.","type":"object","properties":{"enable":{"type":"boolean","example":true},"min":{"type":"string","description":"Min","example":"1.1"},"max":{"type":"string","description":"Max","example":"3.0"}}},"feedback_duration":{"description":"The call duration, in seconds, 0-60.","type":"object","properties":{"enable":{"type":"boolean","example":true},"min":{"type":"integer","example":0},"max":{"type":"integer","example":60}}}}},"zoom_phone_on_desktop":{"description":"Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account"],"type":"string","example":"account"},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}}}},"allowed_device_locations":{"type":"object","description":"Define when hardware devices will be blocked. Devices can be disconnected and blocked from accessing the Zoom service when a device is detected outside an allowed network or when any network change is detected.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"block_devices_type":{"type":"string","description":"Block devices condition.","example":"network_change_detected","enum":["network_change_detected","outside_allowed_location"]}}},"allow_emergency_calls":{"type":"object","description":"Enables users to place emergency calls through the system. Disabling this setting will deactivate emergency call functionality.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"allow_emergency_calls_from_clients":{"type":"boolean","description":"Allow emergency calls for Zoom clients","example":true},"allow_emergency_calls_from_deskphones":{"type":"boolean","description":"Allow emergency calls for desk phone and Zoom Phone Appliances","example":true}}},"online_fax":{"type":"object","description":"Allow user to send and receive faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"enable_new_fax_email_notifications":{"type":"boolean","description":"Enable email notifications when a new fax is received","example":true},"include_fax_as_attachment":{"type":"boolean","description":"Include fax as an attachment in the email notification","example":false}}},"private_call_park":{"type":"object","description":"Allow calls placed on hold to be resumed by allowed users with the retrieval code.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"expiration_period":{"type":"integer","description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code generates.","example":3,"enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60]},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer","example":50},"forward_to":{"type":"object","properties":{"display_name":{"type":"string","description":"The extension's name.","example":"ZOOM_API Test"},"extension_id":{"type":"string","description":"The extension ID.","example":"TO586CYlQFC_WCUvPRXytA"},"extension_number":{"type":"integer","description":"The extension number.","format":"int64","example":100014},"extension_type":{"type":"string","description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","example":"user","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"]},"id":{"type":"string","description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","example":"oG_nYRFuTJiY1tu0Fur_4Q"}},"description":"The extension's forwarding information."},"sequence":{"type":"integer","description":"This field chooses how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment parks the call at the next available BLF key. Random assignment parks the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","example":1,"enum":[0,1]},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}}}},"sms_template":{"type":"object","description":"Use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"sms_template_list":{"maxItems":50,"type":"array","description":"The SMS template list.","items":{"type":"object","properties":{"sms_template_id":{"type":"string","description":"The SMS template ID.","example":"0qWIP8S8QXmo6KShUIyvZA"},"name":{"type":"string","description":"The SMS template name.","example":"name"},"description":{"type":"string","description":"The SMS template description.","example":"description"},"content":{"type":"string","description":"Text to Display. This text will be editable by users. Customer input fields may be added by using the buttons below. Customer information will be removed if not available. ","example":"content"},"active":{"type":"boolean","description":"Whether it is active.","example":true}}}}}},"call_screening":{"type":"object","description":"Incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"exclude_user_company_contacts":{"type":"boolean","description":"Exclude user and company contacts from call screening, calls will reach users as normal","example":true}}},"sms_auto_reply":{"type":"object","description":"Enable SMS Auto Reply feature for User, Auto Receptionist, and Call Queue. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"allow_end_user_edit_call_handling":{"type":"object","description":"Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"connect_to_operator":{"type":"object","description":"Once disabled, users will not be able to route their calls to an operator as part of the 'When a call is not answered' setting.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"no_hold_conference":{"type":"object","description":"Users can set up a conference call without any interruption in the current call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"conference_dtmf":{"type":"object","description":"This allows users to interact with automated systems, input access codes, or perform other functions without disrupting the call.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"end_conference_call_when_originator_drops":{"type":"object","description":"Once enabled, a personal conference call will end when the originator, who first merges other participant(s) into the conference call, drops. This will not affect the conference barge feature of Shared Line Group.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"chat_channel":{"type":"object","description":"Enable chat channel functionality for call queues","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"desk_phone_smart_key_positions_layout":{"type":"object","description":"Allow Zoom to move your frequently used line keys to your pre-programmed smart keys layout. Smart keys will be updated on a weekly basis.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"auto_opt_out_in_call_queue":{"type":"object","description":"Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"prompt_before_opt_out_call_queue":{"type":"boolean","description":"Always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom","example":true}}},"allow_mobile_home_phone_callout":{"type":"object","description":"Allow users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. Users' Call Me On phone number will be masked with Zoom Phone caller ID.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"use_callkit_for_incoming_call_notifications_in_ios":{"type":"object","description":"Use CallKit always for Incoming call notifications on iOS/iPadOS devices. When this feature is enabled for a user or common area, their iOS/iPadOS device will always use CallKit for incoming call notifications no matter if the Zoom App is running in the foreground or background, preventing interruptions when receiving inbound calls on the device. This setting only applies to iOS/iPadOS devices with CallKit enabled. If a user modifies this setting on their client, the value will be updated on this policy. Locking this policy will prevent users from making changes to the setting. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"hide_phone_call_history_in_ios":{"type":"object","description":"Hide Zoom Phone calls in iOS/iPadOS device call history. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"obfuscate_sensitive_data_during_call":{"type":"object","description":"Obfuscate sensitive data during a call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"prevent_users_upload_audio_files":{"type":"object","description":"Prevent users from uploading audio files","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"voicemail_tasks":{"type":"object","description":"Voicemail tasks with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"voicemail_intent_based_prioritization":{"type":"object","description":"Voicemail prioritization with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"team_sms_thread_summary":{"type":"object","description":"Team SMS thread summary with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]}}},"customize_line_name":{"type":"object","description":"Customize Line Name","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"user_line_name":{"type":"string","description":"The user line name.","example":"phoneNumber","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber","firstName;extensionNumber","firstName;lastName;extensionNumber"]},"common_area_line_name":{"type":"string","description":"The common area line name.","example":"phoneNumber","enum":["phoneNumber","extensionNumber","displayName","displayName;extensionNumber"]}}},"show_custom_disclaimer_when_using_zoom_phone":{"type":"object","description":"Show a custom disclaimer when starting to use Zoom Phone service","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account"]},"display_frequency":{"type":"string","description":"Display frequency","example":"first_time_only","enum":["first_time_only","every_time","every_month","every_quarter","every_6_months","every_year"]},"custom_disclaimer_list":{"type":"array","description":"Custom disclaimer list","items":{"type":"object","properties":{"language":{"type":"string","description":"The audio prompt language code.  \n  American English: en-US  \n \nBritish English: en-GB  \n \nEspa&ntilde;ol americano: es-US  \n \nFran&ccedil;ais canadien: fr-CA  \n \nDansk: da-DK  \n \nDeutsch: de-DE  \n \nEspa&ntilde;ol: es-ES  \n \nFran&ccedil;ais: fr-FR  \n \nItaliano: it-IT  \n \nNederlands: nl-NL  \n \nPortugues portugal: pt-PT  \n \nJapanese: ja-JP  \n \nKorean: ko-KO  \n \nPortugues brasil: pt-BR  \n \nChinese: zh-CN  \n \nTaiwanese: zh-TW  \n ","example":"en-GB"},"title":{"type":"string","description":"Custom disclaimer title","example":"tilte"},"body":{"type":"string","description":"Custom disclaimer body","example":"body"}}}}}}}}}},"old_object":{"$ref":"#/paths/phone.account_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/properties/object"}},"restrictions_type":{"description":"1 - lowRestriction - Low restriction (external numbers not allowed)<br>\n2 - mediumRestriction - Medium restriction (external numbers and external contacts not allowed)<br>\n3 - highRestriction - High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed)<br>\n4 - noRestriction - No restriction","type":"integer","enum":[1,2,3,4],"example":1}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.account_settings_updated\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"id\": \"eUblMKLnTMKX0pVvNAlA0Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": false,\n            \"audio_id\": \"_rG7uKlJRAWn-013nTD1bA\",\n            \"audio_name\": \"hello1.mp3\"\n          }\n        }\n      }\n    },\n    \"old_object\": {\n      \"id\": \"eUblMKLnTMKX0pVvNAlA0Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": false,\n            \"audio_id\": \"tB-zbQ_WTIeYHFT7A9hPvw\",\n            \"audio_name\": \"congrats.mp3\"\n          }\n        }\n      }\n    }\n  }\n}"}}}}}}}},"phone.callee_meeting_inviting":{"post":{"tags":["phone"],"operationId":"phone.callee_meeting_inviting","requestBody":{"description":"# phone.callee_meeting_inviting\n---\n\nThe **Callee invited to join a meeting** event triggers each time a callee over Zoom Phone escalates a phone call to a Zoom meeting.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Callee invited to join a meeting**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_meeting_inviting`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"meeting_id":{"type":"string","description":"The meeting's unique ID. This is also known as the meeting number.","format":"int64"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call escalated to a meeting, in yyyy-MM-dd'T'HH:mm:ss'Z' format.","format":"date-time"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_meeting_inviting\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 555011,\n        \"phone_number\" : \"555011\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 555010,\n        \"phone_number\" : \"555010\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"meeting_id\": \"987654321\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"meeting_id":{"type":"string","description":"The meeting's unique ID. This is also known as the meeting number.","format":"int64"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call escalated to a meeting, in yyyy-MM-dd'T'HH:mm:ss'Z' format.","format":"date-time"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_meeting_inviting\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 555011,\n        \"phone_number\" : \"555011\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 555010,\n        \"phone_number\" : \"555010\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"meeting_id\": \"987654321\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.callee_parked":{"post":{"tags":["phone"],"operationId":"phone.callee_parked","requestBody":{"description":"# phone.callee_parked\n---\n\nThe **Callee [parks a phone call](https://support.zoom.us/hc/en-us/articles/360042175291-Using-call-park)** event triggers every time the callee parks a phone call over a Zoom Phone.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Callee park a phone call**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_parked`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"park_code":{"type":"string","description":"The code to connect with caller."},"park_failure_reason":{"type":"string","description":"The reason why park failure"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call park began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_parked\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"pstn_on_net\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"park_code\": \"*869\",\n      \"park_failure_reason\": \"Park successfully.\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"park_code":{"type":"string","description":"The code to connect with caller."},"park_failure_reason":{"type":"string","description":"The reason why park failure"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call park began, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_parked\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"pstn_on_net\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"park_code\": \"*869\",\n      \"park_failure_reason\": \"Park successfully.\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.emergency_alert":{"post":{"tags":["phone"],"operationId":"phone.emergency_alert","requestBody":{"description":"# phone.emergency_alert\n---\n\nThe **Emergency Call Alert** event triggers every time Zoom phone users dial 911 from their Zoom phone. To receive this notification, you must meet the prerequisites.\n\n## Prerequisites\n* User must have enrolled in a [Zoom Phone Plan](https://zoom.us/phonesystem).\n* User must have enabled [normadic emergency service](https://support.zoom.us/hc/en-us/articles/360042699912-Setting-up-nomadic-emergency-services) and [emergency addresses](https://support.zoom.us/hc/en-us/articles/360021062871).\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event Notification Endpoint URL**.\n\t* An **Emergency Call Alert** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_e911:read:admin`,`phone_e911:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.emergency_alert`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["object","account_id"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","location","router","deliver_to","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"caller":{"type":"object","description":"The caller object that represents the person who initiated the call.","required":["id","extension_type"],"properties":{"id":{"type":"string","description":"The Zoom User ID of the caller."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"string","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"display_name":{"type":"string","description":"The display name of the caller."},"extension_type":{"type":"string","description":"The extension type. ","enum":["user","interop","commonAreaPhone"]},"site_id":{"type":"string","description":"The unique identifier of the caller's [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."},"site_name":{"type":"string","description":"The name of the site."}}},"callee":{"type":"object","description":"The callee object that represents the person who is called by the caller.","properties":{"phone_number":{"type":"string","description":"The phone number of the callee."}}},"location":{"type":"object","properties":{"gps":{"type":"array","description":"The GPS location of the caller's device.","items":{"type":"string"}},"ip":{"type":"array","description":"The IP address of the caller.","items":{"type":"string"}},"bssid":{"type":"array","description":"The basic service set identifier of the caller's device.","items":{"type":"string"}}}},"router":{"type":"string","description":"This field indicates where the call was originally routed from.","enum":["ZOOM","BYOC Carrier","Mobile Carrier"]},"deliver_to":{"type":"string","description":"This field indicates where the call was routed to.","enum":["PSAP","SAFETY_TEAM","NONE","BOTH","MOBILE_911_CALL","SIP_GROUP","BOTH_SAFETY_TEAM_AND_SIP","OVERFLOW_TO_SIP_GROUP","TO_PSAP_FOR_MISSED_BY_SAFETY_TEAM"]},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"emergency_address":{"type":"object","properties":{"country":{"type":"string","description":"The abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the user's country."},"address_line1":{"type":"string","description":"The emergency address(house number and street name) assigned to the user."},"address_line2":{"type":"string","description":"The additional emergency address information(building number, floor number, unit) assigned to the user. "},"city":{"type":"string","description":"The user's city."},"zip":{"type":"string","description":"The zip code of the user."},"state_code":{"type":"string","description":"The abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the user's state."}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.emergency_alert\",\n  \"payload\": {\n    \"object\": {\n      \"caller\": {\n        \"id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"extension_number\": \"1002\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"display_name\": \"pbxta api\",\n        \"extension_type\": \"user\",\n        \"site_id\": \"8f71O6rWT8KFUGQmJIFAdQ\",\n        \"site_name\": \"Main Site\"\n      },\n      \"callee\": {\n        \"phone_number\": \"933\"\n      },\n      \"location\": {\n        \"gps\": [\n          \"31.29846,120.6645\"\n        ],\n        \"ip\": [\n          \"192.0.2.1,192.0.2.2\"\n        ],\n        \"bssid\": [\n          \"fc:7f:49:12:45:01\"\n        ]\n      },\n      \"router\": \"ZOOM\",\n      \"call_id\": \"6998308626516675500\",\n      \"ringing_start_time\": \"2021-08-20T00:51:52Z\",\n      \"emergency_address\": {},\n      \"deliver_to\": \"SAFETY_TEAM\"\n    },\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\"\n  },\n  \"event_ts\": 1629420725562\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["object","account_id"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_id","caller","callee","location","router","deliver_to","ringing_start_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"caller":{"type":"object","description":"The caller object that represents the person who initiated the call.","required":["id","extension_type"],"properties":{"id":{"type":"string","description":"The Zoom User ID of the caller."},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"extension_number":{"type":"string","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"display_name":{"type":"string","description":"The display name of the caller."},"extension_type":{"type":"string","description":"The extension type. ","enum":["user","interop","commonAreaPhone"]},"site_id":{"type":"string","description":"The unique identifier of the caller's [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites)."},"site_name":{"type":"string","description":"The name of the site."}}},"callee":{"type":"object","description":"The callee object that represents the person who is called by the caller.","properties":{"phone_number":{"type":"string","description":"The phone number of the callee."}}},"location":{"type":"object","properties":{"gps":{"type":"array","description":"The GPS location of the caller's device.","items":{"type":"string"}},"ip":{"type":"array","description":"The IP address of the caller.","items":{"type":"string"}},"bssid":{"type":"array","description":"The basic service set identifier of the caller's device.","items":{"type":"string"}}}},"router":{"type":"string","description":"This field indicates where the call was originally routed from.","enum":["ZOOM","BYOC Carrier","Mobile Carrier"]},"deliver_to":{"type":"string","description":"This field indicates where the call was routed to.","enum":["PSAP","SAFETY_TEAM","NONE","BOTH","MOBILE_911_CALL","SIP_GROUP","BOTH_SAFETY_TEAM_AND_SIP","OVERFLOW_TO_SIP_GROUP","TO_PSAP_FOR_MISSED_BY_SAFETY_TEAM"]},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started in \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"emergency_address":{"type":"object","properties":{"country":{"type":"string","description":"The abbreviated [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the user's country."},"address_line1":{"type":"string","description":"The emergency address(house number and street name) assigned to the user."},"address_line2":{"type":"string","description":"The additional emergency address information(building number, floor number, unit) assigned to the user. "},"city":{"type":"string","description":"The user's city."},"zip":{"type":"string","description":"The zip code of the user."},"state_code":{"type":"string","description":"The abbreviated [state code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#states-1) of the user's state."}}}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.emergency_alert\",\n  \"payload\": {\n    \"object\": {\n      \"caller\": {\n        \"id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"extension_number\": \"1002\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"display_name\": \"pbxta api\",\n        \"extension_type\": \"user\",\n        \"site_id\": \"8f71O6rWT8KFUGQmJIFAdQ\",\n        \"site_name\": \"Main Site\"\n      },\n      \"callee\": {\n        \"phone_number\": \"933\"\n      },\n      \"location\": {\n        \"gps\": [\n          \"31.29846,120.6645\"\n        ],\n        \"ip\": [\n          \"192.0.2.1,192.0.2.2\"\n        ],\n        \"bssid\": [\n          \"fc:7f:49:12:45:01\"\n        ]\n      },\n      \"router\": \"ZOOM\",\n      \"call_id\": \"6998308626516675500\",\n      \"ringing_start_time\": \"2021-08-20T00:51:52Z\",\n      \"emergency_address\": {},\n      \"deliver_to\": \"SAFETY_TEAM\"\n    },\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\"\n  },\n  \"event_ts\": 1629420725562\n}"}}}}}}}},"phone.ai_call_summary_changed":{"post":{"tags":["phone"],"operationId":"phone.ai_call_summary_changed","requestBody":{"description":"# phone.ai_call_summary_changed\n---\n\nThe **Call summary changed** event triggers when the system generates or updates an AI call summary.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://developers.zoom.us/docs/api/rest/webhook-reference/#enable-webhooks).\n\t* **Call summary changed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.ai_call_summary_changed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since the epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The user's account ID."},"object":{"type":"object","required":["ai_call_summary_id","user_id","call_id"],"properties":{"edited":{"type":"boolean","description":"Whether the call summary is edited.","example":true},"deleted":{"type":"boolean","description":"Whether the call summary is deleted.","example":true},"ai_call_summary_id":{"type":"string","description":"The ID of AI call summary.","example":"HfBQmSIARZi5zeDMmofwTA"},"user_id":{"type":"string","description":"The user ID.","example":"FvB3CRfOQUuhF1IOB176Tg"},"call_id":{"type":"string","description":"The call ID of the call summary.","example":"7018317023722949162"},"call_log_ids":{"type":"array","description":"The list of call log IDs for the call summary.","items":{"type":"string","example":"b8a98b45-09c4-4828-988d-eaa886d039ef"},"maxItems":10},"created_time":{"type":"string","description":"The created time in GMT date-time format.","example":"2023-10-08T16:12:04Z"},"modified_time":{"type":"string","description":"The modified time in GMT date-time format.","example":"2023-10-08T16:12:04Z"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.ai_call_summary_changed\",\n  \"payload\": {\n    \"account_id\": \"89gnHJQ9SdSmFpI9wmh6fQ\",\n    \"object\": {\n      \"edited\": true,\n      \"deleted\": false,\n      \"ai_call_summary_id\": \"iNsfqK6gQOCiILiKhrlLqQ\",\n      \"user_id\": \"FvB3CRfOQUuhF1IOB176Tg\",\n      \"call_id\": \"066bd0dee0066150033\",\n      \"call_log_ids\": [\n        \"6afdf3e3-87e3-47d0-834c-6ee3598e3b96\",\n        \"6afdf3e3-87e3-47d0-834c-6ee3598e3b00\"\n      ],\n      \"created_time\": \"2023-10-08T16:12:04Z\",\n      \"modified_time\": \"2023-10-08T16:12:04Z\"\n    }\n  },\n  \"event_ts\": 1724455515040\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since the epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The user's account ID."},"object":{"type":"object","required":["ai_call_summary_id","user_id","call_id"],"properties":{"edited":{"type":"boolean","description":"Whether the call summary is edited.","example":true},"deleted":{"type":"boolean","description":"Whether the call summary is deleted.","example":true},"ai_call_summary_id":{"type":"string","description":"The ID of AI call summary.","example":"HfBQmSIARZi5zeDMmofwTA"},"user_id":{"type":"string","description":"The user ID.","example":"FvB3CRfOQUuhF1IOB176Tg"},"call_id":{"type":"string","description":"The call ID of the call summary.","example":"7018317023722949162"},"call_log_ids":{"type":"array","description":"The list of call log IDs for the call summary.","items":{"type":"string","example":"b8a98b45-09c4-4828-988d-eaa886d039ef"},"maxItems":10},"created_time":{"type":"string","description":"The created time in GMT date-time format.","example":"2023-10-08T16:12:04Z"},"modified_time":{"type":"string","description":"The modified time in GMT date-time format.","example":"2023-10-08T16:12:04Z"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.ai_call_summary_changed\",\n  \"payload\": {\n    \"account_id\": \"89gnHJQ9SdSmFpI9wmh6fQ\",\n    \"object\": {\n      \"edited\": true,\n      \"deleted\": false,\n      \"ai_call_summary_id\": \"iNsfqK6gQOCiILiKhrlLqQ\",\n      \"user_id\": \"FvB3CRfOQUuhF1IOB176Tg\",\n      \"call_id\": \"066bd0dee0066150033\",\n      \"call_log_ids\": [\n        \"6afdf3e3-87e3-47d0-834c-6ee3598e3b96\",\n        \"6afdf3e3-87e3-47d0-834c-6ee3598e3b00\"\n      ],\n      \"created_time\": \"2023-10-08T16:12:04Z\",\n      \"modified_time\": \"2023-10-08T16:12:04Z\"\n    }\n  },\n  \"event_ts\": 1724455515040\n}"}}}}}}}},"phone.callee_rejected":{"post":{"tags":["phone"],"operationId":"phone.callee_rejected","requestBody":{"description":"# phone.callee_rejected\n---\nThe **Callee rejected a phone call** event triggers whenever a callee, who is either a user in your account or a user of your app, declines an incoming call on their Zoom Phone.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event notification endpoint URL**.\n\t* **Callee rejected a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_rejected`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"Thr Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The callee declined the call at a specific GMT time. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"handup_result":{"type":"string","description":"The reason the call was rejected. Values: Rejected"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_rejected\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998308781135528785\",\n      \"channel_id\": \"7bfb20d5-8e50-43b5-b078-b3a5f5972b55\",\n      \"caller\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 1045,\n        \"phone_number\": \"1045\",\n        \"device_type\": \"Windows_Client(5.7.5.939)\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"1002\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"Windows_Client(5.7.5.939)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-20T00:52:20Z\",\n      \"call_end_time\": \"2021-08-20T00:52:22Z\"\n    }\n  },\n  \"event_ts\": 1629420755266\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the callee."},"object":{"type":"object","required":["call_id","caller","callee","ringing_start_time","call_end_time"],"properties":{"call_id":{"type":"string","description":"The unique identifier of the call."},"callee":{"type":"object","description":"Callee object: Represents the person who is called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the callee."},"extension_type":{"type":"string","description":"The extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The Zoom user ID of the callee."},"phone_number":{"type":"string","description":"Thr Phone number of the callee in E164 format. \n\nExample: +12192818492"},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the callee."},"timezone":{"type":"string","description":"The timezone of the callee."},"device_id":{"type":"string","description":"Zoom clients generate an ID when installed on a device.\n\n<b>Note:</b> Does not apply to desk phones."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Caller object: Represents the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"The extension ID of the caller."},"extension_type":{"type":"string","description":"The extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The phone number of the caller in E164 format. \n\nExample: +12192818492"},"user_id":{"type":"string","description":"The Zoom user ID of the caller."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The extension number of the caller."},"timezone":{"type":"string","description":"The timezone of the caller."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"ringing_start_time":{"type":"string","description":"The GMT time at which the ringing started. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"call_end_time":{"type":"string","description":"The callee declined the call at a specific GMT time. \"yyyy-MM-dd'T'HH:mm:ss'Z'\" format."},"handup_result":{"type":"string","description":"The reason the call was rejected. Values: Rejected"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.callee_rejected\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_id\": \"6998308781135528785\",\n      \"channel_id\": \"7bfb20d5-8e50-43b5-b078-b3a5f5972b55\",\n      \"caller\": {\n        \"extension_type\": \"user\",\n        \"extension_number\": 1045,\n        \"phone_number\": \"1045\",\n        \"device_type\": \"Windows_Client(5.7.5.939)\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\": {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"extension_number\": 1002,\n        \"phone_number\": \"1002\",\n        \"user_id\": \"DnEopNmXQEGU2uvvzjgojw\",\n        \"timezone\": \"America/Los_Angeles\",\n        \"device_type\": \"Windows_Client(5.7.5.939)\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"ringing_start_time\": \"2021-08-20T00:52:20Z\",\n      \"call_end_time\": \"2021-08-20T00:52:22Z\"\n    }\n  },\n  \"event_ts\": 1629420755266\n}"}}}}}}}},"phone.group_settings_updated":{"post":{"tags":["phone"],"operationId":"phone.group_settings_updated","requestBody":{"description":"# phone.group_settings_updated\n\nThe **Group settings updated** event triggers when group settings changed.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* Your app must either be a user or account level OAuth App or a Webhook Only app.\nFor more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n* **Group settings updated** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:group_setting:master`,`phone:read:group_setting`,`phone:read:group_setting:admin`\n\n**Event type**: `phone.group_settings_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.group_settings_updated"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long (int64) format."},"payload":{"type":"object","required":["account_id","object","old_object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the group's settings."},"object":{"type":"object","description":"Information about the group's updated settings.","required":["group_id","settings"],"properties":{"group_id":{"type":"string","description":"The group ID."},"settings":{"type":"object","properties":{"call_live_transcription":{"description":"Whether to let users turn on live transcriptions for a call.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"transcription_start_prompt":{"type":"object","description":"Whether to play a prompt to call participants when the transcription has started.","properties":{"enable":{"type":"boolean"},"audio_id":{"description":"The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, removed_vWby3OZaQlS1nAdmEAqgwA for example. You can still use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string"},"audio_name":{"description":"The audio prompt file name.","type":"string"}}}}},"local_survivability_mode":{"description":"Whether to allow user or extension to have core phone services in the event of an outage.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}}},"select_outbound_caller_id":{"properties":{"enable":{"description":"Whether to allow extensions to change outbound caller ID when placing calls.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_hide_outbound_caller_id":{"description":"Whether to allow the current extension to hide outbound caller id. Settings is only available with client version 5.13.5 or later.","type":"boolean"}},"type":"object"},"personal_audio_library":{"properties":{"enable":{"description":"Whether to allow users to change their own audio library.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_music_on_hold_customization":{"description":"Whether to allow music on hold customization.","type":"boolean"},"allow_voicemail_and_message_greeting_customization":{"description":"Whether to allow voicemail and message greeting customization.","type":"boolean"}},"type":"object"},"voicemail":{"properties":{"enable":{"description":"Whether to allow users to access, receive or share voicemail and video mail.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_delete":{"description":"Whether to allow users to delete their own voicemail.","type":"boolean"},"allow_download":{"description":"Whether to allow users to download their own voicemail.","type":"boolean"},"allow_videomail":{"description":"Whether to allow users to access, share, download or delete video mail.","type":"boolean"},"allow_share":{"description":"Whether to allow user to share their own voicemail.","type":"boolean"},"allow_virtual_background":{"description":"Whether to allow virtual background for videomail or video greeting.","type":"boolean"}},"type":"object"},"voicemail_transcription":{"properties":{"enable":{"description":"Whether to enable voicemail/videomail transcription feature for User, Auto Receptionist, Call Queue, and Shared Line Groups.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}},"type":"object"},"voicemail_notification_by_email":{"description":"Once enabled, users receive email notifications when there is a new voicemail from users, call queues, auto receptionists, or shared line groups. Users who disabled the shared voicemail notification by email policy do not receive notifications.","properties":{"include_voicemail_file":{"description":"Whether to include the voicemail file.","type":"boolean"},"include_voicemail_transcription":{"description":"Whether to include the voicemail transcription.","type":"boolean"},"forward_voicemail_to_email":{"description":"Whether to forward the voicemail to email.","type":"boolean"},"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"shared_voicemail_notification_by_email":{"description":"Once enabled, users receive email notification when there is a new shared voicemail or videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, then users do not receive notifications.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"restricted_call_hours":{"type":"object","properties":{"enable":{"description":"Whether to define when the user cannot make or accept calls and send SMS. In the restricted hours, calls will follow \"When a call is not answered\" settings. Outbound and inbound emergency calls will still be allowed.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"time_zone":{"type":"object","description":"Set either time zone id or set_by_extension.","properties":{"id":{"description":"The [time zone list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats.","type":"string"},"name":{"description":"The time zone name. If time zone id is empty, it shows as setByExtension.","type":"string","example":"(GMT-9:00) Adak"}}},"restricted_hours_applied":{"description":"Whether restricted hours has been applied.","type":"boolean"},"restricted_holiday_hours_applied":{"description":"Whether restricted holiday hours has been applied.","type":"boolean"},"allow_internal_calls":{"description":"Whether to allow internal calls/SMS during restricted hours.","type":"boolean"}}},"allowed_call_locations":{"type":"object","properties":{"enable":{"description":"Whether to define where the extension or user can make and accept calls and send SMS. When the extension or user is outside of the allowed locations, calls will follow \"When a call is not answered\" settings, meanwhile outbound and inbound emergency calls and SMS will still be allowed. Note: SMS settings will only be available to users.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"locations_applied":{"description":"Whether locations has been applied.","type":"boolean"},"allow_internal_calls":{"description":"Whether to allow internal calls when outside of allowed locations","type":"boolean"}}},"check_voicemails_over_phone":{"description":"Once enabled, users can check voicemails over phone using a PIN code.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"auto_call_recording":{"description":"whether to automatically record all inbound and outbound calls.","properties":{"enable":{"description":"Whether automatic call recording is enabled.","type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string","example":"user_group"},"recording_calls":{"description":"The type of calls automatically recorded: \n* inbound \n* outbound \n* both","enum":["inbound","outbound","both"],"type":"string","example":"inbound"},"recording_transcription":{"description":"Whether the call recording transcription is enabled.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_start_prompt_audio_id":{"description":"The audio that plays when the recording has started. You can use this audio ID to get the audio information using [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"ySMexBgBQsioV8KKCUybTA"},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"allow_stop_resume_recording":{"description":"Whether the stop and resume of automatic call recording is enabled.","type":"boolean","example":true},"disconnect_on_recording_failure":{"description":"Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"description":"Whether to play a side tone beep for recorded users while recording. Only displayed when auto call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_volume":{"description":"The volume of the side tone beep. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when enable is true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15},"play_beep_member":{"description":"The beep sides. It displays only when enable is true.","type":"string","enum":["allMember","recordingSide"],"example":"allMember"}}}},"type":"object"},"ad_hoc_call_recording":{"description":"Whether to allow extensions to record and save calls in the cloud.","properties":{"enable":{"description":"Whether the current extension can record and save calls to the cloud.","type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","site"],"type":"string","example":"account"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean","example":true},"recording_transcription":{"description":"Whether the call recording transcription is enabled.","type":"boolean","example":true},"allow_download":{"description":"Whether to allow user to download their own ad-hoc recording.","type":"boolean","example":true},"allow_delete":{"description":"Whether to allow user to delete their own ad-hoc recording.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"description":"Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_volume":{"description":"The side tone beep volume. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when the enable is set to true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15},"play_beep_member":{"description":"The beep sides. It displays only when the enable is set to true.","type":"string","enum":["allMember","recordingSide"],"example":"allMember"}}}},"type":"object"},"zoom_phone_on_mobile":{"properties":{"enable":{"description":"This field allows users to use Zoom Phone on mobile clients (iOS, iPad OS, and Android).","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"allow_calling_sms_mms":{"description":"This field allows calling and SMS/MMS functions on mobile.","type":"boolean"}},"type":"object"},"zoom_phone_on_pwa":{"description":"Whether to allow user to use Zoom Phone on Zoom Progressive Web App.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"sms_etiquette_tool":{"description":"This field identifies defined keywords and text patterns over SMS and prevents users from sharing unwanted messages.","type":"object","properties":{"enable":{"type":"boolean"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"sms_etiquette_policy":{"type":"array","description":"The SMS etiquette policy. The maximum size is 50.","items":{"properties":{"id":{"description":"The SMS etiquette policy ID.","type":"string"},"name":{"description":"The SMS etiquette policy name.","type":"string"},"description":{"description":"The SMS etiquette policy description.","type":"string"},"rule":{"description":"The SMS etiquette policy rule, 1 - Keywords, 2 - Regular Expression.","type":"integer","enum":[1,2]},"content":{"description":"The SMS etiquette policy content. For rule 1, add keywords separated by comma, the following characters are supported A-Z, a-z, 0-9. For rule 2, add regular expressions, back references and zero-width assertions area not supported.","type":"string"},"action":{"description":"The actions taken when a policy is triggered, 1 - ask user to confirm sending of message, 2 - block the message.","type":"integer","enum":[1,2]},"active":{"description":"Whether active or not.","type":"boolean"}},"type":"object"}}}},"outbound_calling":{"type":"object","properties":{"enable":{"description":"Whether to define calling rules to restrict user or extension from calling specific countries, cities, or numbers.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"outbound_sms":{"type":"object","properties":{"enable":{"description":"Whether to allow users to send and receive messages. You will still need to assign a valid calling plan and phone number to each user for them to send and receive messages.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"international_calling":{"description":"Whether the current extension can make international calls outside of their calling plan.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}}},"sms":{"properties":{"enable":{"description":"Whether to allow user to send and receive messages. You will still need to assign a valid calling plan and phone number to the user in order to send and receive messages.","type":"boolean"},"international_sms":{"description":"Whether the user can send and receive international messages.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"e2e_encryption":{"properties":{"enable":{"description":"Whether to allow users to switch their calls to End-to-End Encryption. For users who have Automatic Call Recording turned on, they will need the option \"Allow user to stop and resume automatic call recording\" in order for them to use end-to-end encryption.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"call_handling_forwarding_to_other_users":{"description":"Whether to allow users to forward their calls to other numbers.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_forwarding_type":{"description":"1 - Low restriction (external numbers not allowed)\n2 - Medium restriction (external numbers and external contacts not allowed)\n 3 - High restriction (external numbers, external contacts and internal extensions without inbound automatic call recording not allowed)\n4 - No restriction","type":"integer","enum":[1,2,3,4]}}},"call_overflow":{"properties":{"enable":{"description":"Whether to allow users to forward their calls to other numbers.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_overflow_type":{"description":"1 - Can forward to internal extensions and to external contacts.\n2 - Can forward only to internal extensions.\n3 - Can forward only to internal extensions that require inbound Automatic Call Recording.\n4 - Can forward to internal extensions, external contacts, and external numbers.","enum":[1,2,3,4],"type":"integer"}},"type":"object"},"call_transferring":{"properties":{"enable":{"description":"Whether to allow user to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_transferring_type":{"description":"1-No restriction.\n2-Medium restriction (external numbers and external contacts not allowed).\n3-High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed).\n4-Low restriction (external numbers not allowed).","enum":[1,2,3,4],"type":"integer"}},"type":"object"},"elevate_to_meeting":{"properties":{"enable":{"description":"Whether to allow users to elevate their phone calls to a meeting.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"call_park":{"properties":{"enable":{"description":"Whether to allow calls placed on hold to be resumed from another location using a retrieval code.","type":"boolean"},"expiration_period":{"description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60],"type":"integer"},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer"},"forward_to":{"description":"The extension's forwarding information.","properties":{"display_name":{"description":"The extension's name.","type":"string"},"extension_id":{"description":"The extension ID.","type":"string"},"extension_number":{"description":"The extension number.","type":"integer"},"extension_type":{"description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"],"type":"string"},"id":{"description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","type":"string"}},"type":"object"},"sequence":{"description":"This field is only used in the new policy framework. Choose how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment will park the call at the next available BLF key. Random assignment will park the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","type":"integer","enum":[0,1]},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"hand_off_to_room":{"properties":{"enable":{"description":"Whether to allow users to send a call to a Zoom Room.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"mobile_switch_to_carrier":{"properties":{"enable":{"description":"Whether to allow the user to switch from a Zoom Phone to their native carrier.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"delegation":{"description":"Whether to allow users to use delegation.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"audio_intercom":{"description":"Whether to allow hands-free peer-to-peer conversations. When an intercom call is received, the phone will beep to notify the user of the incoming intercom call, and the user's phone will automatically answer the intercom call.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"block_calls_without_caller_id":{"description":"Whether calls without caller ID will be blocked.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"block_external_calls":{"description":"This field allows you to set rules for blocking external calls during business, closed, and holiday hours. This feature is only available for User, Zoom Room and Common Area.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework).","type":"boolean"},"block_business_hours":{"type":"boolean"},"block_closed_hours":{"type":"boolean"},"block_holiday_hours":{"type":"boolean"},"block_call_action":{"description":"The action when a call is blocked. 9 - Disconnect, 0- Forward to voicemail/videomail.","enum":[0,9],"type":"integer"}}},"auto_delete_data_after_retention_duration":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allows Zoom to automatically delete data after the retention duration has lapsed.","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The data types.","example":"callLog","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms","fax"]},"duration":{"type":"integer","description":"The retention duration where -1 means unlimited. For units of time, see the time_unit below. For year, the duration:-1, 1-10; for day, the duration:-1, 1-60; for month, the duration:-1, 1-18.","example":-1},"time_unit":{"type":"string","description":"The unit of time.","example":"year","enum":["year","month","day"]}}}},"delete_type":{"type":"integer","description":"The deletion policy.   \n * 1 - soft delete   \n * 2 - permanent delete","example":1,"enum":[1,2]},"permanently_delete_after_days":{"type":"integer","description":"Number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.","example":-1}},"description":"This field allows Zoom to automatically delete data after the retention duration has lapsed."},"peer_to_peer_media":{"description":"Whether to allow Zoom clients to send media directly to each other. Users or devices that have certain features like recording or monitoring enabled might not be able to use Peer to Peer Media.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"advanced_encryption":{"description":"Whether to allow Voicemail to be encrypted with keys which are not accessible to Zoom servers. These Voicemail can be decrypted only by the intended user recipient. Shared Line Appearance, Shared Line Group, Call Queue, or Auto Receptionist Voicemail will not be encrypted but can still be played. Email to Voicemail, transcriptions, ability to check Voicemails by dialing into the Voicemail system or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user does who inherits this policy does not have a Power Pack license, the policy will not be applied. Settings is only available with client version 5.12 or later.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework).","type":"boolean"},"disable_incoming_unencrypted_voicemail":{"description":"Whether to disable incoming unencrypted voicemail","type":"boolean"}}},"display_call_feedback_survey":{"description":"Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"feedback_type":{"description":"This field allows you to display feedback survey, 1 - display for every call, 2 - display when call quality issues are detected. Default 1, if set with value 2, need to set feed_back_mos or feedback_duration.","type":"integer","enum":[1,2]},"feedback_mos":{"description":"The MOS score. Min: 1.0, Max: 3.0, format one decimal point.","type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"string"},"max":{"type":"string"}}},"feedback_duration":{"description":"The call duration, in seconds, 0-60.","type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"integer"},"max":{"type":"integer"}}}}},"zoom_phone_on_desktop":{"description":"Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string","example":"account"},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}}}},"allowed_device_locations":{"type":"object","description":"Define when hardware devices will be blocked. Devices can be disconnected and blocked from accessing the Zoom service when a device is detected outside an allowed network or when any network change is detected.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"block_devices_type":{"type":"string","description":"Block devices condition.","example":"network_change_detected","enum":["network_change_detected","outside_allowed_location"]}}},"allow_emergency_calls":{"type":"object","description":"Enables users to place emergency calls through the system. Disabling this setting will deactivate emergency call functionality.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"allow_emergency_calls_from_clients":{"type":"boolean","description":"Allow emergency calls for Zoom clients","example":true},"allow_emergency_calls_from_deskphones":{"type":"boolean","description":"Allow emergency calls for desk phone and Zoom Phone Appliances","example":true}}},"online_fax":{"type":"object","description":"Allow user to send and receive faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"enable_new_fax_email_notifications":{"type":"boolean","description":"Enable email notifications when a new fax is received","example":true},"include_fax_as_attachment":{"type":"boolean","description":"Include fax as an attachment in the email notification","example":false}}},"sms_template":{"type":"object","description":"Use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"sms_template_list":{"maxItems":50,"type":"array","description":"The SMS template list.","items":{"type":"object","properties":{"sms_template_id":{"type":"string","description":"The SMS template ID.","example":"0qWIP8S8QXmo6KShUIyvZA"},"name":{"type":"string","description":"The SMS template name.","example":"name"},"description":{"type":"string","description":"The SMS template description.","example":"description"},"content":{"type":"string","description":"Text to Display. This text will be editable by users. Customer input fields may be added by using the buttons below. Customer information will be removed if not available. ","example":"content"},"active":{"type":"boolean","description":"Whether it is active.","example":true}}}}}},"call_screening":{"type":"object","description":"Incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"exclude_user_company_contacts":{"type":"boolean","description":"Exclude user and company contacts from call screening, calls will reach users as normal","example":true}}},"sms_auto_reply":{"type":"object","description":"Enable SMS Auto Reply feature for User, Auto Receptionist, and Call Queue. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"allow_end_user_edit_call_handling":{"type":"object","description":"Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"connect_to_operator":{"type":"object","description":"Once disabled, users will not be able to route their calls to an operator as part of the 'When a call is not answered' setting.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"no_hold_conference":{"type":"object","description":"Users can set up a conference call without any interruption in the current call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"conference_dtmf":{"type":"object","description":"This allows users to interact with automated systems, input access codes, or perform other functions without disrupting the call.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"desk_phone_smart_key_positions_layout":{"type":"object","description":"Allow Zoom to move your frequently used line keys to your pre-programmed smart keys layout. Smart keys will be updated on a weekly basis.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"auto_opt_out_in_call_queue":{"type":"object","description":"Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"prompt_before_opt_out_call_queue":{"type":"boolean","description":"Always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom","example":true}}},"allow_mobile_home_phone_callout":{"type":"object","description":"Allow users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. Users' Call Me On phone number will be masked with Zoom Phone caller ID.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"use_callkit_for_incoming_call_notifications_in_ios":{"type":"object","description":"Use CallKit always for Incoming call notifications on iOS/iPadOS devices. When this feature is enabled for a user or common area, their iOS/iPadOS device will always use CallKit for incoming call notifications no matter if the Zoom App is running in the foreground or background, preventing interruptions when receiving inbound calls on the device. This setting only applies to iOS/iPadOS devices with CallKit enabled. If a user modifies this setting on their client, the value will be updated on this policy. Locking this policy will prevent users from making changes to the setting. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"hide_phone_call_history_in_ios":{"type":"object","description":"Hide Zoom Phone calls in iOS/iPadOS device call history. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"obfuscate_sensitive_data_during_call":{"type":"object","description":"Obfuscate sensitive data during a call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"prevent_users_upload_audio_files":{"type":"object","description":"Prevent users from uploading audio files","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"voicemail_tasks":{"type":"object","description":"Voicemail tasks with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"voicemail_intent_based_prioritization":{"type":"object","description":"Voicemail prioritization with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"show_custom_disclaimer_when_using_zoom_phone":{"type":"object","description":"Show a custom disclaimer when starting to use Zoom Phone service","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"display_frequency":{"type":"string","description":"Display frequency","example":"first_time_only","enum":["first_time_only","every_time","every_month","every_quarter","every_6_months","every_year"]},"custom_disclaimer_list":{"type":"array","description":"Custom disclaimer list","items":{"type":"object","properties":{"language":{"type":"string","description":"The audio prompt language code.  \n  American English: en-US  \n \nBritish English: en-GB  \n \nEspa&ntilde;ol americano: es-US  \n \nFran&ccedil;ais canadien: fr-CA  \n \nDansk: da-DK  \n \nDeutsch: de-DE  \n \nEspa&ntilde;ol: es-ES  \n \nFran&ccedil;ais: fr-FR  \n \nItaliano: it-IT  \n \nNederlands: nl-NL  \n \nPortugues portugal: pt-PT  \n \nJapanese: ja-JP  \n \nKorean: ko-KO  \n \nPortugues brasil: pt-BR  \n \nChinese: zh-CN  \n \nTaiwanese: zh-TW  \n ","example":"en-GB"},"title":{"type":"string","description":"Custom disclaimer title","example":"tilte"},"body":{"type":"string","description":"Custom disclaimer body","example":"body"}}}}}}}}}},"old_object":{"$ref":"#/paths/phone.group_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/properties/object"}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.group_settings_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"group_id\": \"IfRqsMZSSzGBKm2AFJ7r3Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": true,\n            \"audio_id\": \"N_1FYBsGTE28ACkVN__EiA\",\n            \"audio_name\": \"hello1.mp3\"\n          }\n        }\n      }\n    },\n    \"old_object\": {\n      \"group_id\": \"IfRqsMZSSzGBKm2AFJ7r3Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": true,\n            \"audio_id\": \"P_1FYBsGTE28ACkVNAc5t\",\n            \"audio_name\": \"welcome.mp3\"\n          }\n        }\n      }\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.group_settings_updated"],"description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long (int64) format."},"payload":{"type":"object","required":["account_id","object","old_object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user that updated the group's settings."},"object":{"type":"object","description":"Information about the group's updated settings.","required":["group_id","settings"],"properties":{"group_id":{"type":"string","description":"The group ID."},"settings":{"type":"object","properties":{"call_live_transcription":{"description":"Whether to let users turn on live transcriptions for a call.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"transcription_start_prompt":{"type":"object","description":"Whether to play a prompt to call participants when the transcription has started.","properties":{"enable":{"type":"boolean"},"audio_id":{"description":"The audio prompt file ID. If the audio was removed from the user's audio library, it will be marked with a prefix, removed_vWby3OZaQlS1nAdmEAqgwA for example. You can still use this audio ID to get the audio information in [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string"},"audio_name":{"description":"The audio prompt file name.","type":"string"}}}}},"local_survivability_mode":{"description":"Whether to allow user or extension to have core phone services in the event of an outage.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}}},"select_outbound_caller_id":{"properties":{"enable":{"description":"Whether to allow extensions to change outbound caller ID when placing calls.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_hide_outbound_caller_id":{"description":"Whether to allow the current extension to hide outbound caller id. Settings is only available with client version 5.13.5 or later.","type":"boolean"}},"type":"object"},"personal_audio_library":{"properties":{"enable":{"description":"Whether to allow users to change their own audio library.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_music_on_hold_customization":{"description":"Whether to allow music on hold customization.","type":"boolean"},"allow_voicemail_and_message_greeting_customization":{"description":"Whether to allow voicemail and message greeting customization.","type":"boolean"}},"type":"object"},"voicemail":{"properties":{"enable":{"description":"Whether to allow users to access, receive or share voicemail and video mail.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"},"allow_delete":{"description":"Whether to allow users to delete their own voicemail.","type":"boolean"},"allow_download":{"description":"Whether to allow users to download their own voicemail.","type":"boolean"},"allow_videomail":{"description":"Whether to allow users to access, share, download or delete video mail.","type":"boolean"},"allow_share":{"description":"Whether to allow user to share their own voicemail.","type":"boolean"},"allow_virtual_background":{"description":"Whether to allow virtual background for videomail or video greeting.","type":"boolean"}},"type":"object"},"voicemail_transcription":{"properties":{"enable":{"description":"Whether to enable voicemail/videomail transcription feature for User, Auto Receptionist, Call Queue, and Shared Line Groups.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}},"type":"object"},"voicemail_notification_by_email":{"description":"Once enabled, users receive email notifications when there is a new voicemail from users, call queues, auto receptionists, or shared line groups. Users who disabled the shared voicemail notification by email policy do not receive notifications.","properties":{"include_voicemail_file":{"description":"Whether to include the voicemail file.","type":"boolean"},"include_voicemail_transcription":{"description":"Whether to include the voicemail transcription.","type":"boolean"},"forward_voicemail_to_email":{"description":"Whether to forward the voicemail to email.","type":"boolean"},"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"shared_voicemail_notification_by_email":{"description":"Once enabled, users receive email notification when there is a new shared voicemail or videomail. If the extension that shares the voicemail or videomail has disabled the voicemail or videomail notification by email policy, then users do not receive notifications.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"restricted_call_hours":{"type":"object","properties":{"enable":{"description":"Whether to define when the user cannot make or accept calls and send SMS. In the restricted hours, calls will follow \"When a call is not answered\" settings. Outbound and inbound emergency calls will still be allowed.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"time_zone":{"type":"object","description":"Set either time zone id or set_by_extension.","properties":{"id":{"description":"The [time zone list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#timezones) for supported time zones and their formats.","type":"string"},"name":{"description":"The time zone name. If time zone id is empty, it shows as setByExtension.","type":"string","example":"(GMT-9:00) Adak"}}},"restricted_hours_applied":{"description":"Whether restricted hours has been applied.","type":"boolean"},"restricted_holiday_hours_applied":{"description":"Whether restricted holiday hours has been applied.","type":"boolean"},"allow_internal_calls":{"description":"Whether to allow internal calls/SMS during restricted hours.","type":"boolean"}}},"allowed_call_locations":{"type":"object","properties":{"enable":{"description":"Whether to define where the extension or user can make and accept calls and send SMS. When the extension or user is outside of the allowed locations, calls will follow \"When a call is not answered\" settings, meanwhile outbound and inbound emergency calls and SMS will still be allowed. Note: SMS settings will only be available to users.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"locations_applied":{"description":"Whether locations has been applied.","type":"boolean"},"allow_internal_calls":{"description":"Whether to allow internal calls when outside of allowed locations","type":"boolean"}}},"check_voicemails_over_phone":{"description":"Once enabled, users can check voicemails over phone using a PIN code.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"auto_call_recording":{"description":"whether to automatically record all inbound and outbound calls.","properties":{"enable":{"description":"Whether automatic call recording is enabled.","type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string","example":"user_group"},"recording_calls":{"description":"The type of calls automatically recorded: \n* inbound \n* outbound \n* both","enum":["inbound","outbound","both"],"type":"string","example":"inbound"},"recording_transcription":{"description":"Whether the call recording transcription is enabled.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_start_prompt_audio_id":{"description":"The audio that plays when the recording has started. You can use this audio ID to get the audio information using [Get an audio item](https://marketplace.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","type":"string","example":"ySMexBgBQsioV8KKCUybTA"},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"allow_stop_resume_recording":{"description":"Whether the stop and resume of automatic call recording is enabled.","type":"boolean","example":true},"disconnect_on_recording_failure":{"description":"Whether a call disconnects when there is an issue with the automatic call recording and the call cannot reconnect after five seconds. This does **not** include emergency calls.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"description":"Whether to play a side tone beep for recorded users while recording. Only displayed when auto call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_volume":{"description":"The volume of the side tone beep. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when enable is true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15},"play_beep_member":{"description":"The beep sides. It displays only when enable is true.","type":"string","enum":["allMember","recordingSide"],"example":"allMember"}}}},"type":"object"},"ad_hoc_call_recording":{"description":"Whether to allow extensions to record and save calls in the cloud.","properties":{"enable":{"description":"Whether the current extension can record and save calls to the cloud.","type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","site"],"type":"string","example":"account"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean","example":true},"recording_transcription":{"description":"Whether the call recording transcription is enabled.","type":"boolean","example":true},"allow_download":{"description":"Whether to allow user to download their own ad-hoc recording.","type":"boolean","example":true},"allow_delete":{"description":"Whether to allow user to delete their own ad-hoc recording.","type":"boolean","example":true},"recording_start_prompt":{"description":"Whether a prompt plays to call participants when the recording has started.","type":"boolean","example":true},"recording_explicit_consent":{"description":"Whether the Press 1 option that provides recording consent is enabled.","type":"boolean","example":true},"play_recording_beep_tone":{"type":"object","properties":{"enable":{"description":"Whether to play the side tone beep for recorded users while recording. It displays only when ad hoc call recording policy uses the new framework.","type":"boolean","example":true},"play_beep_volume":{"description":"The side tone beep volume. It displays only when enable is set to true.","type":"integer","enum":[0,20,40,60,80,100],"example":60},"play_beep_time_interval":{"description":"The beep time interval in seconds. It displays only when the enable is set to true.","type":"integer","enum":[5,10,15,20,25,30,60,120],"example":15},"play_beep_member":{"description":"The beep sides. It displays only when the enable is set to true.","type":"string","enum":["allMember","recordingSide"],"example":"allMember"}}}},"type":"object"},"zoom_phone_on_mobile":{"properties":{"enable":{"description":"This field allows users to use Zoom Phone on mobile clients (iOS, iPad OS, and Android).","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"allow_calling_sms_mms":{"description":"This field allows calling and SMS/MMS functions on mobile.","type":"boolean"}},"type":"object"},"zoom_phone_on_pwa":{"description":"Whether to allow user to use Zoom Phone on Zoom Progressive Web App.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"sms_etiquette_tool":{"description":"This field identifies defined keywords and text patterns over SMS and prevents users from sharing unwanted messages.","type":"object","properties":{"enable":{"type":"boolean"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"sms_etiquette_policy":{"type":"array","description":"The SMS etiquette policy. The maximum size is 50.","items":{"properties":{"id":{"description":"The SMS etiquette policy ID.","type":"string"},"name":{"description":"The SMS etiquette policy name.","type":"string"},"description":{"description":"The SMS etiquette policy description.","type":"string"},"rule":{"description":"The SMS etiquette policy rule, 1 - Keywords, 2 - Regular Expression.","type":"integer","enum":[1,2]},"content":{"description":"The SMS etiquette policy content. For rule 1, add keywords separated by comma, the following characters are supported A-Z, a-z, 0-9. For rule 2, add regular expressions, back references and zero-width assertions area not supported.","type":"string"},"action":{"description":"The actions taken when a policy is triggered, 1 - ask user to confirm sending of message, 2 - block the message.","type":"integer","enum":[1,2]},"active":{"description":"Whether active or not.","type":"boolean"}},"type":"object"}}}},"outbound_calling":{"type":"object","properties":{"enable":{"description":"Whether to define calling rules to restrict user or extension from calling specific countries, cities, or numbers.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"outbound_sms":{"type":"object","properties":{"enable":{"description":"Whether to allow users to send and receive messages. You will still need to assign a valid calling plan and phone number to each user for them to send and receive messages.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"international_calling":{"description":"Whether the current extension can make international calls outside of their calling plan.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits modifying the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified.","type":"boolean"}}},"sms":{"properties":{"enable":{"description":"Whether to allow user to send and receive messages. You will still need to assign a valid calling plan and phone number to the user in order to send and receive messages.","type":"boolean"},"international_sms":{"description":"Whether the user can send and receive international messages.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"e2e_encryption":{"properties":{"enable":{"description":"Whether to allow users to switch their calls to End-to-End Encryption. For users who have Automatic Call Recording turned on, they will need the option \"Allow user to stop and resume automatic call recording\" in order for them to use end-to-end encryption.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"call_handling_forwarding_to_other_users":{"description":"Whether to allow users to forward their calls to other numbers.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_forwarding_type":{"description":"1 - Low restriction (external numbers not allowed)\n2 - Medium restriction (external numbers and external contacts not allowed)\n 3 - High restriction (external numbers, external contacts and internal extensions without inbound automatic call recording not allowed)\n4 - No restriction","type":"integer","enum":[1,2,3,4]}}},"call_overflow":{"properties":{"enable":{"description":"Whether to allow users to forward their calls to other numbers.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_overflow_type":{"description":"1 - Can forward to internal extensions and to external contacts.\n2 - Can forward only to internal extensions.\n3 - Can forward only to internal extensions that require inbound Automatic Call Recording.\n4 - Can forward to internal extensions, external contacts, and external numbers.","enum":[1,2,3,4],"type":"integer"}},"type":"object"},"call_transferring":{"properties":{"enable":{"description":"Whether to allow user to warm or blind transfer their calls. This does not apply to warm transfer on IP Phones except for Yealink. Voicemail is transferable only to internal extensions.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"call_transferring_type":{"description":"1-No restriction.\n2-Medium restriction (external numbers and external contacts not allowed).\n3-High restriction (external numbers, unrecorded external contacts, and internal extensions without inbound automatic recording not allowed).\n4-Low restriction (external numbers not allowed).","enum":[1,2,3,4],"type":"integer"}},"type":"object"},"elevate_to_meeting":{"properties":{"enable":{"description":"Whether to allow users to elevate their phone calls to a meeting.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"call_park":{"properties":{"enable":{"description":"Whether to allow calls placed on hold to be resumed from another location using a retrieval code.","type":"boolean"},"expiration_period":{"description":"A time limit for parked calls in minutes. After the expiration period ends, the retrieval code is no longer valid and a new code will be generated.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50,55,60],"type":"integer"},"call_not_picked_up_action":{"description":"The action when a parked call is not picked up. \n 100 - Ring back to parker \n0 - Forward to voicemail of the parker \n9 - Disconnect \n 50 - Forward to another extension","type":"integer"},"forward_to":{"description":"The extension's forwarding information.","properties":{"display_name":{"description":"The extension's name.","type":"string"},"extension_id":{"description":"The extension ID.","type":"string"},"extension_number":{"description":"The extension number.","type":"integer"},"extension_type":{"description":"The type of extension: \n* user \n* zoomRoom \n* commonArea\n* ciscoRoom/polycomRoom \n* autoReceptionist \n* sharedLineGroup \n* callQueue","enum":["user","zoomRoom","commonArea","ciscoRoom/polycomRoom","autoReceptionist","callQueue","sharedLineGroup"],"type":"string"},"id":{"description":"The ID of the extension user, zoomRoom, commonArea, ciscoRoom/polycomRoom, autoReceptionist, callQueue or sharedLineGroup.","type":"string"}},"type":"object"},"sequence":{"description":"This field is only used in the new policy framework. Choose how parked calls are assigned to a BLF (Busy Lamp Field) key. Sequential assignment will park the call at the next available BLF key. Random assignment will park the call at a randomly selected BLF key. \n0 - Random \n1 - Sequential","type":"integer","enum":[0,1]},"music_on_park":{"type":"object","description":"Play music when a call is parked.","properties":{"audio_id":{"type":"string","description":"The audio prompt file ID. You can still use this audio ID to get the audio information in [Get an audio item](https://developers.zoom.us/docs/api-reference/phone/methods#tag/Audio-Library/operation/GetAudioItem) API.","example":"yCT14TwySDGVUypVlKNEyA"},"audio_name":{"type":"string","description":"The audio prompt file name.","example":"example.mp3"}}},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"hand_off_to_room":{"properties":{"enable":{"description":"Whether to allow users to send a call to a Zoom Room.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"mobile_switch_to_carrier":{"properties":{"enable":{"description":"Whether to allow the user to switch from a Zoom Phone to their native carrier.","type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}},"type":"object"},"delegation":{"description":"Whether to allow users to use delegation.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"audio_intercom":{"description":"Whether to allow hands-free peer-to-peer conversations. When an intercom call is received, the phone will beep to notify the user of the incoming intercom call, and the user's phone will automatically answer the intercom call.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"block_calls_without_caller_id":{"description":"Whether calls without caller ID will be blocked.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"block_external_calls":{"description":"This field allows you to set rules for blocking external calls during business, closed, and holiday hours. This feature is only available for User, Zoom Room and Common Area.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework).","type":"boolean"},"block_business_hours":{"type":"boolean"},"block_closed_hours":{"type":"boolean"},"block_holiday_hours":{"type":"boolean"},"block_call_action":{"description":"The action when a call is blocked. 9 - Disconnect, 0- Forward to voicemail/videomail.","enum":[0,9],"type":"integer"}}},"auto_delete_data_after_retention_duration":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allows Zoom to automatically delete data after the retention duration has lapsed.","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The data types.","example":"callLog","enum":["callLog","onDemandRecording","automaticRecording","voicemail","videomail","sms","fax"]},"duration":{"type":"integer","description":"The retention duration where -1 means unlimited. For units of time, see the time_unit below. For year, the duration:-1, 1-10; for day, the duration:-1, 1-60; for month, the duration:-1, 1-18.","example":-1},"time_unit":{"type":"string","description":"The unit of time.","example":"year","enum":["year","month","day"]}}}},"delete_type":{"type":"integer","description":"The deletion policy.   \n * 1 - soft delete   \n * 2 - permanent delete","example":1,"enum":[1,2]},"permanently_delete_after_days":{"type":"integer","description":"Number of days after which the data will be permanently deleted automatically. Use -1 to retain data indefinitely.","example":-1}},"description":"This field allows Zoom to automatically delete data after the retention duration has lapsed."},"peer_to_peer_media":{"description":"Whether to allow Zoom clients to send media directly to each other. Users or devices that have certain features like recording or monitoring enabled might not be able to use Peer to Peer Media.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"}}},"advanced_encryption":{"description":"Whether to allow Voicemail to be encrypted with keys which are not accessible to Zoom servers. These Voicemail can be decrypted only by the intended user recipient. Shared Line Appearance, Shared Line Group, Call Queue, or Auto Receptionist Voicemail will not be encrypted but can still be played. Email to Voicemail, transcriptions, ability to check Voicemails by dialing into the Voicemail system or web are not available when this feature is enabled. This policy requires a Power Pack license to be enabled. If the user does who inherits this policy does not have a Power Pack license, the policy will not be applied. Settings is only available with client version 5.12 or later.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset(displayed when using old or new policy framework).","type":"boolean"},"disable_incoming_unencrypted_voicemail":{"description":"Whether to disable incoming unencrypted voicemail","type":"boolean"}}},"display_call_feedback_survey":{"description":"Whether to display a thumbs up or down survey at the end of each call. If participants respond with thumbs down, they can provide additional information about what went wrong.","type":"object","properties":{"enable":{"type":"boolean"},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean"},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string"},"modified":{"description":"Whether the current settings have been modified. If modified, they can be reset (displayed when using the new policy framework).","type":"boolean"},"feedback_type":{"description":"This field allows you to display feedback survey, 1 - display for every call, 2 - display when call quality issues are detected. Default 1, if set with value 2, need to set feed_back_mos or feedback_duration.","type":"integer","enum":[1,2]},"feedback_mos":{"description":"The MOS score. Min: 1.0, Max: 3.0, format one decimal point.","type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"string"},"max":{"type":"string"}}},"feedback_duration":{"description":"The call duration, in seconds, 0-60.","type":"object","properties":{"enable":{"type":"boolean"},"min":{"type":"integer"},"max":{"type":"integer"}}}}},"zoom_phone_on_desktop":{"description":"Whether to allow users to use Zoom Phone on desktop clients (Mac OS, Windows, VDI client and Linux).","type":"object","properties":{"enable":{"type":"boolean","example":true},"locked":{"description":"Whether the senior administrator allows users to modify the current settings.","type":"boolean","example":true},"locked_by":{"description":"Which level of administrator prohibits the modification of the current settings.","enum":["invalid","account","user_group"],"type":"string","example":"account"},"allow_calling_clients":{"type":"array","description":"The clients in this list are allowed to make and receive calls.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}},"allow_sms_mms_clients":{"type":"array","description":"The clients in this list are allowed to use the SMS/MMS function.","items":{"type":"string","description":"The acceptable value is \r\nmac_os\r\nwindows\r\nvdi_client\r\nlinux.","example":"mac_os","enum":["mac_os","windows","vdi_client","linux"]}}}},"allowed_device_locations":{"type":"object","description":"Define when hardware devices will be blocked. Devices can be disconnected and blocked from accessing the Zoom service when a device is detected outside an allowed network or when any network change is detected.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"block_devices_type":{"type":"string","description":"Block devices condition.","example":"network_change_detected","enum":["network_change_detected","outside_allowed_location"]}}},"allow_emergency_calls":{"type":"object","description":"Enables users to place emergency calls through the system. Disabling this setting will deactivate emergency call functionality.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"allow_emergency_calls_from_clients":{"type":"boolean","description":"Allow emergency calls for Zoom clients","example":true},"allow_emergency_calls_from_deskphones":{"type":"boolean","description":"Allow emergency calls for desk phone and Zoom Phone Appliances","example":true}}},"online_fax":{"type":"object","description":"Allow user to send and receive faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"enable_new_fax_email_notifications":{"type":"boolean","description":"Enable email notifications when a new fax is received","example":true},"include_fax_as_attachment":{"type":"boolean","description":"Include fax as an attachment in the email notification","example":false}}},"sms_template":{"type":"object","description":"Use pre-defined templates to help users compose messages. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"sms_template_list":{"maxItems":50,"type":"array","description":"The SMS template list.","items":{"type":"object","properties":{"sms_template_id":{"type":"string","description":"The SMS template ID.","example":"0qWIP8S8QXmo6KShUIyvZA"},"name":{"type":"string","description":"The SMS template name.","example":"name"},"description":{"type":"string","description":"The SMS template description.","example":"description"},"content":{"type":"string","description":"Text to Display. This text will be editable by users. Customer input fields may be added by using the buttons below. Customer information will be removed if not available. ","example":"content"},"active":{"type":"boolean","description":"Whether it is active.","example":true}}}}}},"call_screening":{"type":"object","description":"Incoming direct external callers will be prompted to respond to a button to reach users, callers who don't respond will be disconnected. Devices will not be able to receive any third party faxes.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"exclude_user_company_contacts":{"type":"boolean","description":"Exclude user and company contacts from call screening, calls will reach users as normal","example":true}}},"sms_auto_reply":{"type":"object","description":"Enable SMS Auto Reply feature for User, Auto Receptionist, and Call Queue. Power Pack license is required for this feature to work.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"allow_end_user_edit_call_handling":{"type":"object","description":"Once disabled, users will not be able to edit their call handling settings on the web portal or enable call forwarding on the client.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"connect_to_operator":{"type":"object","description":"Once disabled, users will not be able to route their calls to an operator as part of the 'When a call is not answered' setting.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"no_hold_conference":{"type":"object","description":"Users can set up a conference call without any interruption in the current call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"conference_dtmf":{"type":"object","description":"This allows users to interact with automated systems, input access codes, or perform other functions without disrupting the call.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"desk_phone_smart_key_positions_layout":{"type":"object","description":"Allow Zoom to move your frequently used line keys to your pre-programmed smart keys layout. Smart keys will be updated on a weekly basis.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"auto_opt_out_in_call_queue":{"type":"object","description":"Once enabled, when Call Queue members log out of Zoom (Except for desk phones and Zoom Phone appliances), they will be automatically Opted-out from the Call Queue as well.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"prompt_before_opt_out_call_queue":{"type":"boolean","description":"Always ask the user if they want to opt-out from the Call Queue when they sign out of Zoom","example":true}}},"allow_mobile_home_phone_callout":{"type":"object","description":"Allow users to use mobile or home phone to place calls. Zoom app will call this device first before ringing the called number. Users' Call Me On phone number will be masked with Zoom Phone caller ID.","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":true},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"use_callkit_for_incoming_call_notifications_in_ios":{"type":"object","description":"Use CallKit always for Incoming call notifications on iOS/iPadOS devices. When this feature is enabled for a user or common area, their iOS/iPadOS device will always use CallKit for incoming call notifications no matter if the Zoom App is running in the foreground or background, preventing interruptions when receiving inbound calls on the device. This setting only applies to iOS/iPadOS devices with CallKit enabled. If a user modifies this setting on their client, the value will be updated on this policy. Locking this policy will prevent users from making changes to the setting. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"hide_phone_call_history_in_ios":{"type":"object","description":"Hide Zoom Phone calls in iOS/iPadOS device call history. ","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"obfuscate_sensitive_data_during_call":{"type":"object","description":"Obfuscate sensitive data during a call","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"prevent_users_upload_audio_files":{"type":"object","description":"Prevent users from uploading audio files","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"voicemail_tasks":{"type":"object","description":"Voicemail tasks with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"voicemail_intent_based_prioritization":{"type":"object","description":"Voicemail prioritization with AI Companion","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true}}},"show_custom_disclaimer_when_using_zoom_phone":{"type":"object","description":"Show a custom disclaimer when starting to use Zoom Phone service","properties":{"enable":{"type":"boolean","description":"Whether this policy is enabled","example":false},"locked":{"type":"boolean","description":"Whether the senior administrator allows users to modify the current settings.","example":false},"locked_by":{"type":"string","description":"Which level of administrator prohibits the modification of the current settings.","example":"account","enum":["invalid","account","user_group"]},"modified":{"type":"boolean","description":"Whether the current settings have been modified. \n\nIf modified, they can be reset (displayed when using the new policy framework).","example":true},"display_frequency":{"type":"string","description":"Display frequency","example":"first_time_only","enum":["first_time_only","every_time","every_month","every_quarter","every_6_months","every_year"]},"custom_disclaimer_list":{"type":"array","description":"Custom disclaimer list","items":{"type":"object","properties":{"language":{"type":"string","description":"The audio prompt language code.  \n  American English: en-US  \n \nBritish English: en-GB  \n \nEspa&ntilde;ol americano: es-US  \n \nFran&ccedil;ais canadien: fr-CA  \n \nDansk: da-DK  \n \nDeutsch: de-DE  \n \nEspa&ntilde;ol: es-ES  \n \nFran&ccedil;ais: fr-FR  \n \nItaliano: it-IT  \n \nNederlands: nl-NL  \n \nPortugues portugal: pt-PT  \n \nJapanese: ja-JP  \n \nKorean: ko-KO  \n \nPortugues brasil: pt-BR  \n \nChinese: zh-CN  \n \nTaiwanese: zh-TW  \n ","example":"en-GB"},"title":{"type":"string","description":"Custom disclaimer title","example":"tilte"},"body":{"type":"string","description":"Custom disclaimer body","example":"body"}}}}}}}}}},"old_object":{"$ref":"#/paths/phone.group_settings_updated/post/requestBody/content/application~1json/schema/properties/payload/properties/object"}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.group_settings_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"group_id\": \"IfRqsMZSSzGBKm2AFJ7r3Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": true,\n            \"audio_id\": \"N_1FYBsGTE28ACkVN__EiA\",\n            \"audio_name\": \"hello1.mp3\"\n          }\n        }\n      }\n    },\n    \"old_object\": {\n      \"group_id\": \"IfRqsMZSSzGBKm2AFJ7r3Q\",\n      \"settings\": {\n        \"call_live_transcription\": {\n          \"enable\": true,\n          \"locked\": false,\n          \"transcription_start_prompt\": {\n            \"enable\": true,\n            \"audio_id\": \"P_1FYBsGTE28ACkVNAc5t\",\n            \"audio_name\": \"welcome.mp3\"\n          }\n        }\n      }\n    }\n  },\n  \"event_ts\": 1619155281301\n}"}}}}}}}},"phone.callee_unmute":{"post":{"tags":["phone"],"operationId":"phone.callee_unmute","requestBody":{"description":"# phone.callee_unmute\n\nThe **Callee unmutes a phone call** event triggers when the callee unmutes themselves during a call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Callee unmutes a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n`phone.callee_unmute`\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_unmute`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the callee unmuted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_unmute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the callee unmuted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.callee_unmute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.recording_stopped":{"post":{"tags":["phone"],"operationId":"phone.recording_stopped","requestBody":{"description":"# phone.recording_stopped\n---\nThe **Call recording has stopped** event triggers when the recording of a phone call has stopped.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording has stopped** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_stopped`\n","content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"ID of the recording"},"user_id":{"type":"string","description":"ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Stop date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"channel_id":{"type":"string","description":"ID of the channel"},"sip_id":{"type":"string","description":"ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording. This value field can be user or callQueue.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Type of the owner","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"ID of the owner."},"name":{"type":"string","description":"Display name of the owner"},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_stopped\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n            \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"ID of the recording"},"user_id":{"type":"string","description":"ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Stop date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"channel_id":{"type":"string","description":"ID of the channel"},"sip_id":{"type":"string","description":"ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording. This value field can be user or callQueue.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"Type of the owner","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"ID of the owner."},"name":{"type":"string","description":"Display name of the owner"},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_stopped\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n            \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}}}}},"phone.caller_meeting_inviting":{"post":{"tags":["phone"],"operationId":"phone.caller_meeting_inviting","requestBody":{"description":"# phone.caller_meeting_inviting\n---\n\nThe **Caller invited to join a meeting** event triggers each time a callee over Zoom Phone escalates a phone call to a Zoom meeting.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Caller invited to join a meeting**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_meeting_inviting`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"meeting_id":{"type":"string","description":"The meeting's unique ID. This is also known as the meeting number.","format":"int64"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call escalated to meeting, in yyyy-MM-dd'T'HH:mm:ss'Z' format.","format":"date-time"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_meeting_inviting\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 555011,\n        \"phone_number\" : \"555011\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 555010,\n        \"phone_number\" : \"555010\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"meeting_id\": \"987654321\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"meeting_id":{"type":"string","description":"The meeting's unique ID. This is also known as the meeting number.","format":"int64"},"date_time":{"type":"string","description":"The date and time (GMT) at which the call escalated to meeting, in yyyy-MM-dd'T'HH:mm:ss'Z' format.","format":"date-time"}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_meeting_inviting\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 555011,\n        \"phone_number\" : \"555011\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 555010,\n        \"phone_number\" : \"555010\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"meeting_id\": \"987654321\",\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.warm_transfer_cancelled":{"post":{"tags":["phone"],"operationId":"phone.warm_transfer_cancelled","requestBody":{"description":"# phone.warm_transfer_cancelled\n---\n\nThe **Warm transfer is cancelled** event triggers when a call warm transfer is cancelled.\n**Note**: Applicable only to Zoom desktop clients (version 6.1.0 or later) using Zoom native phone numbers. Not applicable to IP phones or BYOC numbers.\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Warm transfer is cancelled\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.warm_transfer_cancelled`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the warm transfer failed to cancel. Returns an empty string if successful."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be a user's phone number, extension number, or phone number displayed in E164 format."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner's name.","type":"string","example":"123@test.com"},"type":{"description":"The owner's type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (UTC) at which the warm transfer call was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_cancelled\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason why the warm transfer failed to cancel. Returns an empty string if successful."},"call_id":{"type":"string","description":"The call's unique ID."},"transfer_phone_number":{"type":"string","description":"The phone number required for the warm transfer. This may be a user's phone number, extension number, or phone number displayed in E164 format."},"transfer_account_code":{"type":"string","description":"The transfer account code. To transfer a call between accounts, use the format: [Account code] - [extension number]."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner's name.","type":"string","example":"123@test.com"},"type":{"description":"The owner's type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (UTC) at which the warm transfer call was completed, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.warm_transfer_cancelled\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"failure_reason\": \"\",\n      \"call_id\": \"6986878782238080581\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      },\n      \"date_time\": \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.voicemail_received_for_access_member":{"post":{"tags":["phone"],"operationId":"phone.voicemail_received_for_access_member","requestBody":{"description":"# phone.voicemail_received_for_access_member\n\n\n\nThe **Voicemail is received for access member** event triggers each time a callee (the person called via Zoom Phone) misses a call and receives a voicemail from the caller. In this case, the callee's access member receives the event.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A **Voicemail is received for access member** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:voicemail:master`,`phone:read:voicemail`,`phone:read:voicemail:admin`\n\n**Event type**: `phone.voicemail_received_for_access_member`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_received_for_access_member"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The access member's account ID."},"object":{"type":"object","required":["id","date_time","download_url","duration","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name","callee_extension_type","callee_id"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"download_url":{"type":"string","format":"url","description":"The URL at which the voicemail can be downloaded."},"duration":{"type":"integer","description":"The duration of the voicemail."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."},"access_member_id":{"type":"string","description":"The access member's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For a common area (commonAreaPhone) — callee_id is the same as common_area_ids."},"access_member_extension_type":{"type":"string","enum":["user","commonAreaPhone"],"description":"The callee's extension type:\n* user\n* commonAreaPhone"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"duration\": 3,\n      \"caller_name\": \"Rascoe Thomas\",\n      \"caller_did_number\": \"+12055967465\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_did_number\": \"+15104381494\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"download_url\": \"https://example.com/v2/phone/voice_mails/download/6q6cLeR8Q4WCdWGmGxCLEw\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2,\n      \"access_member_id\": \"z8yCxjabcdEFGHfp8uQ\",\n      \"access_member_extension_type\": \"user\"\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_received_for_access_member\"\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.voicemail_received_for_access_member"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The access member's account ID."},"object":{"type":"object","required":["id","date_time","download_url","duration","caller_number","caller_number_type","caller_name","callee_number","callee_number_type","callee_name","callee_extension_type","callee_id"],"properties":{"id":{"type":"string","description":"The voicemail's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the voicemail was received."},"download_url":{"type":"string","format":"url","description":"The URL at which the voicemail can be downloaded."},"duration":{"type":"integer","description":"The duration of the voicemail."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The caller's phone number."},"caller_number_type":{"type":"integer","enum":[1,2],"description":"The caller's number type:\n* 1 — Internal.\n* 2 — External."},"caller_name":{"type":"string","description":"The caller's name."},"caller_did_number":{"type":"string","description":"Caller's DID number."},"callee_user_id":{"type":"string","description":"The callee's user ID."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The callee's phone number."},"callee_number_type":{"type":"integer","enum":[1,2],"description":"The callee's number type:\n* 1 — Internal.\n* 2 — External."},"callee_name":{"type":"string","description":"The callee's name."},"callee_did_number":{"type":"string","description":"Callee's DID number."},"callee_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","sharedLineGroup"],"description":"The callee's extension type:\n* user\n* callQueue\n* autoReceptionist\n* shareLineGroup"},"callee_id":{"type":"string","description":"The callee's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For call queue (callQueue) — callee_id is the same as the call queue group_id value.\n* For an auto-receptionist (autoReceptionist) — callee_id is the same as auto_receptionist_id.\n* For a shared line group (shareLineGroup) — callee_id is the same as share_line_group_id."},"call_log_id":{"type":"string","description":"Unique identifier of the phone call log."},"call_history_id":{"type":"string","deprecated":true,"description":"The call history id."},"call_element_id":{"type":"string","description":"The call element id."},"call_id":{"type":"string","description":"The call's unique ID."},"access_member_id":{"type":"string","description":"The access member's ID. Depending on the type of extension, this value can be one of the following:\n* For a regular user (user) — callee_id is the same as callee_user_id.\n* For a common area (commonAreaPhone) — callee_id is the same as common_area_ids."},"access_member_extension_type":{"type":"string","enum":["user","commonAreaPhone"],"description":"The callee's extension type:\n* user\n* commonAreaPhone"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"payload\": {\n    \"account_id\": \"97IYU62bTpSY66_pir2PgA\",\n    \"object\": {\n      \"callee_id\": \"s6njoqZLT6aPvUQ0JyydeQ\",\n      \"call_id\": \"666888666865648555\",\n      \"call_log_id\": \"55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_history_id\": \"20210819-55fd0af0-beb0-433a-be97-388de5e99ab4\",\n      \"call_element_id\": \"20210609-a297ae04-a875-4cfd-85ab-4adcead91edb\",\n      \"duration\": 3,\n      \"caller_name\": \"Rascoe Thomas\",\n      \"caller_did_number\": \"+12055967465\",\n      \"callee_extension_type\": \"callQueue\",\n      \"callee_name\": \"Chris's_CQ01_2_members\",\n      \"callee_did_number\": \"+15104381494\",\n      \"callee_number_type\": 1,\n      \"date_time\": \"2021-08-19T00:16:22Z\",\n      \"download_url\": \"https://example.com/v2/phone/voice_mails/download/6q6cLeR8Q4WCdWGmGxCLEw\",\n      \"id\": \"70ea156dc8414742839569c1556c3314\",\n      \"callee_number\": \"58011\",\n      \"caller_number\": \"12059014629\",\n      \"caller_number_type\": 2,\n      \"access_member_id\": \"z8yCxjabcdEFGHfp8uQ\",\n      \"access_member_extension_type\": \"user\"\n    }\n  },\n  \"event_ts\": 1629332182327,\n  \"event\": \"phone.voicemail_received_for_access_member\"\n}"}}}}}}}},"phone.callee_unhold":{"post":{"tags":["phone"],"operationId":"phone.callee_unhold","requestBody":{"description":"# phone.callee_unhold\n---\n\nThe **Callee unhold a phone call** event triggers every time the person who is being called by the caller over Zoom Phone unholds the phone call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* The \"**Callee unhold a phone call**\" subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.callee_unhold`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold ended, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_unhold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The long (int64) format timestamp in milliseconds since epoch when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The callee's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The date and time (GMT) at which the call hold ended, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.callee_unhold\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"caller\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"callee\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}},"phone.conference_started":{"post":{"tags":["phone"],"operationId":"phone.conference_started","requestBody":{"description":"# phone.conference_started\n---\n\nThe **Conference call started** event triggers when a conference call has started.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"Call conference started\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:conference:master`,`phone:read:conference`,`phone:read:conference:admin`\n\n**Event type**: `phone.conference_started`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason a conference call failed to start. If it is an empty string, it means success."},"enable_multiple_party_conference":{"description":"Whether to enable multiple parties to join the conference call.<br>\ntrue: enable<br>\n false: disable","type":"boolean","example":true},"conference_id":{"type":"string","description":"The conference ID. See enable_multiple_party_conference above. No conference ID provided if the option for multiple parties to join the conference is disabled."},"call_id":{"type":"string","description":"The call ID."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the conference call started, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.conference_started\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"failure_reason\": \"\",\n      \"call_id\" : \"6986878782238080581\",\n      \"enable_multiple_party_conference\": true,\n      \"conference_id\": \"2074969d-621f-41d3-890c-8a44a03fa3e0\",\n      \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            },\n      \"date_time\" : \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch when the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["call_id","date_time"],"properties":{"failure_reason":{"type":"string","description":"The reason a conference call failed to start. If it is an empty string, it means success."},"enable_multiple_party_conference":{"description":"Whether to enable multiple parties to join the conference call.<br>\ntrue: enable<br>\n false: disable","type":"boolean","example":true},"conference_id":{"type":"string","description":"The conference ID. See enable_multiple_party_conference above. No conference ID provided if the option for multiple parties to join the conference is disabled."},"call_id":{"type":"string","description":"The call ID."},"owner":{"properties":{"extension_number":{"description":"The owner's extension number.","type":"integer","example":"1000001019"},"id":{"description":"The owner ID.","type":"string","example":"N3hAhug-QVyFPYZJrHpRaQ"},"name":{"description":"The owner name.","type":"string","example":"123@test.com"},"type":{"description":"The owner type:\n*user\n*callQueue\n*autoReceptionist\n*commonAreaPhone\n*sharedLineGroup","enum":["user","callQueue","autoReceptionist","commonAreaPhone","sharedLineGroup"],"type":"string","example":"user"}},"type":"object"},"date_time":{"type":"string","description":"The date and time (GMT) when the conference call started, in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\" : \"phone.conference_started\",\n\t\"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"failure_reason\": \"\",\n      \"call_id\" : \"6986878782238080581\",\n      \"enable_multiple_party_conference\": true,\n      \"conference_id\": \"2074969d-621f-41d3-890c-8a44a03fa3e0\",\n      \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            },\n      \"date_time\" : \"2021-07-20T05:38:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.fax_sent":{"post":{"tags":["phone"],"operationId":"phone.fax_sent","requestBody":{"description":"# phone.fax_sent\n---\nThe **Fax Sent** event triggers when a fax has been successfully sent from a Zoom Phone user or extension.\n\nThis event provides detailed information about the fax transmission, including sender and receiver details, file information, and transmission status.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Fax Sent** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`,`phone:write`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_fax_log`,`phone:read:list_fax_log:admin`,`phone:read:list_fax_log:master`\n\n**Event type**: `phone.fax_sent`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_sent"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_log_id","fax_id","site_id","site_name","extension_id","extension_type","direction","sender_extension_id","sender_extension_type","sender_extension_number","sender_name","sender_number","sender_type","receiver_extension_id","receiver_extension_type","receiver_extension_number","receiver_name","receiver_number","receiver_type","file_id","file_pages_count","status","create_time"],"description":"object","properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."},"fax_id":{"type":"string","description":"The unique fax session ID."},"site_id":{"type":"string","description":"The site ID."},"site_name":{"type":"string","description":"The site name."},"extension_id":{"type":"string","description":"The owner's extension ID."},"extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The owner's extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The fax log's direction:\n* inbound\n* outbound"},"sender_extension_id":{"type":"string","description":"The sender extension ID."},"sender_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The sender extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"sender_extension_number":{"type":"string","description":"The sender extension number."},"sender_name":{"type":"string","description":"The sender name."},"sender_number":{"type":"string","description":"The sender fax number."},"sender_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The sender endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"sender_location":{"type":"string","description":"The sender location."},"receiver_extension_id":{"type":"string","description":"The receiver extension ID."},"receiver_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The receiver extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"receiver_extension_number":{"type":"string","description":"The receiver extension number."},"receiver_name":{"type":"string","description":"The receiver name."},"receiver_number":{"type":"string","description":"The receiver fax number."},"receiver_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The receiver endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"receiver_location":{"type":"string","description":"The receiver location."},"file_id":{"type":"string","description":"The fax PDF file ID."},"file_pages_count":{"type":"integer","description":"The number of pages in the fax file."},"status":{"type":"string","enum":["failed","processing","submitted","sent","received"],"description":"The fax status:\n* failed\n* processing\n* submitted\n* sent\n* received"},"create_time":{"type":"string","format":"date-time","description":"The fax creation time in UTC."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_sent\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\",\n      \"fax_id\": \"6A2BE84EE494479B9AFA29F4BB8A8EA6\",\n      \"site_id\": \"rtZRykrtTmKSWXJeW-xsBg\",\n      \"site_name\": \"Main Site\",\n      \"extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"extension_type\": \"user\",\n      \"direction\": \"outbound\",\n      \"sender_extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"sender_extension_type\": \"user\",\n      \"sender_extension_number\": \"123\",\n      \"sender_name\": \"Tester 1\",\n      \"sender_number\": \"+12092080933\",\n      \"sender_type\": \"client\",\n      \"sender_location\": \"California\",\n      \"receiver_extension_id\": \"iKBkkqgGQV-bEttrhP5T0g\",\n      \"receiver_extension_type\": \"user\",\n      \"receiver_extension_number\": \"456\",\n      \"receiver_name\": \"Tester 2\",\n      \"receiver_number\": \"+14085559876\",\n      \"receiver_type\": \"client\",\n      \"receiver_location\": \"Alabama\",\n      \"file_id\": \"bayEy0y9RsadUbuEGrZBYA\",\n      \"file_pages_count\": 6,\n      \"status\": \"sent\",\n      \"create_time\": \"2021-10-08T16:12:04Z\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.fax_sent"],"description":"The event's name."},"event_ts":{"type":"integer","format":"int64","description":"A timestamp, in milliseconds since epoch, at which the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The owner account ID."},"object":{"type":"object","required":["fax_log_id","fax_id","site_id","site_name","extension_id","extension_type","direction","sender_extension_id","sender_extension_type","sender_extension_number","sender_name","sender_number","sender_type","receiver_extension_id","receiver_extension_type","receiver_extension_number","receiver_name","receiver_number","receiver_type","file_id","file_pages_count","status","create_time"],"description":"object","properties":{"fax_log_id":{"type":"string","description":"The unique fax log ID."},"fax_id":{"type":"string","description":"The unique fax session ID."},"site_id":{"type":"string","description":"The site ID."},"site_name":{"type":"string","description":"The site name."},"extension_id":{"type":"string","description":"The owner's extension ID."},"extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The owner's extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The fax log's direction:\n* inbound\n* outbound"},"sender_extension_id":{"type":"string","description":"The sender extension ID."},"sender_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The sender extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"sender_extension_number":{"type":"string","description":"The sender extension number."},"sender_name":{"type":"string","description":"The sender name."},"sender_number":{"type":"string","description":"The sender fax number."},"sender_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The sender endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"sender_location":{"type":"string","description":"The sender location."},"receiver_extension_id":{"type":"string","description":"The receiver extension ID."},"receiver_extension_type":{"type":"string","enum":["user","callQueue","autoReceptionist","commonArea","sharedLineGroup"],"description":"The receiver extension type:\n* user\n* callQueue\n* autoReceptionist\n* commonArea\n* sharedLineGroup"},"receiver_extension_number":{"type":"string","description":"The receiver extension number."},"receiver_name":{"type":"string","description":"The receiver name."},"receiver_number":{"type":"string","description":"The receiver fax number."},"receiver_type":{"type":"string","enum":["client","ata","pstn","email","openapi"],"description":"The receiver endpoint type:\n* client\n* ata\n* pstn\n* email\n* openapi"},"receiver_location":{"type":"string","description":"The receiver location."},"file_id":{"type":"string","description":"The fax PDF file ID."},"file_pages_count":{"type":"integer","description":"The number of pages in the fax file."},"status":{"type":"string","enum":["failed","processing","submitted","sent","received"],"description":"The fax status:\n* failed\n* processing\n* submitted\n* sent\n* received"},"create_time":{"type":"string","format":"date-time","description":"The fax creation time in UTC."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.fax_sent\",\n  \"event_ts\": 1619155281301,\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"fax_log_id\": \"w2cCmMNsRc-pMFhksHrRdQ\",\n      \"fax_id\": \"6A2BE84EE494479B9AFA29F4BB8A8EA6\",\n      \"site_id\": \"rtZRykrtTmKSWXJeW-xsBg\",\n      \"site_name\": \"Main Site\",\n      \"extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"extension_type\": \"user\",\n      \"direction\": \"outbound\",\n      \"sender_extension_id\": \"VLhIp1jHR_Sgu96DLJpjag\",\n      \"sender_extension_type\": \"user\",\n      \"sender_extension_number\": \"123\",\n      \"sender_name\": \"Tester 1\",\n      \"sender_number\": \"+12092080933\",\n      \"sender_type\": \"client\",\n      \"sender_location\": \"California\",\n      \"receiver_extension_id\": \"iKBkkqgGQV-bEttrhP5T0g\",\n      \"receiver_extension_type\": \"user\",\n      \"receiver_extension_number\": \"456\",\n      \"receiver_name\": \"Tester 2\",\n      \"receiver_number\": \"+14085559876\",\n      \"receiver_type\": \"client\",\n      \"receiver_location\": \"Alabama\",\n      \"file_id\": \"bayEy0y9RsadUbuEGrZBYA\",\n      \"file_pages_count\": 6,\n      \"status\": \"sent\",\n      \"create_time\": \"2021-10-08T16:12:04Z\"\n    }\n  }\n}"}}}}}}}},"phone.generic_device_provision":{"post":{"tags":["phone"],"operationId":"phone.generic_device_provision","requestBody":{"description":"# phone.generic_device_provision\n---\n\nThe **Zoom Phone device provisioned** event triggers every time an admin or end user makes any of the following changes to a device:\n* Adding or removing a Direct Inward Dialing (DID) service\n* Adding or removing a delegation\n* Adding or removing a shared line group\n* Changing line labels or caller ID information\n* Changing the site where a user is assigned\n* Changing the Session Initiation Protocol (SIP) Zone assignment for a site where the user is assigned\n* Adding or removing a device from a user\n\nTo receive this notification, you must meet the prerequisites listed below.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* A valid **Event Notification Endpoint URL**.\n\t* **\"Zoom Phone device provisioned\"** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:device:master`,`phone:read:device:admin`\n\n**Event type**: `phone.generic_device_provision`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event.","default":"phone.generic_device_provision"},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","display_name","device_type","mac_address"],"properties":{"id":{"type":"string","description":"The device ID."},"display_name":{"type":"string","description":"Device name."},"device_type":{"type":"string","description":"Manufactuer name + model name."},"mac_address":{"type":"string","description":"MAC address or serial number."},"site":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the site to assign the phone user to."},"name":{"type":"string","description":"The display name of the site to assign the phone user to."}},"additionalProperties":false},"provision":{"type":"object","required":["type"],"description":"If the device is unassigned, provision will not display.","properties":{"type":{"type":"string","enum":["manual"],"description":"Value: manual","default":"manual"},"sip_accounts":{"type":"array","description":"SIP account details for the device.","items":{"type":"object","required":["outbound_proxy","user_name","authorization_id","password"],"properties":{"sip_domain":{"type":"string","description":"A SIP domain is a DNS hostname that can accept SIP traffic for your Zoom meeting. If you make a SIP request using SIP domain, such as sip:66666666@zoomcrc.com , it will route to the Zoom meeting service.","format":"hostname"},"outbound_proxy":{"type":"string","description":"The SIP/outbound proxy address for the Zoom phone."},"secondary_outbound_proxy":{"type":"string","description":"The secondary outbound proxy provided in the provisioning process."},"user_name":{"type":"string"},"authorization_id":{"type":"string"},"password":{"type":"string"},"shared_line":{"type":"object","required":["line_subscription"],"properties":{"line_subscription":{"type":"object","properties":{"phone_number":{"type":"string"},"extension_number":{"type":"integer","minLength":1},"display_name":{"type":"string","minLength":1}},"additionalProperties":false},"alias":{"type":"string"},"outbound_caller_id":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.generic_device_provision\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"id\": \"JOZmuJ30Spyrw-v9vUzIrA\",\n      \"display_name\": \"test_cap\",\n      \"device_type\": \"Other \",\n      \"mac_address\": \"012345678912\",\n      \"site\": {\n        \"id\": \"8f71O6rWT8KFUGQmJIFAdQ\",\n        \"name\": \"Main Site\"\n      },\n      \"provision\": {\n        \"type\": \"manual\",\n        \"sip_accounts\": [\n          {\n            \"password\": \"4dL09r0H\",\n            \"sip_domain\": \"example.com\",\n            \"outbound_proxy\": \"example.com\",\n            \"secondary_outbound_proxy\": \"example.com\",\n            \"user_name\": \"83600015247557791369\",\n            \"authorization_id\": \"875586205903\",\n            \"shared_line\": {\n              \"line_subscription\": {\n                \"phone_number\": \"+12055433429\",\n                \"extension_number\": 1040,\n                \"display_name\": \"test_cap\"\n              },\n              \"outbound_caller_id\": \"+12055433429\"\n            }\n          }\n        ]\n      }\n    }\n  },\n  \"event_ts\": 1625034680324\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event.","default":"phone.generic_device_provision"},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the user."},"object":{"type":"object","required":["id","display_name","device_type","mac_address"],"properties":{"id":{"type":"string","description":"The device ID."},"display_name":{"type":"string","description":"Device name."},"device_type":{"type":"string","description":"Manufactuer name + model name."},"mac_address":{"type":"string","description":"MAC address or serial number."},"site":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The ID of the site to assign the phone user to."},"name":{"type":"string","description":"The display name of the site to assign the phone user to."}},"additionalProperties":false},"provision":{"type":"object","required":["type"],"description":"If the device is unassigned, provision will not display.","properties":{"type":{"type":"string","enum":["manual"],"description":"Value: manual","default":"manual"},"sip_accounts":{"type":"array","description":"SIP account details for the device.","items":{"type":"object","required":["outbound_proxy","user_name","authorization_id","password"],"properties":{"sip_domain":{"type":"string","description":"A SIP domain is a DNS hostname that can accept SIP traffic for your Zoom meeting. If you make a SIP request using SIP domain, such as sip:66666666@zoomcrc.com , it will route to the Zoom meeting service.","format":"hostname"},"outbound_proxy":{"type":"string","description":"The SIP/outbound proxy address for the Zoom phone."},"secondary_outbound_proxy":{"type":"string","description":"The secondary outbound proxy provided in the provisioning process."},"user_name":{"type":"string"},"authorization_id":{"type":"string"},"password":{"type":"string"},"shared_line":{"type":"object","required":["line_subscription"],"properties":{"line_subscription":{"type":"object","properties":{"phone_number":{"type":"string"},"extension_number":{"type":"integer","minLength":1},"display_name":{"type":"string","minLength":1}},"additionalProperties":false},"alias":{"type":"string"},"outbound_caller_id":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.generic_device_provision\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"id\": \"JOZmuJ30Spyrw-v9vUzIrA\",\n      \"display_name\": \"test_cap\",\n      \"device_type\": \"Other \",\n      \"mac_address\": \"012345678912\",\n      \"site\": {\n        \"id\": \"8f71O6rWT8KFUGQmJIFAdQ\",\n        \"name\": \"Main Site\"\n      },\n      \"provision\": {\n        \"type\": \"manual\",\n        \"sip_accounts\": [\n          {\n            \"password\": \"4dL09r0H\",\n            \"sip_domain\": \"example.com\",\n            \"outbound_proxy\": \"example.com\",\n            \"secondary_outbound_proxy\": \"example.com\",\n            \"user_name\": \"83600015247557791369\",\n            \"authorization_id\": \"875586205903\",\n            \"shared_line\": {\n              \"line_subscription\": {\n                \"phone_number\": \"+12055433429\",\n                \"extension_number\": 1040,\n                \"display_name\": \"test_cap\"\n              },\n              \"outbound_caller_id\": \"+12055433429\"\n            }\n          }\n        ]\n      }\n    }\n  },\n  \"event_ts\": 1625034680324\n}"}}}}}}}},"phone.recording_paused":{"post":{"tags":["phone"],"operationId":"phone.recording_paused","requestBody":{"description":"# phone.recording_paused\n---\nThe **Call recording is paused** event triggers when the owner pauses the recording during a phone call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording is paused** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_paused`\n","content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","owner"],"properties":{"id":{"type":"string","description":"The recording ID."},"user_id":{"type":"string","description":"The user ID."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or the extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or the extension number of the callee."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call: inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Time and date when the recording was paused."},"recording_type":{"type":"string","description":"The type of the recording: OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner type: user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"Display name of the owner."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_paused\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"Name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","owner"],"properties":{"id":{"type":"string","description":"The recording ID."},"user_id":{"type":"string","description":"The user ID."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"Phone number or the extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"Phone number or the extension number of the callee."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"Direction of the call: inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"Time and date when the recording was paused."},"recording_type":{"type":"string","description":"The type of the recording: OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"Unique identifier of the call."},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The owner type: user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The owner ID."},"name":{"type":"string","description":"Display name of the owner."},"extension_number":{"description":"Extension number of the owner","type":"integer"}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n\t\"event\": \"phone.recording_paused\",\n\t\"event_ts\": 1626230691572,\n\t\"payload\": {\n\t\t\"account_id\": \"AAAAAABBBB\",\n\n\t\t\"object\": {\n\t\t\t\"id\": \"abcD3ojfdbjfg\",\n\t\t\t\"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n            \"caller_number\": \"1026\",\n            \"callee_number\": \"1045\",\n            \"direction\": \"outbound\",\n            \"date_time\": \"2021-06-09T06:09:24Z\",\n            \"recording_type\": \"OnDemand\",\n            \"call_id\": \"6971672158469969953\",\n            \"owner\" : {\n                \"type\" : \"user\",\n                \"id\" : \"z8yCxjabcdEFGHfp8uQ\",\n                \"name\" : \"usersubsetting0001\",\n                \"extension_number\": 6666\n            }\n\t\t}\n\t}\n}"}}}}}}}},"phone.sms_received":{"post":{"tags":["phone"],"operationId":"phone.sms_received","requestBody":{"description":"# phone.sms_received\n---\nThe **SMS received by Zoom phone** event triggers when a user account receives an SMS message. The recipient must be a user on your account or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.\n\nZoom Phone users can receive text messages [(SMS)](https://support.zoom.us/hc/en-us/articles/360054155112-Using-SMS) using the Zoom desktop client or a [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) mobile app.\n\n\n\n\n## **Prerequisites**\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* **SMS received by Zoom phone** subscription enabled under the **Phone** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message:master`,`phone:read:sms_message`,`phone:read:sms_message:admin`\n\n**Event type**: `phone.sms_received`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_received"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of the received SMS/MMS.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"The SMS sender's ID."},"type":{"type":"string","description":"The type of sender:\n*user\n*callQueue\n*autoReceptionist.","enum":["user","callQueue","autoReceptionist"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's user ID."},"type":{"type":"string","description":"The type of receiver: \n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."},"is_message_owner":{"type":"boolean","description":"Whether it is the owner of the message."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS","type":"object","properties":{"type":{"type":"string","description":"The type of owner:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The user ID of the user who received this SMS."},"team_id":{"type":"string","description":"The owner's ID when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The media file ID."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of the file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The message type."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The media file ID."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of the file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+120944XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_received\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\",\n        \"type\": \"user\",\n        \"display_name\": \"Jackson\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"id\": \"RMITfuhuuxyzyuyyi3Kfg\",\n          \"type\": \"user\",\n          \"display_name\": \"Tomcat\",\n          \"is_message_owner\": true\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\",\n        \"team_id\": \"milmMfm3SYCwkraYIriNiQ\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.sms_received"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the owner."},"object":{"description":"The payload of the received SMS/MMS.","type":"object","required":["sender","to_members","owner","message","attachments","session_id","message_id","message_type","date_time"],"properties":{"sender":{"type":"object","description":"The SMS sender.","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"The SMS sender's phone number."},"id":{"type":"string","description":"The SMS sender's ID."},"type":{"type":"string","description":"The type of sender:\n*user\n*callQueue\n*autoReceptionist.","enum":["user","callQueue","autoReceptionist"]},"display_name":{"type":"string","description":"The SMS sender's display name."}},"additionalProperties":true},"to_members":{"type":"array","description":"The SMS receivers.","items":{"type":"object","required":["phone_number"],"properties":{"id":{"type":"string","description":"The SMS receiver's user ID."},"type":{"type":"string","description":"The type of receiver: \n*user.","enum":["user"]},"display_name":{"type":"string","description":"The SMS receiver's display name."},"phone_number":{"type":"string","description":"The SMS receiver's phone number."},"is_message_owner":{"type":"boolean","description":"Whether it is the owner of the message."}},"additionalProperties":true}},"owner":{"description":"The owner of this SMS/MMS","type":"object","properties":{"type":{"type":"string","description":"The type of owner:\n*user\n*callQueue\n*autoReceptionist","enum":["user","callQueue","autoReceptionist"]},"id":{"type":"string","description":"The user ID of the user who received this SMS."},"team_id":{"type":"string","description":"The owner's ID when the owner type is callQueue or autoReceptionist."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The media file ID."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of the file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The message type."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."}},"message":{"type":"string","description":"The SMS text content."},"attachments":{"type":"array","description":"The media file information.","items":{"type":"object","required":["id","size","name","type","download_url"],"properties":{"id":{"type":"string","description":"The media file ID."},"size":{"type":"integer","description":"The size of the file in bytes."},"name":{"type":"string","description":"The name of the file."},"type":{"type":"string","description":"The type of the file."},"download_url":{"type":"string","description":"The URL using which the file can be downloaded."}},"additionalProperties":true}},"session_id":{"type":"string","description":"The SMS session ID."},"message_id":{"type":"string","description":"The SMS message ID."},"message_type":{"type":"integer","description":"The type of messages."},"date_time":{"type":"string","format":"date-time","description":"The date and time at which the SMS was received."},"phone_number_campaign_opt_statuses":{"type":"array","maxItems":100,"description":"The list of opt statuses for each number pair.","items":{"required":["consumer_phone_number","opt_status","zoom_phone_user_number"],"type":"object","properties":{"consumer_phone_number":{"type":"string","description":"The end user's phone number in E164 format that sends the Opt-in or Opt-out keyword to the Zoom Phone number.","example":"+150434XXXXX"},"zoom_phone_user_number":{"type":"string","description":"The Zoom user's phone number in E164 format that receives the Opt-in or Opt-out keyword from the end user.","example":"+120944XXXXX"},"opt_status":{"type":"string","description":"The opt status.","example":"opt_out","enum":["pending","opt_out","opt_in"]},"opt_in_status":{"type":"integer","description":"The Opt-In status between the Zoom Phone user number and consumer phone number. This is a sub-status of opt_status and uses the following enumeration: \n0: Default status. The Opt-In status for the Zoom Phone user number cannot be determined. This may occur when the Zoom Phone user number is not associated with a Campaign, among other reasons.\n1: This is a new SMS session and an Opt-In message must be sent first.\n2: An Opt-In message has been sent and a response is pending.\n3: An Opt-In message has been sent and the recipient has consented to receive additional SMS messages.\n4: An Opt-In message has been sent, but the recipient has declined to receive additional SMS messages, or the number has been configured to block all outbound SMS messages.","example":0,"enum":[0,1,2,3,4]},"opt_in_message":{"type":"string","description":"If opt_in_status=1, the opt_in_message will return the Opt-In message of the Campaign bound to zoom_phone_user_number. In this case, you must send the opt_in_message as the first message in the SMS session and then wait for the Opt-In response.","example":"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.sms_received\",\n  \"event_ts\": 1626759486127,\n  \"payload\": {\n    \"account_id\": \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\": {\n      \"sender\": {\n        \"phone_number\": \"12132822256\",\n        \"id\": \"RMIGplfpSLauTMDMTi3Kfg\",\n        \"type\": \"user\",\n        \"display_name\": \"Jackson\"\n      },\n      \"to_members\": [\n        {\n          \"phone_number\": \"12132792348\",\n          \"id\": \"RMITfuhuuxyzyuyyi3Kfg\",\n          \"type\": \"user\",\n          \"display_name\": \"Tomcat\",\n          \"is_message_owner\": true\n        }\n      ],\n      \"owner\": {\n        \"type\": \"callQueue\",\n        \"id\": \"29QVgYBGRmOM5VlC0DmLgg\",\n        \"team_id\": \"milmMfm3SYCwkraYIriNiQ\"\n      },\n      \"message\": \"ttt\",\n      \"attachments\": [\n        {\n          \"id\": \"ux7LtGDPRmqbo0nLQ2v9jQ\",\n          \"size\": 10692,\n          \"name\": \"Screenshot2021_05_17_183842.jpg\",\n          \"type\": \"jpg\",\n          \"download_url\": \"https://downloadUrl.zoom.us\"\n        }\n      ],\n      \"session_id\": \"e5e9b8417c1f2da2cd3006f3d9d4641a\",\n      \"message_id\": \"72abd192-97ee-4ddb-b498-85048f4c34d7\",\n      \"message_type\": 1,\n      \"date_time\": \"2021-07-19T18:43:43Z\",\n      \"phone_number_campaign_opt_statuses\": [\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"opt_in\",\n          \"opt_in_status\": 0\n        },\n        {\n          \"consumer_phone_number\": \"+120970XXXXX\",\n          \"zoom_phone_user_number\": \"+120971XXXXX\",\n          \"opt_status\": \"pending\",\n          \"opt_in_status\": 1,\n          \"opt_in_message\": \"Text START to receive text messages from ZOOM. Message frequency may vary. Message and Data Rates may apply. To end messaging from us, reply with STOP. Reply with HELP for more information.\"\n        }\n      ]\n    }\n  }\n}"}}}}}}}},"phone.recording_failed":{"post":{"tags":["phone"],"operationId":"phone.recording_failed","requestBody":{"description":"# phone.recording_failed\n---\n\nThe **Call recording failed** event triggers when the recording of a phone call fails.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Call recording failed** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_recording:master`,`phone:read:call_recording`,`phone:read:call_recording:admin`\n\n**Event type**: `phone.recording_failed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"The name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"The ID of the recording"},"user_id":{"type":"string","description":"The ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"The unique identifier of the call."},"channel_id":{"type":"string","description":"The ID of the channel"},"sip_id":{"type":"string","description":"The ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The type of the owner. This value field can be user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The ID of the owner."},"name":{"type":"string","description":"The display name of the owner"},"extension_number":{"description":"The extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_failed\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"TAjiGweoTLeK72SaeocBZg\",\n    \"object\": {\n      \"id\": \"abcD3ojfdbjfg\",\n      \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n      \"caller_number\": \"1026\",\n      \"callee_number\": \"1045\",\n      \"direction\": \"outbound\",\n      \"date_time\": \"2021-06-09T06:09:24Z\",\n      \"recording_type\": \"OnDemand\",\n      \"call_id\": \"6971672158469969953\",\n      \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n      \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      }\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","payload","event_ts"],"properties":{"event":{"type":"string","description":"The name of the event."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the user."},"object":{"type":"object","required":["id","user_id","caller_number","callee_number","direction","date_time","recording_type","call_id","channel_id","owner","sip_id"],"properties":{"id":{"type":"string","description":"The ID of the recording"},"user_id":{"type":"string","description":"The ID of the user."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_number":{"type":"string","description":"The phone number or extension number of the caller."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_number":{"type":"string","description":"The phone number or extension number of the caller."},"direction":{"type":"string","enum":["inbound","outbound"],"description":"The direction of the call. The value of this field can either be inbound or outbound."},"date_time":{"type":"string","format":"date-time","description":"The start date and time of the call."},"recording_type":{"type":"string","description":"The type of the recording. This value field can be OnDemand or Automatic.","enum":["OnDemand","Automatic"]},"call_id":{"type":"string","description":"The unique identifier of the call."},"channel_id":{"type":"string","description":"The ID of the channel"},"sip_id":{"type":"string","description":"The ID of the sip call"},"owner":{"type":"object","description":"The owner of the recording.","required":["type","id","name"],"properties":{"type":{"type":"string","description":"The type of the owner. This value field can be user or callQueue.","enum":["user","callQueue","commonArea"]},"id":{"type":"string","description":"The ID of the owner."},"name":{"type":"string","description":"The display name of the owner"},"extension_number":{"description":"The extension number of the owner","type":"integer"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.recording_failed\",\n  \"event_ts\": 1626230691572,\n  \"payload\": {\n    \"account_id\": \"TAjiGweoTLeK72SaeocBZg\",\n    \"object\": {\n      \"id\": \"abcD3ojfdbjfg\",\n      \"user_id\": \"z8yCxjabcdEFGHfp8uQ\",\n      \"caller_number\": \"1026\",\n      \"callee_number\": \"1045\",\n      \"direction\": \"outbound\",\n      \"date_time\": \"2021-06-09T06:09:24Z\",\n      \"recording_type\": \"OnDemand\",\n      \"call_id\": \"6971672158469969953\",\n      \"channel_id\": \"5c01a45b-53a8-4773-b244-beb670c13357\",\n      \"sip_id\": \"VeSbXj3yttX-ghGskIP_ew..d90446d0@10002222.zoomdev.us\",\n      \"owner\": {\n        \"type\": \"user\",\n        \"id\": \"z8yCxjabcdEFGHfp8uQ\",\n        \"name\": \"usersubsetting0001\",\n        \"extension_number\": 6666\n      }\n    }\n  }\n}"}}}}}}}},"phone.route_group_status_changed":{"post":{"tags":["phone"],"operationId":"phone.route_group_status_changed","requestBody":{"description":"# phone.route_group_status_changed\n---\nThe **Route group status changed** event triggers when a SIP trunk status changes.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n* A valid **Event Notification Endpoint URL**.\n* **\"Route group status changed\"** subscription must be enabled under the **Zoom Phone** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sip_trunk:master`,`phone:read:sip_trunk`,`phone:read:sip_trunk:admin`\n\n**Event type**: `phone.route_group_status_changed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.route_group_status_changed"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the owner."},"object":{"type":"object","description":"Information about the alert's settings.","required":["name","module","rule","target"],"properties":{"name":{"type":"string","description":"The name of the alert."},"module":{"type":"string","description":"The module for the alert."},"rule":{"type":"object","description":"The rule for the alert","properties":{"type":{"type":"integer","description":"The type of alert rule. 1 - Route groups status change."},"severity":{"type":"string","description":"The severity of the alert rule, warning or critical."}}},"target":{"type":"object","description":"The target of the alert.","properties":{"type":{"type":"integer","description":"The type of alert target. 1 - account."}}},"detected_time":{"type":"string","format":"date-time","description":"The detected time of the alert."},"sbc":{"type":"string","description":"The SBC of the route group."},"route_groups":{"type":"array","description":"A list of route groups","items":{"type":"object","required":["id","name","region"],"properties":{"id":{"type":"string","description":"The ID of the route group."},"name":{"type":"string","description":"The name of the route group."},"region":{"type":"string","description":"The region of the route group."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.route_group_status_changed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"name\": \"route group alert\",\n      \"module\": \"routeGroup\",\n      \"rule\": {\n        \"type\": 1,\n        \"severity\": \"warning\"\n      },\n      \"target\": {\n        \"type\": 1\n      },\n      \"detected_time\": \"2021-08-20T00:52:20Z\",\n      \"sbc\": \"23.244.91.35:5060\",\n      \"route_groups\": [\n        {\n          \"id\": \"_rq8mGC9RlSEDbYQwhFs_A\",\n          \"name\": \"TG_10009239_12\",\n          \"region\": \"newSipSj-z1\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1629420755266\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.route_group_status_changed"],"description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field returns in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The Account ID of the owner."},"object":{"type":"object","description":"Information about the alert's settings.","required":["name","module","rule","target"],"properties":{"name":{"type":"string","description":"The name of the alert."},"module":{"type":"string","description":"The module for the alert."},"rule":{"type":"object","description":"The rule for the alert","properties":{"type":{"type":"integer","description":"The type of alert rule. 1 - Route groups status change."},"severity":{"type":"string","description":"The severity of the alert rule, warning or critical."}}},"target":{"type":"object","description":"The target of the alert.","properties":{"type":{"type":"integer","description":"The type of alert target. 1 - account."}}},"detected_time":{"type":"string","format":"date-time","description":"The detected time of the alert."},"sbc":{"type":"string","description":"The SBC of the route group."},"route_groups":{"type":"array","description":"A list of route groups","items":{"type":"object","required":["id","name","region"],"properties":{"id":{"type":"string","description":"The ID of the route group."},"name":{"type":"string","description":"The name of the route group."},"region":{"type":"string","description":"The region of the route group."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.route_group_status_changed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"name\": \"route group alert\",\n      \"module\": \"routeGroup\",\n      \"rule\": {\n        \"type\": 1,\n        \"severity\": \"warning\"\n      },\n      \"target\": {\n        \"type\": 1\n      },\n      \"detected_time\": \"2021-08-20T00:52:20Z\",\n      \"sbc\": \"23.244.91.35:5060\",\n      \"route_groups\": [\n        {\n          \"id\": \"_rq8mGC9RlSEDbYQwhFs_A\",\n          \"name\": \"TG_10009239_12\",\n          \"region\": \"newSipSj-z1\"\n        }\n      ]\n    }\n  },\n  \"event_ts\": 1629420755266\n}"}}}}}}}},"phone.caller_call_history_completed":{"post":{"tags":["phone"],"operationId":"phone.caller_call_history_completed","requestBody":{"description":"# phone.caller_call_history_completed\n---\nThe **Caller call history is completed** event triggers every time the outgoing call history record for a call is made available for the caller to view.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event notification endpoint URL**.\n  * Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Caller call history is completed** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call_log:master`,`phone:read:call_log`,`phone:read:call_log:admin`\n\n**Event type**: `phone.caller_call_history_completed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_history_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id","call_path_id","result","start_time"],"properties":{"id":{"type":"string","description":"The ID of the call history."},"call_path_id":{"type":"string","description":"The call path ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_history_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_path_id\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","enum":["phone.caller_call_history_completed"],"description":"Event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID of the caller."},"object":{"type":"object","required":["call_logs","user_id"],"properties":{"user_id":{"type":"string","description":"The user ID of the caller."},"call_logs":{"type":"array","additionalItems":false,"items":{"type":"object","required":["id","call_id","call_path_id","result","start_time"],"properties":{"id":{"type":"string","description":"The ID of the call history."},"call_path_id":{"type":"string","description":"The call path ID of the call."},"call_id":{"type":"string","description":"The ID of the phone call."},"group_id":{"type":"string","description":"The primary group of which the user belongs."},"connect_type":{"type":"string","description":"The connect type of call.","enum":["internal","external"]},"call_type":{"type":"string","description":"The type of call.","enum":["general","emergency"]},"direction":{"type":"string","description":"The direction of the call.","enum":["inbound","outbound"]},"hide_caller_id":{"type":"boolean","description":"A flag to indicate the call is hide caller ID or not."},"end_to_end":{"type":"boolean","description":"A flag to indicate the call is End-to-End Encryption or not."},"caller_ext_id":{"type":"string","description":"The caller's extension ID."},"caller_name":{"type":"string","description":"The name of the caller."},"caller_email":{"type":"string","description":"The caller's email."},"caller_employee_id":{"type":"string","description":"Ther caller's employee id"},"caller_did_number":{"type":"string","description":"The caller's DID number in e164 format."},"caller_account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"caller_ext_number":{"type":"string","description":"The extension number of the caller."},"caller_ext_type":{"type":"string","description":"The caller's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"caller_number_type":{"type":"string","description":"The caller's number type.","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"]},"caller_device_private_ip":{"type":"string","description":"The caller's private IP."},"caller_device_public_ip":{"type":"string","description":"The caller's public IP."},"caller_device_type":{"type":"string","description":"The caller's device type."},"caller_country_iso_code":{"type":"string","description":"The caller's country ISO code."},"caller_country_code":{"type":"string","description":"The caller's country code."},"caller_site_id":{"type":"string","description":"The caller's site ID."},"caller_department":{"type":"string","description":"The caller's department."},"caller_cost_center":{"type":"string","description":"The caller's cost center."},"callee_ext_id":{"type":"string","description":"The callee's extension ID."},"callee_name":{"type":"string","description":"The name of the callee."},"callee_did_number":{"type":"string","description":"The callee's DID number in e164 format."},"callee_account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"callee_ext_number":{"type":"string","description":"The extension number of the callee."},"callee_email":{"type":"string","description":"The callee's email."},"callee_employee_id":{"type":"string","description":"Ther callee's employee id"},"callee_ext_type":{"type":"string","description":"The callee's extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"callee_number_type":{"type":"string","description":"The callee's number type.","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"]},"callee_device_private_ip":{"type":"string","description":"The callee's private IP."},"callee_device_public_ip":{"type":"string","description":"The callee's public IP."},"callee_device_type":{"type":"string","description":"The callee's device type."},"callee_country_iso_code":{"type":"string","description":"The callee's country ISO code."},"callee_country_code":{"type":"string","description":"The callee's country code."},"callee_site_id":{"type":"string","description":"The callee's site ID."},"callee_department":{"type":"string","description":"The callee's department."},"callee_cost_center":{"type":"string","description":"The callee's cost center."},"start_time":{"type":"string","description":"The call start time in GMT date-time format."},"answer_time":{"type":"string","description":"The call answer time in GMT date-time format."},"end_time":{"type":"string","description":"The call end time in GMT date-time format."},"event":{"type":"string","description":"An event within a call log.","enum":["incoming","transfer_from_zoom_contact_center","shared_line_incoming","outgoing","call_me_on","outgoing_to_zoom_contact_center","warm_transfer","forward","ring_to_member","overflow","direct_transfer","barge","monitor","whisper","listen","takeover","conference_barge","park","timeout","park_pick_up","merge","shared"]},"result":{"type":"string","description":"The detail result of an event for a call log.","enum":["answered","accepted","picked_up","connected","succeeded","voicemail","hang_up","canceled","call_failed","unconnected","rejected","busy","ring_timeout","overflowed","no_answer","invalid_key","invalid_operation","abandoned","system_blocked","service_unavailable"]},"result_reason":{"type":"string","description":"The reason of result of an event for a call log.","enum":["answered_by_other","pickup_by_other","call_out_by_other"]},"operator_ext_number":{"type":"string","description":"The operator extension number."},"operator_ext_id":{"type":"string","description":"The operator extension ID."},"operator_ext_type":{"type":"string","description":"The operator extension type.","enum":["user","call_queue","auto_receptionist","common_area","zoom_room","cisco_room","shared_line_group","group_call_pickup","external_contact"]},"operator_name":{"type":"string","description":"The operator's name."},"recording_id":{"type":"string","description":"The unique identifier of the call recording."},"recording_type":{"type":"string","description":"The type of call recording.","enum":["ad-hoc","automatic"]},"voicemail_id":{"type":"string","description":"The ID of the call voicemail."},"talk_time":{"type":"integer","description":"The call talk time in seconds."},"hold_time":{"type":"integer","description":"The call hold time in seconds."},"wait_time":{"type":"integer","description":"The call wait time in seconds."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.caller_call_history_completed\",\n  \"payload\": {\n    \"account_id\": \"TQTvjT52Tmi_wrhASNNOEw\",\n    \"object\": {\n      \"call_logs\": [\n        {\n          \"id\": \"20231008-48c1dfd4-91ce-4df5-8495-7c9e33d10869\",\n          \"call_path_id\": \"20231008-1ac1df2a-912e-d125-8a15-1a1233d10f1a\",\n          \"call_id\": \"7018317023722949162\",\n          \"group_id\": \"_sj190JDFasa19321_adA7\",\n          \"connect_type\": \"internal\",\n          \"call_type\": \"general\",\n          \"direction\": \"inbound\",\n          \"hide_caller_id\": true,\n          \"end_to_end\": false,\n          \"caller_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"caller_name\": \"Caller name\",\n          \"caller_email\": \"test@abc.com\",\n          \"caller_employee_id\": \"102911\",\n          \"caller_did_number\": \"+12059300920\",\n          \"caller_ext_number\": \"101229\",\n          \"caller_ext_type\": \"user\",\n          \"caller_number_type\": \"external_pstn\",\n          \"caller_device_private_ip\": \"10.0.0.1\",\n          \"caller_device_public_ip\": \"135.0.0.1\",\n          \"caller_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"caller_country_iso_code\": \"US\",\n          \"caller_country_code\": \"1\",\n          \"caller_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"caller_department\": \"web-api1\",\n          \"caller_cost_center\": \"cost-center1\",\n          \"callee_ext_id\": \"ATu63--9TjudZetpf4UuQg\",\n          \"callee_name\": \"Callee name\",\n          \"callee_did_number\": \"+12059300920\",\n          \"callee_ext_number\": \"101229\",\n          \"callee_email\": \"test@abc.com\",\n          \"callee_employee_id\": \"102912\",\n          \"callee_ext_type\": \"user\",\n          \"callee_number_type\": \"external_pstn\",\n          \"callee_device_private_ip\": \"10.0.0.2\",\n          \"callee_device_public_ip\": \"135.0.0.2\",\n          \"callee_device_type\": \"MAC_Client(6.0.2.33403)\",\n          \"callee_country_iso_code\": \"US\",\n          \"callee_country_code\": \"1\",\n          \"callee_site_id\": \"BpCTBMRARBefUrprildVqw\",\n          \"callee_department\": \"web-api1\",\n          \"callee_cost_center\": \"cost-center1\",\n          \"start_time\": \"2023-10-08T16:12:04Z\",\n          \"answer_time\": \"2023-10-08T16:12:04Z\",\n          \"end_time\": \"2023-10-08T16:12:15Z\",\n          \"event\": \"outgoing\",\n          \"result\": \"answered\",\n          \"result_reason\": \"answered_by_other\",\n          \"operator_ext_number\": \"3456\",\n          \"operator_ext_id\": \"NN9rA4fZSsScB2YiCqw7Ig\",\n          \"operator_ext_type\": \"user\",\n          \"operator_name\": \"operator name\",\n          \"recording_id\": \"c71b360f6e774e3aa101453117b7e1a7\",\n          \"recording_type\": \"automatic\",\n          \"voicemail_id\": \"6cd2da01bcaa47f58e3250a575c5f2bf\",\n          \"talk_time\": 31,\n          \"hold_time\": 20,\n          \"wait_time\": 20\n        }\n      ],\n      \"user_id\": \"IqoQmDRqS-aIoXqV_FZ88w\"\n    }\n  },\n  \"event_ts\": 1623218132807\n}"}}}}}}}},"phone.peering_number_cnam_updated":{"post":{"tags":["phone"],"operationId":"phone.peering_number_cnam_updated","requestBody":{"description":"# phone.peering_number_cnam_updated\n---\n\nThe **CNAM has changed** event triggers when the Caller ID name (CNAM) has been updated for PSTN phone numbers.\n\n## Prerequisites\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be a user or account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **\"CNAM has changed\"** subscription must be enabled under the **Zoom Phone** event.\n\n> This event is for use by partners that have completed the MoU to peer with Zoom. To become a peering provider/ carrier, please submit your [request](https://docs.google.com/forms/d/e/1FAIpQLSewkY6ixVyKVNkWC-vgmejC16gigxsJWXji3dWzE3XlWtjsgg/viewform).\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone_peering:read:admin`,`phone_peering:write:admin`,`phone_peering:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:peering_number:master`,`phone:read:peering_number:admin`\n\n**Event type**: `phone.peering_number_cnam_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the customer using provider exchange."},"object":{"type":"object","required":["carrier_code","phone_numbers"],"properties":{"cnam":{"type":"string","description":"The caller ID name."},"carrier_code":{"type":"integer","description":"The carrier code."},"phone_numbers":{"type":"array","description":"The phone numbers with CNAM updates."}},"additionalProperties":false}},"additionalProperties":false}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.peering_number_cnam_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"cnam\": \"name\",\n      \"carrier_code\": 3457,\n      \"phone_numbers\": [\n       \"18008001000\"\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","format":"int64","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"Account ID of the customer using provider exchange."},"object":{"type":"object","required":["carrier_code","phone_numbers"],"properties":{"cnam":{"type":"string","description":"The caller ID name."},"carrier_code":{"type":"integer","description":"The carrier code."},"phone_numbers":{"type":"array","description":"The phone numbers with CNAM updates."}},"additionalProperties":false}},"additionalProperties":false}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\": \"phone.peering_number_cnam_updated\",\n  \"payload\": {\n    \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n    \"object\": {\n      \"cnam\": \"name\",\n      \"carrier_code\": 3457,\n      \"phone_numbers\": [\n       \"18008001000\"\n      ]\n    }\n  },\n  \"event_ts\": 1619155436400\n}"}}}}}}}},"phone.caller_mute":{"post":{"tags":["phone"],"operationId":"phone.caller_mute","requestBody":{"description":"# phone.caller_mute\n\nThe **Caller mutes a phone call** event triggers when the caller mutes themselves during a call.\n\n## Prerequisites\n\n* [Zoom Phone Plan](https://zoom.us/phonesystem)\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* Your app must either be an account level OAuth App or a Webhook Only app. For more information, see [Enable webhooks](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks).\n\t* **Caller mutes a phone call** subscription must be enabled under the **Zoom Phone** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:write:admin`,`phone:read`,`phone:write`,`phone:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:call:master`,`phone:read:call`,`phone:read:call:admin`\n\n**Event type**: `phone.caller_mute`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the caller muted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_mute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp in milliseconds since epoch at which the event occurred; long (int64) format."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The caller's account ID."},"object":{"type":"object","required":["call_id","caller","callee","date_time"],"properties":{"call_id":{"type":"string","description":"The call's unique ID."},"callee":{"type":"object","description":"Information about the person called by the caller.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the callee."},"extension_type":{"type":"string","description":"Extension type of the callee.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"user_id":{"type":"string","description":"The callee's Zoom user ID."},"phone_number":{"type":"string","description":"The callee's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"account_code":{"type":"string","description":"The callee's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The callee's extension number."},"timezone":{"type":"string","description":"The callee's timezone."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"caller":{"type":"object","description":"Information about the person who initiated the call.","required":["phone_number"],"properties":{"extension_id":{"type":"string","description":"Extension ID of the caller."},"extension_type":{"type":"string","description":"Extension type of the caller.","enum":["user","callQueue","autoReceptionist","commonArea","commonAreaPhone","sharedLineGroup","zoomRoom","ciscoRoom/PolycomRoom","contactCenter","pstn","five9","twilio"]},"phone_number":{"type":"string","description":"The caller's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164)."},"user_id":{"type":"string","description":"The caller's Zoom user ID."},"account_code":{"type":"string","description":"The caller's account code. To dial between accounts, use the format: [Account code] - [extension number]."},"extension_number":{"type":"integer","format":"int64","description":"The caller's extension number."},"timezone":{"type":"string","description":"The caller's timezone."},"device_id":{"type":"string","description":"The device ID."},"connection_type":{"type":"string","description":"The connection type.","enum":["pstn_off_net","voip","pstn_on_net","contact_center","byop"]}}},"date_time":{"type":"string","description":"The time and date (GMT) at which the caller muted a call in yyyy-MM-dd'T'HH:mm:ss'Z' format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n  \"event\" : \"phone.caller_mute\",\n  \"event_ts\" : 1626759486127,\n  \"payload\" : {\n    \"account_id\" : \"2TP-coFVSnmyvYZogk8gAg\",\n    \"object\" : {\n      \"callee\" : {\n        \"extension_type\": \"user\",\n        \"extension_number\" : 810003,\n        \"phone_number\" : \"810003\",\n        \"connection_type\": \"voip\"\n      },\n      \"caller\" : {\n        \"extension_id\": \"52OdSKGSSS-EOyJwQncFvA\",\n        \"extension_type\": \"user\",\n        \"user_id\" : \"kRQpbWO5TV6E7wxEYOKFWw\",\n        \"timezone\" : \"Asia/Shanghai\",\n        \"extension_number\" : 810005,\n        \"phone_number\" : \"810005\",\n        \"device_id\": \"f7aLLSmqRpiWP0U3U6CaNA\",\n        \"connection_type\": \"voip\"\n      },\n      \"date_time\" : \"2021-07-20T05:38:04Z\",\n      \"call_id\" : \"6986878782238080581\"\n    }\n  }\n}"}}}}}}}}}}