{"openapi":"3.1.0","info":{"title":"Contact Center","description":"The Zoom Contact Center webhooks allow developers to receive events for [Contact Center](https://developers.zoom.us/docs/contact-center/) features.","version":"1.0.0"},"webhooks":{"contact_center.task_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_created","requestBody":{"description":"# contact_center.task_created\n\nThe **Task created** event is triggered when a task is created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Task created** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_created/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 0,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_created/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 0,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_follow_up_task_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_follow_up_task_updated","requestBody":{"description":"# contact_center.engagement_follow_up_task_updated\n\nThe **Engagement follow-up task updated** event is triggered when a follow-up task is updated in an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement follow-up task updated** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_follow_up_task_updated`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated follow-up task.","required":["task_id","engagement_id","user_id","content","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The follow-up task ID."},"engagement_id":{"type":"string","description":"The engagement ID."},"user_id":{"type":"string","description":"The ID of the user who updated the task."},"content":{"type":"string","description":"The follow-up task content after the update."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the follow-up task was updated, in millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_follow_up_task_updated\",\n \"event_ts\": 1700001000456,\n \"payload\": {\n \"account_id\": \"A1B2C3D4E5F6G7H8I9J0\",\n \"object\": {\n \"task_id\": \"T1234567890\",\n \"engagement_id\": \"E9876543210\",\n \"user_id\": \"U1234567890\",\n \"content\": \"Updated follow-up task content after speaking with the customer.\",\n \"date_time_ms\": \"2026-03-24T17:05:12.456Z\"\n }\n }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event name."},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated follow-up task.","required":["task_id","engagement_id","user_id","content","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The follow-up task ID."},"engagement_id":{"type":"string","description":"The engagement ID."},"user_id":{"type":"string","description":"The ID of the user who updated the task."},"content":{"type":"string","description":"The follow-up task content after the update."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the follow-up task was updated, in millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_follow_up_task_updated\",\n \"event_ts\": 1700001000456,\n \"payload\": {\n \"account_id\": \"A1B2C3D4E5F6G7H8I9J0\",\n \"object\": {\n \"task_id\": \"T1234567890\",\n \"engagement_id\": \"E9876543210\",\n \"user_id\": \"U1234567890\",\n \"content\": \"Updated follow-up task content after speaking with the customer.\",\n \"date_time_ms\": \"2026-03-24T17:05:12.456Z\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_downloaded":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_downloaded","requestBody":{"description":"# contact_center.inbox_message_downloaded\nThe **Inbox message downloaded** event is triggered when a message is downloaded.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message downloaded** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_downloaded`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the downloaded inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","download_type","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_downloaded/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"download_type":{"type":"string","description":"The message's download type.","enum":["Recording","Transcript"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message is downloaded, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_downloaded\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"download_type\": \"Recording\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the downloaded inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","download_type","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_downloaded/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"download_type":{"type":"string","description":"The message's download type.","enum":["Recording","Transcript"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message is downloaded, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_downloaded\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"download_type\": \"Recording\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_follow_up_task_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_follow_up_task_created","requestBody":{"description":"# contact_center.engagement_follow_up_task_created\n\nThe **Engagement follow-up task created** event is triggered when a follow-up task is created in an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement follow-up task created** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_follow_up_task_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created follow-up task.","required":["task_id","engagement_id","user_id","content","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The follow-up task ID."},"engagement_id":{"type":"string","description":"The engagement ID."},"user_id":{"type":"string","description":"The ID of the user who created the task."},"content":{"type":"string","description":"The follow-up task content."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the follow-up task was created, in milliseconds."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_follow_up_task_created\",\n \"event_ts\": 1700000000123,\n \"payload\": {\n \"account_id\": \"A1B2C3D4E5F6G7H8I9J0\",\n \"object\": {\n \"task_id\": \"T1234567890\",\n \"engagement_id\": \"E9876543210\",\n \"user_id\": \"U1234567890\",\n \"content\": \"Follow up with the customer regarding their support request.\",\n \"date_time_ms\": \"2026-03-24T16:30:45.123Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created follow-up task.","required":["task_id","engagement_id","user_id","content","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The follow-up task ID."},"engagement_id":{"type":"string","description":"The engagement ID."},"user_id":{"type":"string","description":"The ID of the user who created the task."},"content":{"type":"string","description":"The follow-up task content."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the follow-up task was created, in milliseconds."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_follow_up_task_created\",\n \"event_ts\": 1700000000123,\n \"payload\": {\n \"account_id\": \"A1B2C3D4E5F6G7H8I9J0\",\n \"object\": {\n \"task_id\": \"T1234567890\",\n \"engagement_id\": \"E9876543210\",\n \"user_id\": \"U1234567890\",\n \"content\": \"Follow up with the customer regarding their support request.\",\n \"date_time_ms\": \"2026-03-24T16:30:45.123Z\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_reopened":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_reopened","requestBody":{"description":"# contact_center.inbox_message_reopened\nThe **Inbox message reopened** event is triggered when a resolved message is reopened.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message reopened** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_reopened`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the reopened inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_reopened/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was reopened, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_reopened\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the reopened inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_reopened/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was reopened, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_reopened\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.consumer_messaging_opt_out":{"post":{"tags":["contact_center"],"operationId":"contact_center.consumer_messaging_opt_out","requestBody":{"description":"# contact_center.consumer_messaging_opt_out\nThe **Consumer messaging opt out** event is triggered when a consumer opts out of receiving messages from a Zoom Contact Center messaging channel.\n\nFor SMS, this event is triggered when the consumer sends a STOP keyword or a campaign-configured opt-out keyword in an SMS message.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n- A valid **Event Notification Endpoint URL**.\n- The **Consumer messaging opt out** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_messaging:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:messaging:admin`\n\n**Event type**: `contact_center.consumer_messaging_opt_out`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the consumer opt-out event.","required":["date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement ID associated with the opt-out."},"sms":{"type":"object","description":"The SMS opt-out details.","properties":{"consumer_number":{"type":"string","description":"The consumer's phone number in E.164 format."},"contact_center_number":{"type":"string","description":"The Contact Center phone number in E.164 format."},"campaign_id":{"type":"string","description":"The 10DLC campaign ID. Returned only when the campaign is configured to apply opt-in and opt-out preferences to all phone numbers associated with the campaign."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The time of the opt-out event, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.consumer_messaging_opt_out\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"sms\": {\n \"consumer_number\": \"+12090001111\",\n \"contact_center_number\": \"+12090000000\",\n \"campaign_id\": \"C1TGZWS\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the consumer opt-out event.","required":["date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement ID associated with the opt-out."},"sms":{"type":"object","description":"The SMS opt-out details.","properties":{"consumer_number":{"type":"string","description":"The consumer's phone number in E.164 format."},"contact_center_number":{"type":"string","description":"The Contact Center phone number in E.164 format."},"campaign_id":{"type":"string","description":"The 10DLC campaign ID. Returned only when the campaign is configured to apply opt-in and opt-out preferences to all phone numbers associated with the campaign."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The time of the opt-out event, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.consumer_messaging_opt_out\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"sms\": {\n \"consumer_number\": \"+12090001111\",\n \"contact_center_number\": \"+12090000000\",\n \"campaign_id\": \"C1TGZWS\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\n}"}}}}}}}},"contact_center.call_control_conference_warm_invite_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_conference_warm_invite_executed","requestBody":{"description":"# contact_center.call_control_conference_warm_invite_executed\nThe **Call Control Conference Warm Invite executed** event is triggered when starting a conference warm invitation by using [Command control of a user](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call Control Conference Warm Invite executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_conference_warm_invite_executed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event.","example":"contact_center.call_control_conference_warm_invite_executed"},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred.","example":1767076587049},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account.","example":"zPd1zOyTRlSAQh70ltxTIw"},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms","conference_id"],"description":"Information about the executed call control conference warm invite.","properties":{"request_id":{"type":"string","description":"The ID of the app request.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The ID of the engagement.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The ID of the user.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when starting a conference warm invitation by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"},"conference_id":{"type":"string","description":"The ID of the conference.","example":"b765b61c-7dc8-4c95-b0b9-f2468b7187d1"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_conference_warm_invite_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\",\n \"conference_id\": \"b765b61c-7dc8-4c95-b0b9-f2468b7187d1\"\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.","example":"contact_center.call_control_conference_warm_invite_executed"},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred.","example":1767076587049},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The ID of the account.","example":"zPd1zOyTRlSAQh70ltxTIw"},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms","conference_id"],"description":"Information about the executed call control conference warm invite.","properties":{"request_id":{"type":"string","description":"The ID of the app request.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The ID of the engagement.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The ID of the user.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when starting a conference warm invitation by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"},"conference_id":{"type":"string","description":"The ID of the conference.","example":"b765b61c-7dc8-4c95-b0b9-f2468b7187d1"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_conference_warm_invite_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\",\n \"conference_id\": \"b765b61c-7dc8-4c95-b0b9-f2468b7187d1\"\n }\n }\n}"}}}}}}}},"contact_center.queue_supervisor_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_supervisor_assigned","requestBody":{"description":"# contact_center.queue_supervisor_assigned\n\nThe **Queue supervisor assigned** event is triggered when a supervisor is assigned to the queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**\n* The **Queue supervisor assigned** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_supervisor_assigned:admin`\n\n**Event type**: `contact_center.queue_supervisor_assigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the assigned queue supervisor.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_supervisor_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the supervisor was assigned to the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the supervisor was assigned to the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_supervisor_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the assigned queue supervisor.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_supervisor_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the supervisor was assigned to the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the supervisor was assigned to the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_supervisor_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_monitor_started":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_monitor_started","requestBody":{"description":"# contact_center.engagement_monitor_started\n\nThe **Monitoring started on an engagement** event is triggered when the user starts monitoring for an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**.\n * The **Monitoring started on an engagement** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_monitor_started`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement monitor.","required":["engagement_id","engagement_direction","channel","action_type","user_id","user_display_name","monitoring_user_id","monitoring_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"action_type":{"type":"string","description":"The monitor's action type. \n* barge - Voice channel support. \n* listen - Voice channel support. \n* whisper - Voice channel support.","enum":["barge","listen","whisper"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_monitor_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"monitoring_user_id":{"type":"string","description":"The monitoring user's ID."},"monitoring_user_display_name":{"type":"string","description":"The monitoring user's display name."},"contact_center_number":{"type":"string","description":"The user's Contact Center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor starting time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor starting time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_monitor_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"action_type\": \"barge\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"monitoring_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxd\",\n \"monitoring_user_display_name\": \"Jane Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement monitor.","required":["engagement_id","engagement_direction","channel","action_type","user_id","user_display_name","monitoring_user_id","monitoring_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"action_type":{"type":"string","description":"The monitor's action type. \n* barge - Voice channel support. \n* listen - Voice channel support. \n* whisper - Voice channel support.","enum":["barge","listen","whisper"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_monitor_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"monitoring_user_id":{"type":"string","description":"The monitoring user's ID."},"monitoring_user_display_name":{"type":"string","description":"The monitoring user's display name."},"contact_center_number":{"type":"string","description":"The user's Contact Center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor starting time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor starting time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_monitor_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"action_type\": \"barge\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"monitoring_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxd\",\n \"monitoring_user_display_name\": \"Jane Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_monitor_ended":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_monitor_ended","requestBody":{"description":"# contact_center.engagement_monitor_ended\n\nThe **Monitoring ended on an engagement** event is triggered when the user ends monitoring on an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Monitoring ended on an engagement** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_monitor_ended`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the ended engagement monitor.","required":["engagement_id","engagement_direction","channel","action_type","user_id","user_display_name","monitoring_user_id","monitoring_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"action_type":{"type":"string","description":"The monitor's action type. \n* barge - Voice channel support. \n* listen - Voice channel support. \n* whisper - Voice channel support.","enum":["barge","listen","whisper"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_monitor_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"monitoring_user_id":{"type":"string","description":"The monitoring user's ID."},"monitoring_user_display_name":{"type":"string","description":"The monitoring user's display name."},"contact_center_number":{"type":"string","description":"The user's contact center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor end time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_monitor_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"action_type\": \"barge\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"monitoring_user_id\": \"XVTRVt3gQ2i-WjoUIjeZxk\",\n \"monitoring_user_display_name\": \"Jane Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the ended engagement monitor.","required":["engagement_id","engagement_direction","channel","action_type","user_id","user_display_name","monitoring_user_id","monitoring_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"action_type":{"type":"string","description":"The monitor's action type. \n* barge - Voice channel support. \n* listen - Voice channel support. \n* whisper - Voice channel support.","enum":["barge","listen","whisper"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_monitor_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"monitoring_user_id":{"type":"string","description":"The monitoring user's ID."},"monitoring_user_display_name":{"type":"string","description":"The monitoring user's display name."},"contact_center_number":{"type":"string","description":"The user's contact center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor end time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_monitor_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"action_type\": \"barge\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"monitoring_user_id\": \"XVTRVt3gQ2i-WjoUIjeZxk\",\n \"monitoring_user_display_name\": \"Jane Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_note_added":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_note_added","requestBody":{"description":"# contact_center.engagement_note_added\n\nThe **Engagement note added** event is triggered when a user adds a note to an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement note added** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_note_added`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the added engagement note.","required":["note_id","note","last_modified_time","channel","engagement_id","engagement_direction","user_id","user_display_name","date_time_ms"],"properties":{"note_id":{"type":"string","description":"The note's unique ID."},"note":{"type":"string","description":"The note's content."},"last_modified_time":{"description":"The date and time when the note was last modified in the admin portal.","format":"date-time","type":"string"},"channel_type":{"type":"string","description":"The task's channel type. \n* default \n* voice \n* sms \n* chat \n* phone","enum":["default","voice","sms","chat","phone"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"queue_id":{"type":"string","description":"The engagement's queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement's queue's name."},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"channel_id":{"type":"string","description":"The channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The channel type. \n* voice \n* sms \n* chat \n* video \n* in_app_chat","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_note_added/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the note was added, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the note was added, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_note_added\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"note_id\": \"W_VATTk_Q5aW6z5rZtBxAQ\",\n \"note\": \"This is the example note content.\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"last_modified_time\": \"2022-05-23T14:15:57Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2022-10-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the added engagement note.","required":["note_id","note","last_modified_time","channel","engagement_id","engagement_direction","user_id","user_display_name","date_time_ms"],"properties":{"note_id":{"type":"string","description":"The note's unique ID."},"note":{"type":"string","description":"The note's content."},"last_modified_time":{"description":"The date and time when the note was last modified in the admin portal.","format":"date-time","type":"string"},"channel_type":{"type":"string","description":"The task's channel type. \n* default \n* voice \n* sms \n* chat \n* phone","enum":["default","voice","sms","chat","phone"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"queue_id":{"type":"string","description":"The engagement's queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement's queue's name."},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"channel_id":{"type":"string","description":"The channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The channel type. \n* voice \n* sms \n* chat \n* video \n* in_app_chat","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_note_added/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the note was added, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the note was added, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_note_added\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"note_id\": \"W_VATTk_Q5aW6z5rZtBxAQ\",\n \"note\": \"This is the example note content.\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"last_modified_time\": \"2022-05-23T14:15:57Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2022-10-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.outbound_campaign_dialer_status":{"post":{"tags":["contact_center"],"operationId":"contact_center.outbound_campaign_dialer_status","requestBody":{"description":"# contact_center.outbound_campaign_dialer_status\n\nThe **Outbound campaign dialer status** event is triggered when an outbound campaign dialer is executed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Outbound campaign dialer status** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_outbound_campaign:read:admin`\n\n**Event type**: `contact_center.outbound_campaign_dialer_status`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the outbound campaign dialer status.","required":["engagement_id","campaign_dialer_status","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"external_engagement_id":{"type":"string","description":"External engagement's ID."},"campaign_dialer_status":{"type":"string","description":"The call result.","enum":["consumer_answer","consumer_no_answer","consumer_reject","agent_abandoned","number_invalid","number_blocked","other_errors","consumer_busy"]},"date_time":{"type":"string","format":"date-time","description":"The campaign dialer execution time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The campaign dialer execution time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.outbound_campaign_dialer_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"external_engagement_id\": \"ozyn5uh9Qgu10uYAqcXq4g\",\n \"campaign_dialer_status\": \"consumer_answer\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the outbound campaign dialer status.","required":["engagement_id","campaign_dialer_status","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"external_engagement_id":{"type":"string","description":"External engagement's ID."},"campaign_dialer_status":{"type":"string","description":"The call result.","enum":["consumer_answer","consumer_no_answer","consumer_reject","agent_abandoned","number_invalid","number_blocked","other_errors","consumer_busy"]},"date_time":{"type":"string","format":"date-time","description":"The campaign dialer execution time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The campaign dialer execution time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.outbound_campaign_dialer_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"external_engagement_id\": \"ozyn5uh9Qgu10uYAqcXq4g\",\n \"campaign_dialer_status\": \"consumer_answer\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.call_control_make_call_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_make_call_executed","requestBody":{"description":"# contact_center.call_control_make_call_executed\nThe **Call control make call executed** event is triggered when an engagement is created by using [Command control of a User](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call control make call executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_make_call_executed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control make call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when an engagement was created by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_make_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control make call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when an engagement was created by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_make_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_opt_out":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_opt_out","requestBody":{"description":"# contact_center.user_opt_out\n\nThe **User opt out** event is triggered when a user opts out of a queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **User opt out** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_opt_out`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user queue opt-out.","required":["user_id","display_name","cc_queue_id","queue_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The queue's name."},"teams":{"$ref":"#/paths/contact_center.user_opt_out/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user opted out of a queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user opted out of a queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_opt_out\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user queue opt-out.","required":["user_id","display_name","cc_queue_id","queue_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The queue's name."},"teams":{"$ref":"#/paths/contact_center.user_opt_out/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user opted out of a queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user opted out of a queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_opt_out\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_resolved":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_resolved","requestBody":{"description":"# contact_center.inbox_message_resolved\nThe **Inbox message resolved** event is triggered when an agent or supervisor resolves a voicemail.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message resolved** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_resolved`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the resolved inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_resolved/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was resolved, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_resolved\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the resolved inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_resolved/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was resolved, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_resolved\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_invited":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_invited","requestBody":{"description":"# contact_center.engagement_conference_participant_invited\nThe **Engagement conference participant invited** event is triggered when a participant is invited to an engagement conference.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference participant invited** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_invited`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant's engagement conference invitation.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","invited_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant was invited to the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"invited_participant":{"type":"object","description":"The participant being invited to join the engagement conference.","properties":{"participant_phone_number":{"type":"string","description":"The participant's phone number."},"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_invited\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fdsagfhjdskg\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"invited_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant's engagement conference invitation.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","invited_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant was invited to the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"invited_participant":{"type":"object","description":"The participant being invited to join the engagement conference.","properties":{"participant_phone_number":{"type":"string","description":"The participant's phone number."},"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_invited\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fdsagfhjdskg\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"invited_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_canceled":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_canceled","requestBody":{"description":"# contact_center.task_reservation_canceled\n\nThe **User canceled a task reservation** event is triggered when a user cancels a task queue reservation.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **User canceled a task reservation** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_canceled`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type. ","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. ","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type. ","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. ","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_consumer_sent_file":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_consumer_sent_file","requestBody":{"description":"# contact_center.engagement_consumer_sent_file\nThe **Engagement consumer sent file** event is triggered when the customer sends files.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement consumer sent file** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_consumer_sent_file`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement customer sent files.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","files"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_sent_file/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"files":{"description":"The file details.","type":"array","items":{"required":["file_id","file_name","file_type","file_size"],"properties":{"file_id":{"type":"string","description":"The file's unique ID."},"file_name":{"type":"string","description":"The file's name."},"file_size":{"type":"integer","format":"int64","description":"The file's size."},"file_type":{"type":"string","description":"The file's type.","enum":["Image","Audio","Video","File","Link"]},"download_url":{"type":"string","description":"Attachment download link."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_sent_file\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"files\": [\n {\n \"file_id\": \"Chh7WtzyTaa-PIvsSpfwmA\",\n \"file_name\": \"My Image\",\n \"file_size\": 1796,\n \"file_type\": \"Image\",\n \"download_url\": \"https://www.zoom.us/v2/contact_center/attachments/0AYFv9ePSsmPUSJYHorUWQ/download?type=messaging_attachment\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement customer sent files.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","files"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_sent_file/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"files":{"description":"The file details.","type":"array","items":{"required":["file_id","file_name","file_type","file_size"],"properties":{"file_id":{"type":"string","description":"The file's unique ID."},"file_name":{"type":"string","description":"The file's name."},"file_size":{"type":"integer","format":"int64","description":"The file's size."},"file_type":{"type":"string","description":"The file's type.","enum":["Image","Audio","Video","File","Link"]},"download_url":{"type":"string","description":"Attachment download link."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_sent_file\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"files\": [\n {\n \"file_id\": \"Chh7WtzyTaa-PIvsSpfwmA\",\n \"file_name\": \"My Image\",\n \"file_size\": 1796,\n \"file_type\": \"Image\",\n \"download_url\": \"https://www.zoom.us/v2/contact_center/attachments/0AYFv9ePSsmPUSJYHorUWQ/download?type=messaging_attachment\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.queue_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_created","requestBody":{"description":"# contact_center.queue_created\n\nThe **Queue created** event is triggered when a task queue is created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**.\n * The **Queue created** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin`\n\n**Event type**: `contact_center.queue_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task queue.","required":["cc_queue_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","messaging"]}},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting is enabled."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"Distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - Voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - Voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - Voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - Voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - Voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - Video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - Video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - Chat, SMS","enum":["manual","auto"]},"wrap_up_expiration":{"type":"boolean","description":"If enabled, engagements auto close at the end of the wrap-up duration."},"overflow_to_goodbye_message":{"type":"boolean","description":"If enabled, a goodbye message plays and then disconnects when the wait time is exceeded."},"overflow_to_queue_id":{"type":"string","description":"Queue ID. If the overflow type is queue, the consumer is routed to this queue when the wait time is exceeded.","deprecated":true},"overflow_to_cc_queue_id":{"type":"string","description":"Contact Center queue ID. If the overflow type is queue, the consumer is routed to this queue when the wait time is exceeded."},"overflow_to_flow_id":{"type":"string","description":"Flow ID. If the overflow type is flow, the consumer is routed to this flow when the wait time is exceeded."},"overflow_to_inbox_id":{"type":"string","description":"Inbox ID. If the overflow type is inbox, the consumer is routed to this inbox when the wait time is exceeded."},"auto_close_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent when auto closed."},"auto_close_message":{"type":"string","description":"A warning message is sent when auto close."},"auto_close_timeout":{"type":"integer","description":"Auto close message time, to the minute."},"auto_close_alert_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent before auto close."},"auto_close_alert_message":{"type":"string","description":"A warning message is sent before auto close."},"auto_close_alert_message_time":{"type":"integer","description":"Auto close alert message time, to the minute."},"recording_storage_location":{"type":"string","description":"The recording storage location."},"service_level_threshold_in_seconds":{"type":"integer","description":"If channel type is voice or video, this threshold is answer time by agents for all inbound calls. Otherwise, this threshold is first message speed by agents for all engagements."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"If enabled, short-abandoned calls are excluded from all inbound calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"If enabled, long-abandoned calls are excluded from all inbound calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"If enabled, abandon quit engagements are excluded from total inbound messaging engagements."},"service_level_target_in_percentage":{"type":"integer","description":"A target for the service level as the benchmark to refer to in reports."},"queue_created_time":{"type":"string","format":"date-time","description":"The queue creation time, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue was created, to the millisecond. Refer to queue_created_time for a more accurate time when the queue was created."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"channel_types\": [\n \"chat\"\n ],\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"wrap_up_expiration\": true,\n \"overflow_to_goodbye_message\": true,\n \"overflow_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"overflow_to_flow_id\": \"psjHGHrHQbaX8Zk7ldc81Q\",\n \"overflow_to_inbox_id\": \"cMH8RJA0QsyJBCWIFbWfBQ\",\n \"auto_close_message\": \"This chat has been auto-closed due to inactivity.\",\n \"auto_close_message_enabled\": true,\n \"auto_close_timeout\": 10,\n \"auto_close_alert_message\": \"Chat will auto-close soon if you don’t reply\",\n \"auto_close_alert_message_enabled\": true,\n \"auto_close_alert_message_time\": 10,\n \"recording_storage_location\": \"us\",\n \"service_level_threshold_in_seconds\": 10,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80,\n \"queue_created_time\": \"2022-02-15T09:27:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.988Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task queue.","required":["cc_queue_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","messaging"]}},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting is enabled."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"Distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - Voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - Voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - Voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - Voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - Voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - Video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - Video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - Chat, SMS","enum":["manual","auto"]},"wrap_up_expiration":{"type":"boolean","description":"If enabled, engagements auto close at the end of the wrap-up duration."},"overflow_to_goodbye_message":{"type":"boolean","description":"If enabled, a goodbye message plays and then disconnects when the wait time is exceeded."},"overflow_to_queue_id":{"type":"string","description":"Queue ID. If the overflow type is queue, the consumer is routed to this queue when the wait time is exceeded.","deprecated":true},"overflow_to_cc_queue_id":{"type":"string","description":"Contact Center queue ID. If the overflow type is queue, the consumer is routed to this queue when the wait time is exceeded."},"overflow_to_flow_id":{"type":"string","description":"Flow ID. If the overflow type is flow, the consumer is routed to this flow when the wait time is exceeded."},"overflow_to_inbox_id":{"type":"string","description":"Inbox ID. If the overflow type is inbox, the consumer is routed to this inbox when the wait time is exceeded."},"auto_close_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent when auto closed."},"auto_close_message":{"type":"string","description":"A warning message is sent when auto close."},"auto_close_timeout":{"type":"integer","description":"Auto close message time, to the minute."},"auto_close_alert_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent before auto close."},"auto_close_alert_message":{"type":"string","description":"A warning message is sent before auto close."},"auto_close_alert_message_time":{"type":"integer","description":"Auto close alert message time, to the minute."},"recording_storage_location":{"type":"string","description":"The recording storage location."},"service_level_threshold_in_seconds":{"type":"integer","description":"If channel type is voice or video, this threshold is answer time by agents for all inbound calls. Otherwise, this threshold is first message speed by agents for all engagements."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"If enabled, short-abandoned calls are excluded from all inbound calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"If enabled, long-abandoned calls are excluded from all inbound calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"If enabled, abandon quit engagements are excluded from total inbound messaging engagements."},"service_level_target_in_percentage":{"type":"integer","description":"A target for the service level as the benchmark to refer to in reports."},"queue_created_time":{"type":"string","format":"date-time","description":"The queue creation time, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue was created, to the millisecond. Refer to queue_created_time for a more accurate time when the queue was created."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"channel_types\": [\n \"chat\"\n ],\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"wrap_up_expiration\": true,\n \"overflow_to_goodbye_message\": true,\n \"overflow_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"overflow_to_flow_id\": \"psjHGHrHQbaX8Zk7ldc81Q\",\n \"overflow_to_inbox_id\": \"cMH8RJA0QsyJBCWIFbWfBQ\",\n \"auto_close_message\": \"This chat has been auto-closed due to inactivity.\",\n \"auto_close_message_enabled\": true,\n \"auto_close_timeout\": 10,\n \"auto_close_alert_message\": \"Chat will auto-close soon if you don’t reply\",\n \"auto_close_alert_message_enabled\": true,\n \"auto_close_alert_message_time\": 10,\n \"recording_storage_location\": \"us\",\n \"service_level_threshold_in_seconds\": 10,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80,\n \"queue_created_time\": \"2022-02-15T09:27:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.988Z\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_opened":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_opened","requestBody":{"description":"# contact_center.inbox_message_opened\nThe **Inbox message opened** event is triggered when an agent or supervisor plays the voicemail recording or views the transcript.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message opened** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_opened`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the opened inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_opened/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was opened, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_opened\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the opened inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_opened/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was opened, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_opened\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.recording_transcript_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_transcript_completed","requestBody":{"description":"# contact_center.recording_transcript_completed\n\nThe **Recording transcript completed** event is triggered when an engagement's recording transcript is completed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording transcript completed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_transcript_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed recording transcript.","required":["recording_id","engagement_id","engagement_direction","channel","users","transcript_url"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice\n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"recording_end_time":{"description":"The recording's end time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_end_time_ms":{"description":"The recording's end time, to the millisecond.","format":"date-time","type":"string"},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"recording_duration":{"type":"integer","description":"The recording's duration, to the second."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"owner_id":{"type":"string","description":"The recording's owner ID, either the queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, either the queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing Contact Center recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz"},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_transcript_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"recording_end_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"recording_duration\": 150,\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/recording/transcripts/download/ghyetrjj_sdfsdgfkdjfl111?type=voice\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed recording transcript.","required":["recording_id","engagement_id","engagement_direction","channel","users","transcript_url"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice\n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"recording_end_time":{"description":"The recording's end time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_end_time_ms":{"description":"The recording's end time, to the millisecond.","format":"date-time","type":"string"},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"recording_duration":{"type":"integer","description":"The recording's duration, to the second."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"owner_id":{"type":"string","description":"The recording's owner ID, either the queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, either the queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing Contact Center recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz"},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_transcript_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"recording_end_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"recording_duration\": 150,\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/recording/transcripts/download/ghyetrjj_sdfsdgfkdjfl111?type=voice\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.business_hours_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.business_hours_created","requestBody":{"description":"# contact_center.business_hours_created\n\nThe **Business hours created** event is triggered when the business hours are created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Business hours created** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hour:admin`\n\n**Event type**: `contact_center.business_hours_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created business hours.","required":["business_hour_id","business_hour_name","timezone","account_default","modified_by","hours","date_time_ms"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are created, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are created, to the millisecond."},"business_hour_name":{"type":"string","description":"The business hours' name."},"business_hour_description":{"type":"string","description":"The business hours' description."},"timezone":{"type":"string","description":"The business hours' timezone ID."},"account_default":{"type":"boolean","description":"Default business hours for the newly created queue."},"hours":{"type":"object","description":"Information about the hours.","properties":{"hour_type":{"description":"The type of business hours. \n* 1 - 24 hours, 7 days a week. \n* 2 - Custom hours.","enum":[1,2],"type":"integer"},"custom_hours":{"description":"The custom hours' settings. Returned only for the Custom hours type.","items":{"properties":{"day_of_week":{"description":"The day of the week. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","enum":[1,2,3,4,5,6,7],"type":"integer"},"custom_hour_type":{"description":"The type of custom hours. \n* 0 - Disabled. \n* 1 - 24 hours. \n* 2 - Customized hours.","enum":[0,1,2],"type":"integer"},"custom_hour_ranges":{"description":"The custom hours' range. Returned only for the Customized hours type.","items":{"properties":{"start_time":{"description":"The custom hours' start time, in HH:mm and 24-hour clock format.","type":"string"},"end_time":{"description":"The custom hours' end time, in HH:mm and 24-hour clock format.","type":"string"}}},"type":"array"}},"type":"object"},"type":"array"}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"business_hour_name\": \"My Business Hours\",\n \"business_hour_description\": \"This is an example business hours\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"hours\": {\n \"hour_type\": 1,\n \"custom_hours\": [\n {\n \"day_of_week\": 1,\n \"custom_hour_type\": 1,\n \"custom_hour_ranges\": [\n {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\"\n }\n ]\n }\n ]\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created business hours.","required":["business_hour_id","business_hour_name","timezone","account_default","modified_by","hours","date_time_ms"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are created, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are created, to the millisecond."},"business_hour_name":{"type":"string","description":"The business hours' name."},"business_hour_description":{"type":"string","description":"The business hours' description."},"timezone":{"type":"string","description":"The business hours' timezone ID."},"account_default":{"type":"boolean","description":"Default business hours for the newly created queue."},"hours":{"type":"object","description":"Information about the hours.","properties":{"hour_type":{"description":"The type of business hours. \n* 1 - 24 hours, 7 days a week. \n* 2 - Custom hours.","enum":[1,2],"type":"integer"},"custom_hours":{"description":"The custom hours' settings. Returned only for the Custom hours type.","items":{"properties":{"day_of_week":{"description":"The day of the week. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","enum":[1,2,3,4,5,6,7],"type":"integer"},"custom_hour_type":{"description":"The type of custom hours. \n* 0 - Disabled. \n* 1 - 24 hours. \n* 2 - Customized hours.","enum":[0,1,2],"type":"integer"},"custom_hour_ranges":{"description":"The custom hours' range. Returned only for the Customized hours type.","items":{"properties":{"start_time":{"description":"The custom hours' start time, in HH:mm and 24-hour clock format.","type":"string"},"end_time":{"description":"The custom hours' end time, in HH:mm and 24-hour clock format.","type":"string"}}},"type":"array"}},"type":"object"},"type":"array"}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"business_hour_name\": \"My Business Hours\",\n \"business_hour_description\": \"This is an example business hours\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"hours\": {\n \"hour_type\": 1,\n \"custom_hours\": [\n {\n \"day_of_week\": 1,\n \"custom_hour_type\": 1,\n \"custom_hour_ranges\": [\n {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\"\n }\n ]\n }\n ]\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_canceled":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_canceled","requestBody":{"description":"# contact_center.engagement_conference_participant_canceled\nThe **Engagement conference participant canceled** event is triggered when a participant's conference invitation is canceled.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference participant canceled** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_canceled`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement conference participant.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","canceled_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a participant's conference invitation is canceled, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"canceled_participant":{"type":"object","description":"The participant whose conference invitation is canceled.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+1479235161723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+1479213567632\"\n }\n ],\n \"canceled_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement conference participant.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","canceled_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a participant's conference invitation is canceled, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"canceled_participant":{"type":"object","description":"The participant whose conference invitation is canceled.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+1479235161723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+1479213567632\"\n }\n ],\n \"canceled_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.recording_paused":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_paused","requestBody":{"description":"# contact_center.recording_paused\n\nThe **Recording paused** event is triggered when an engagement's recording is paused.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording paused** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_paused`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's paused recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's pause time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's pause time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as the queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as the queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_paused/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_paused\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's paused recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's pause time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's pause time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as the queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as the queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_paused/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_paused\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.queue_supervisor_unassigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_supervisor_unassigned","requestBody":{"description":"# contact_center.queue_supervisor_unassigned\n\nThe **Queue supervisor unassigned** event is triggered when a supervisor is removed from the queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**\n * The **Queue supervisor unassigned** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_supervisor_unassigned:admin`\n\n**Event type**: `contact_center.queue_supervisor_unassigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the unassigned queue supervisor.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_supervisor_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the supervisor was removed from the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the supervisor was removed from the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_supervisor_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the unassigned queue supervisor.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_supervisor_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the supervisor was removed from the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the supervisor was removed from the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_supervisor_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_updated","requestBody":{"description":"# contact_center.user_updated\n\nThe **User updated** event is triggered when a user is updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User updated** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_updated:admin`\n\n**Event type**: `contact_center.user_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated user.","required":["user_id","updates","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"teams":{"$ref":"#/paths/contact_center.user_updated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated user.","properties":{"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"status_id":{"type":"string","description":"The user's status ID."},"status_name":{"type":"string","description":"The user's status name.","enum":["Offline","Ready","Not Ready","Occupied"]},"sub_status_id":{"type":"string","description":"The user's reason ID when the user status is Not Ready"},"sub_status_name":{"type":"string","description":"The user's reason when the user status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](https://developers.zoom.us/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status_category."},"client_integration":{"type":"string","description":"The Contact Center's client integration.","enum":["Default","Salesforce","Zendesk","ServiceNow","Microsoft_Dynamics_365"]},"user_access":{"type":"string","description":"The user's access status. \n* active - The user's role permissions allow them to access the Contact Center. \n* inactive - The user cannot access the Contact Center.","enum":["active","inactive"]},"country_iso_code":{"type":"string","description":"The [ISO country code](/docs/api/references/abbreviations/#countries)."},"channel_settings":{"type":"object","description":"Information about the channel settings.","properties":{"multi_channel_engagements":{"type":"object","description":"Information about the setting's multi-channel engagements.","properties":{"enable":{"type":"boolean","description":"Whether to allow users to receive voice or video engagements while handling chat and SMS engagements based on the max_agent_load value."},"max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this shows the maximum load percentage an user needs to undertake in order to receive voice and video calls. This value is based on the engagements the user is currently handling."},"email_max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this is the maximum load percentage that a user needs to take in order to receive voice and video calls. This value is based on the engagements the user is currently handling."}}},"concurrent_message_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent messaging conversations that can be assigned to a user."},"concurrent_email_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent email conversations that can be assigned to a user."},"messaging_occupied":{"type":"boolean","description":"Mark the user's status as “Occupied” if they lack capacity for an additional active messaging engagement."},"email_occupied":{"type":"boolean","description":"Mark the user's status as “Occupied” if they lack capacity for an additional active email engagement."}}},"emergency_calling":{"type":"boolean","description":"Allow users to contact emergency services through their device's native phone system or Zoom Phone."},"external_url":{"type":"object","description":"Launch a URL for incoming calls.","properties":{"enable":{"type":"boolean","description":"If set to true, Enable Launch will be activated."},"external_launch_url":{"type":"string","description":"Enable Launch."}}},"user_intents":{"type":"array","description":"The user's intents.","items":{"type":"object","properties":{"intent_group_id":{"type":"string","description":"The intent's group ID.","example":"Ql3qxUWXSHes4PmcOmzyOg"},"intent_id":{"type":"string","description":"The intent's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"user_package":{"type":"object","description":"The user's Contact Center plan.","properties":{"package_name":{"type":"string","description":"The Contact Center plan's name.","enum":["essentials","premium","elite"]}}},"user_add_ons_plans":{"type":"array","description":"The user's Contact Center add-ons plan.","items":{"type":"object","properties":{"add_ons_plan_name":{"type":"string","description":"The Contact Center add-ons plan's name.","enum":["ai_expert_assist","zoom_contact_center_for_service_cloud_voice"]}}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_updated\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"updates\": {\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"status_id\": \"2\",\n \"status_name\": \"Not Ready\",\n \"sub_status_id\": \"109\",\n \"sub_status_name\": \"Whispering\",\n \"client_integration\": \"Salesforce\",\n \"user_access\": \"active\",\n \"country_iso_code\": \"US\",\n \"channel_settings\": {\n \"multi_channel_engagements\": {\n \"enable\": true,\n \"max_agent_load\": 50,\n \"email_max_agent_load\": 50\n },\n \"concurrent_message_capacity\": 4,\n \"concurrent_email_capacity\": 20,\n \"messaging_occupied\": true,\n \"email_occupied\": true\n },\n \"emergency_calling\": true,\n \"user_intents\": [\n {\n \"intent_id\": \"OlK7lczzT_e7h6p1Q6wGdg\",\n \"intent_group_id\": \"Ql3qxUWXSHes4PmcOmzyOg\"\n }\n ],\n \"user_package\": {\n \"package_name\": \"essentials\"\n },\n \"user_add_ons_plans\": [\n {\n \"add_ons_plan_name\": \"ai_expert_assist\"\n }\n ],\n \"external_url\": {\n \"enable\": true,\n \"external_launch_url\": \"https://zoom.us\"\n }\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated user.","required":["user_id","updates","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"teams":{"$ref":"#/paths/contact_center.user_updated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated user.","properties":{"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"status_id":{"type":"string","description":"The user's status ID."},"status_name":{"type":"string","description":"The user's status name.","enum":["Offline","Ready","Not Ready","Occupied"]},"sub_status_id":{"type":"string","description":"The user's reason ID when the user status is Not Ready"},"sub_status_name":{"type":"string","description":"The user's reason when the user status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](https://developers.zoom.us/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status_category."},"client_integration":{"type":"string","description":"The Contact Center's client integration.","enum":["Default","Salesforce","Zendesk","ServiceNow","Microsoft_Dynamics_365"]},"user_access":{"type":"string","description":"The user's access status. \n* active - The user's role permissions allow them to access the Contact Center. \n* inactive - The user cannot access the Contact Center.","enum":["active","inactive"]},"country_iso_code":{"type":"string","description":"The [ISO country code](/docs/api/references/abbreviations/#countries)."},"channel_settings":{"type":"object","description":"Information about the channel settings.","properties":{"multi_channel_engagements":{"type":"object","description":"Information about the setting's multi-channel engagements.","properties":{"enable":{"type":"boolean","description":"Whether to allow users to receive voice or video engagements while handling chat and SMS engagements based on the max_agent_load value."},"max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this shows the maximum load percentage an user needs to undertake in order to receive voice and video calls. This value is based on the engagements the user is currently handling."},"email_max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this is the maximum load percentage that a user needs to take in order to receive voice and video calls. This value is based on the engagements the user is currently handling."}}},"concurrent_message_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent messaging conversations that can be assigned to a user."},"concurrent_email_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent email conversations that can be assigned to a user."},"messaging_occupied":{"type":"boolean","description":"Mark the user's status as “Occupied” if they lack capacity for an additional active messaging engagement."},"email_occupied":{"type":"boolean","description":"Mark the user's status as “Occupied” if they lack capacity for an additional active email engagement."}}},"emergency_calling":{"type":"boolean","description":"Allow users to contact emergency services through their device's native phone system or Zoom Phone."},"external_url":{"type":"object","description":"Launch a URL for incoming calls.","properties":{"enable":{"type":"boolean","description":"If set to true, Enable Launch will be activated."},"external_launch_url":{"type":"string","description":"Enable Launch."}}},"user_intents":{"type":"array","description":"The user's intents.","items":{"type":"object","properties":{"intent_group_id":{"type":"string","description":"The intent's group ID.","example":"Ql3qxUWXSHes4PmcOmzyOg"},"intent_id":{"type":"string","description":"The intent's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"user_package":{"type":"object","description":"The user's Contact Center plan.","properties":{"package_name":{"type":"string","description":"The Contact Center plan's name.","enum":["essentials","premium","elite"]}}},"user_add_ons_plans":{"type":"array","description":"The user's Contact Center add-ons plan.","items":{"type":"object","properties":{"add_ons_plan_name":{"type":"string","description":"The Contact Center add-ons plan's name.","enum":["ai_expert_assist","zoom_contact_center_for_service_cloud_voice"]}}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_updated\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"updates\": {\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"status_id\": \"2\",\n \"status_name\": \"Not Ready\",\n \"sub_status_id\": \"109\",\n \"sub_status_name\": \"Whispering\",\n \"client_integration\": \"Salesforce\",\n \"user_access\": \"active\",\n \"country_iso_code\": \"US\",\n \"channel_settings\": {\n \"multi_channel_engagements\": {\n \"enable\": true,\n \"max_agent_load\": 50,\n \"email_max_agent_load\": 50\n },\n \"concurrent_message_capacity\": 4,\n \"concurrent_email_capacity\": 20,\n \"messaging_occupied\": true,\n \"email_occupied\": true\n },\n \"emergency_calling\": true,\n \"user_intents\": [\n {\n \"intent_id\": \"OlK7lczzT_e7h6p1Q6wGdg\",\n \"intent_group_id\": \"Ql3qxUWXSHes4PmcOmzyOg\"\n }\n ],\n \"user_package\": {\n \"package_name\": \"essentials\"\n },\n \"user_add_ons_plans\": [\n {\n \"add_ons_plan_name\": \"ai_expert_assist\"\n }\n ],\n \"external_url\": {\n \"enable\": true,\n \"external_launch_url\": \"https://zoom.us\"\n }\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_rejected":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_rejected","requestBody":{"description":"# contact_center.engagement_conference_participant_rejected\nThe **Engagement conference participant rejected** event is triggered when a participant rejects an invitation to join the engagement conference.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference participant rejected** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_rejected`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant's rejected engagement conference participant.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","rejecting_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant rejected the invitation to join the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"rejecting_participant":{"type":"object","description":"The participant who rejected the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"rejecting_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant's rejected engagement conference participant.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","rejecting_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant rejected the invitation to join the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"rejecting_participant":{"type":"object","description":"The participant who rejected the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"rejecting_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_muted":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_muted","requestBody":{"description":"# contact_center.engagement_user_muted\n\nThe **Engagement user muted** event is triggered when a user goes on mute or is muted in an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement user muted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_muted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user muted in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_muted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's muted time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's muted time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_muted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user muted in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_muted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's muted time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's muted time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_muted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_unmuted":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_unmuted","requestBody":{"description":"# contact_center.engagement_user_unmuted\n\nThe **Engagement user unmuted** event is triggered when a user comes off of mute in an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement user unmuted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_unmuted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user that unmuted in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_unmuted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's unmuted time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's unmuted time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_unmuted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user that unmuted in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_unmuted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's unmuted time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's unmuted time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_unmuted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.user_phone_numbers_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_phone_numbers_assigned","requestBody":{"description":"# contact_center.user_phone_numbers_assigned\n\nThe **User phone numbers assigned** event is triggered when phone numbers are assigned to a user.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User phone numbers assigned** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_phone_numbers_assigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user's assigned phone numbers.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms","phone_numbers"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_phone_numbers_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"phone_numbers":{"type":"array","description":"The phone numbers assigned to the user.","items":{"type":"object","required":["phone_number","phone_number_id"],"properties":{"phone_number":{"type":"string","description":"The phone number in E164 format.","example":"+18005551212"},"phone_number_id":{"type":"string","description":"The phone number's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user phone numbers were assigned to the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_phone_numbers_assigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"+18005551212\",\n \"phone_number_id\": \"OlK7lczzT_e7h6p1Q6wGdg\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user's assigned phone numbers.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms","phone_numbers"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_phone_numbers_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"phone_numbers":{"type":"array","description":"The phone numbers assigned to the user.","items":{"type":"object","required":["phone_number","phone_number_id"],"properties":{"phone_number":{"type":"string","description":"The phone number in E164 format.","example":"+18005551212"},"phone_number_id":{"type":"string","description":"The phone number's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user phone numbers were assigned to the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_phone_numbers_assigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"+18005551212\",\n \"phone_number_id\": \"OlK7lczzT_e7h6p1Q6wGdg\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_wrap_up_started":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_wrap_up_started","requestBody":{"description":"# contact_center.engagement_wrap_up_started\n\nThe **Engagement wrap up started** event is triggered when a wrap up starts for an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification endpoint URL**.\n* The **Engagement wrap up started** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_wrap_up_started`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement wrap up.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_wrap_up_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up started, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up started, to the millisecond."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"description":"The engagement's direction.","type":"string","enum":["outbound","inbound"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_wrap_up_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550100\",\n \"date_time_ms\": \"2022-06-14T15:56:53.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement wrap up.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_wrap_up_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up started, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up started, to the millisecond."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"description":"The engagement's direction.","type":"string","enum":["outbound","inbound"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_wrap_up_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550100\",\n \"date_time_ms\": \"2022-06-14T15:56:53.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.closure_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.closure_updated","requestBody":{"description":"# contact_center.closure_updated\n\nThe **Closure updated** event is triggered when the closure is updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Closure updated** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:closure_hour:admin`\n\n**Event type**: `contact_center.closure_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the closure set.","required":["closure_set_id","date_time_ms","modified_by","updates"],"properties":{"closure_set_id":{"type":"string","description":"The closure set's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated closure set.","properties":{"closure_set_name":{"type":"string","description":"The closure set's name."},"closure_set_description":{"type":"string","description":"The closure set's description."},"timezone":{"type":"string","description":"The closure set's timezone ID."},"account_default":{"type":"boolean","description":"Default closure for the newly created queue."},"closures":{"description":"Information about the updated closures.","type":"array","items":{"required":["closure_id"],"properties":{"closure_id":{"type":"string","description":"The closure's ID."},"closure_name":{"type":"string","description":"The closure's name."},"closure_hour_type":{"description":"The closure's time type. \n* 1 - All day. \n* 2 - Customized time.","enum":[1,2],"type":"integer"},"start_time":{"type":"string","format":"datetime","description":"The closure's start time."},"end_time":{"type":"string","format":"datetime","description":"The closure's end time."},"recurring_frequency":{"description":"The frequency of a closure's recurrence. \n* 0 - Never. \n* 1 - Annually. \n* 2 - Monthly. \n* 3 - Weekly.","enum":[0,1,2,3],"type":"integer"},"recurring_frequency_type":{"description":"The closure time's type of recurrence. Applies to Annually, Monthly, and Weekly repeat frequency. Returns only for the not Never recurrence type. \n* 1 - Specific. \n* 2 - Customized.","enum":[1,2],"type":"integer"},"recurring_month":{"description":"The recurrence month. Returns only for the Annually recurrence type. \n* 1 - January \n* 2 - February \n* 3 - March \n* 4 - April \n* 5 - May \n* 6 - June \n* 7 - July \n* 8 - August \n* 9 - September \n* 10 - October \n* 11 - November \n* 12 - December","type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12]},"recurring_week_interval":{"description":"The number of weekly recurrences. Returns only for the Customized recurrence time types. When the type is Annually/Customized or Monthly/Customized, the minimum value is 1 and the maximum value is 5. When it is Weekly/Customized, the minimum value is 1 and the maximum value is 12.","minimum":1,"maximum":12,"type":"integer"},"recurring_days_of_week":{"description":"The week days of a recurrence. Returns only for the Weekly/Customized, the Weekly/Specific, the Annually/Customized, and the Monthly/Customized recurrence time types. When the type is Weekly/Customized, there may be multiple values. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7]}}}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"updates\": {\n \"closure_set_name\": \"My Updated Closure Set\",\n \"closure_set_description\": \"This is an example closure set updated.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"closures\": [\n {\n \"closure_id\": \"eedtNa0bRfCffrd2lAryDw\",\n \"closure_name\": \"New Year\",\n \"closure_hour_type\": 1,\n \"start_time\": \"2023-01-01T00:00:00Z\",\n \"end_time\": \"2023-02-01T23:59:59Z\",\n \"recurring_frequency\": 0,\n \"recurring_frequency_type\": 1,\n \"recurring_month\": 1,\n \"recurring_week_interval\": 1,\n \"recurring_days_of_week\": [\n 1\n ]\n }\n ]\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the closure set.","required":["closure_set_id","date_time_ms","modified_by","updates"],"properties":{"closure_set_id":{"type":"string","description":"The closure set's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated closure set.","properties":{"closure_set_name":{"type":"string","description":"The closure set's name."},"closure_set_description":{"type":"string","description":"The closure set's description."},"timezone":{"type":"string","description":"The closure set's timezone ID."},"account_default":{"type":"boolean","description":"Default closure for the newly created queue."},"closures":{"description":"Information about the updated closures.","type":"array","items":{"required":["closure_id"],"properties":{"closure_id":{"type":"string","description":"The closure's ID."},"closure_name":{"type":"string","description":"The closure's name."},"closure_hour_type":{"description":"The closure's time type. \n* 1 - All day. \n* 2 - Customized time.","enum":[1,2],"type":"integer"},"start_time":{"type":"string","format":"datetime","description":"The closure's start time."},"end_time":{"type":"string","format":"datetime","description":"The closure's end time."},"recurring_frequency":{"description":"The frequency of a closure's recurrence. \n* 0 - Never. \n* 1 - Annually. \n* 2 - Monthly. \n* 3 - Weekly.","enum":[0,1,2,3],"type":"integer"},"recurring_frequency_type":{"description":"The closure time's type of recurrence. Applies to Annually, Monthly, and Weekly repeat frequency. Returns only for the not Never recurrence type. \n* 1 - Specific. \n* 2 - Customized.","enum":[1,2],"type":"integer"},"recurring_month":{"description":"The recurrence month. Returns only for the Annually recurrence type. \n* 1 - January \n* 2 - February \n* 3 - March \n* 4 - April \n* 5 - May \n* 6 - June \n* 7 - July \n* 8 - August \n* 9 - September \n* 10 - October \n* 11 - November \n* 12 - December","type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12]},"recurring_week_interval":{"description":"The number of weekly recurrences. Returns only for the Customized recurrence time types. When the type is Annually/Customized or Monthly/Customized, the minimum value is 1 and the maximum value is 5. When it is Weekly/Customized, the minimum value is 1 and the maximum value is 12.","minimum":1,"maximum":12,"type":"integer"},"recurring_days_of_week":{"description":"The week days of a recurrence. Returns only for the Weekly/Customized, the Weekly/Specific, the Annually/Customized, and the Monthly/Customized recurrence time types. When the type is Weekly/Customized, there may be multiple values. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7]}}}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"updates\": {\n \"closure_set_name\": \"My Updated Closure Set\",\n \"closure_set_description\": \"This is an example closure set updated.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"closures\": [\n {\n \"closure_id\": \"eedtNa0bRfCffrd2lAryDw\",\n \"closure_name\": \"New Year\",\n \"closure_hour_type\": 1,\n \"start_time\": \"2023-01-01T00:00:00Z\",\n \"end_time\": \"2023-02-01T23:59:59Z\",\n \"recurring_frequency\": 0,\n \"recurring_frequency_type\": 1,\n \"recurring_month\": 1,\n \"recurring_week_interval\": 1,\n \"recurring_days_of_week\": [\n 1\n ]\n }\n ]\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_messaging_transcript_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_messaging_transcript_completed","requestBody":{"description":"# contact_center.engagement_messaging_transcript_completed\n\nThe **Messaging transcript completed** event is triggered when an engagement messaging transcript is completed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Messaging transcript completed** subscription under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_messaging_transcript_completed:admin`\n\n**Event type**: `contact_center.engagement_messaging_transcript_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement messaging transcript.","required":["engagement_id","engagement_direction","channel","date_time_ms","transcript_url"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel. \n* messaging","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_chat","web_chat","whatsapp","facebook_messenger","sms"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing Contact Center recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the messaging transcript was completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the messaging transcript was completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_messaging_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"SbgQTc2zS1ieFuCi5tXG6g\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"web_chat\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/engagements/transcripts/download/SbgQTc2zS1ieFuCi5tXG6g\",\n \"date_time_ms\": \"2023-10-15T08:12:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement messaging transcript.","required":["engagement_id","engagement_direction","channel","date_time_ms","transcript_url"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel. \n* messaging","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_chat","web_chat","whatsapp","facebook_messenger","sms"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing Contact Center recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the messaging transcript was completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the messaging transcript was completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_messaging_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"SbgQTc2zS1ieFuCi5tXG6g\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"web_chat\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/engagements/transcripts/download/SbgQTc2zS1ieFuCi5tXG6g\",\n \"date_time_ms\": \"2023-10-15T08:12:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.recording_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_deleted","requestBody":{"description":"# contact_center.recording_deleted\n\nThe **Recording deleted** event is triggered when an engagement's recording is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's deleted recording.","required":["recording_id","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the recording was deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the recording was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"date_time_ms\": \"2023-03-30T14:15:57.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's deleted recording.","required":["recording_id","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the recording was deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the recording was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"date_time_ms\": \"2023-03-30T14:15:57.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.queue_agent_unassigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_agent_unassigned","requestBody":{"description":"# contact_center.queue_agent_unassigned\n\nThe **Queue agent unassigned** event is triggered when an agent is removed from the queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**\n * The **Queue agent unassigned** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_agent_unassigned:admin`\n\n**Event type**: `contact_center.queue_agent_unassigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the unassigned queue agent.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_agent_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the agent was removed from the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the agent was removed from the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_agent_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the unassigned queue agent.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_agent_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the agent was removed from the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the agent was removed from the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_agent_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_completed","requestBody":{"description":"# contact_center.engagement_transfer_completed\n\nThe **Engagement transfer completed** event is triggered when an engagement transfer is completed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer completed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.team_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_updated","requestBody":{"description":"# contact_center.team_updated\nThe **Team updated** event is triggered when a team is updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team updated** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin`,`contact_center_team:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin`\n\n**Event type**: `contact_center.team_updated`\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Updated Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the updated sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was updated, to the millisecond.","example":"2025-02-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"My Team\",\n \"team_description\": \"This is the updated sales team\",\n \"date_time_ms\": \"2025-02-16T09:27:15.988Z\"\n }\n }\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Updated Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the updated sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was updated, to the millisecond.","example":"2025-02-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"My Team\",\n \"team_description\": \"This is the updated sales team\",\n \"date_time_ms\": \"2025-02-16T09:27:15.988Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_dtmf_sent":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_dtmf_sent","requestBody":{"description":"# contact_center.engagement_user_dtmf_sent\n\nThe **Engagement user DTMF sent** event is triggered when a user uses dual tone multi-frequency (DTMF) in an engagement.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement user DTMF sent** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_dtmf_sent`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement user-sent DTMF.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","dtmf_input"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_dtmf_sent/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The engagement dual tone multi-frequency input time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The engagement dual tone multi-frequency input time, to the millisecond."},"dtmf_input":{"type":"string","description":"The engagement dual tone multi-frequency input digit."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_dtmf_sent\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"dtmf_input\": \"*1234\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement user-sent DTMF.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","dtmf_input"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_dtmf_sent/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The engagement dual tone multi-frequency input time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The engagement dual tone multi-frequency input time, to the millisecond."},"dtmf_input":{"type":"string","description":"The engagement dual tone multi-frequency input digit."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_dtmf_sent\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"dtmf_input\": \"*1234\"\n }\n }\n}"}}}}}}}},"contact_center.queue_inbound_sla_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_inbound_sla_updated","requestBody":{"description":"# contact_center.queue_inbound_sla_updated\n\nThe **Queue inbound sla updated** event is triggered when the queue's inbound service level is updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Queue inbound sla updated** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**Event type**: `contact_center.queue_inbound_sla_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queue's inbound service level.","required":["cc_queue_id","updates","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the queue service level is updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue service level is updated, to the millisecond."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"updates":{"type":"object","description":"Information about the updated queue's inbound service level.","properties":{"service_level_threshold_in_seconds":{"type":"integer","description":"The amount of time the consumer waits for the call to be answered, to the second."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"The service level, excluding short abandoned calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"The service level, excluding long abandoned calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"The service level, excluding abandoned quit engagements."},"service_level_target_in_percentage":{"type":"integer","description":"Set a target percentage for service levels, as a benchmark for reports."}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_inbound_sla_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2024-02-15T09:27:15.987Z\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"updates\": {\n \"service_level_threshold_in_seconds\": 15,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queue's inbound service level.","required":["cc_queue_id","updates","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the queue service level is updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue service level is updated, to the millisecond."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"updates":{"type":"object","description":"Information about the updated queue's inbound service level.","properties":{"service_level_threshold_in_seconds":{"type":"integer","description":"The amount of time the consumer waits for the call to be answered, to the second."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"The service level, excluding short abandoned calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"The service level, excluding long abandoned calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"The service level, excluding abandoned quit engagements."},"service_level_target_in_percentage":{"type":"integer","description":"Set a target percentage for service levels, as a benchmark for reports."}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_inbound_sla_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2024-02-15T09:27:15.987Z\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"updates\": {\n \"service_level_threshold_in_seconds\": 15,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_consumer_sent_message":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_consumer_sent_message","requestBody":{"description":"# contact_center.engagement_consumer_sent_message\n\nThe **Engagement consumer sent message** event is triggered when a consumer sends a message.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement consumer sent message** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_consumer_sent_message`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's consumer-sent message.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","message_text"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_sent_message/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"message_text":{"type":"string","description":"The message's content."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_sent_message\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"message_text\": \"How can I help you?\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's consumer-sent message.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","message_text"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel.\n* whatsapp - Only applies to messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_sent_message/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"message_text":{"type":"string","description":"The message's content."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_sent_message\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"message_text\": \"How can I help you?\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_consumer_notified":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_consumer_notified","requestBody":{"description":"# contact_center.engagement_consumer_notified\n\nThe **Engagement consumer notified** event is triggered when an agent sends an invite link to or calls a consumer in a video or voice engagement, and the consumer has yet to respond.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement consumer notified** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_consumer_notified`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the engagement consumer notified.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's ring time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's ring time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_notified/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"consumer_invite_number":{"type":"string","description":"The consumer's invite phone number."},"consumer_invite_email":{"type":"string","description":"The consumer's invite email."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_notified\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_invite_number\": \"+18005550101\",\n \"consumer_invite_email\": \"janedoe@example.com\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the engagement consumer notified.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's ring time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's ring time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_notified/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"consumer_invite_number":{"type":"string","description":"The consumer's invite phone number."},"consumer_invite_email":{"type":"string","description":"The consumer's invite email."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_notified\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_invite_number\": \"+18005550101\",\n \"consumer_invite_email\": \"janedoe@example.com\"\n }\n }\n}"}}}}}}}},"contact_center.recording_stopped":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_stopped","requestBody":{"description":"# contact_center.recording_stopped\n\nThe **Recording stopped** event is triggered when an engagement's recording is stopped.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording stopped** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_stopped`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's stopped recording.","required":["recording_id","engagement_id","engagement_direction","channel","date_time_ms","users"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's stop time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's stop time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand — Manually trigger recording. \n* automatic — Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, either a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, either a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user — This recording belongs to a user. \n* queue — This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_stopped/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_stopped\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's stopped recording.","required":["recording_id","engagement_id","engagement_direction","channel","date_time_ms","users"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's stop time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's stop time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand — Manually trigger recording. \n* automatic — Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, either a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, either a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user — This recording belongs to a user. \n* queue — This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_stopped/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_stopped\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.user_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_deleted","requestBody":{"description":"# contact_center.user_deleted\n\nThe **User deleted** event is triggered when a user is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_deleted:admin`\n\n**Event type**: `contact_center.user_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted user.","required":["users","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was deleted, to the millisecond."},"users":{"type":"array","description":"The user's information, when the user is deleted.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2023-03-01T00:00:00.987Z\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted user.","required":["users","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was deleted, to the millisecond."},"users":{"type":"array","description":"The user's information, when the user is deleted.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2023-03-01T00:00:00.987Z\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.task_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_deleted","requestBody":{"description":"# contact_center.task_deleted\n\nThe **Task deleted** event is triggered when a task is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Task deleted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_deleted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_deleted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_wrap_up_ended":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_wrap_up_ended","requestBody":{"description":"# contact_center.engagement_wrap_up_ended\n\nThe **Engagement wrap up ended** event is triggered when a wrap up ends for an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification endpoint URL**.\n* The **Engagement wrap up ended** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_wrap_up_ended`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the ended engagement wrap up.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_wrap_up_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up ended, to the millisecond."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"description":"The engagement's direction.","type":"string","enum":["outbound","inbound"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_wrap_up_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550100\",\n \"date_time_ms\": \"2022-06-14T15:56:53.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the ended engagement wrap up.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_wrap_up_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement wrap up ended, to the millisecond."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"description":"The engagement's direction.","type":"string","enum":["outbound","inbound"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_wrap_up_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550100\",\n \"date_time_ms\": \"2022-06-14T15:56:53.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_timeout":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_timeout","requestBody":{"description":"# contact_center.engagement_conference_participant_timeout\nThe **Engagement conference participant timeout** event is triggered when a participant's conference invitation times out.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference participant timeout** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_timeout`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement conference participant timeout.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","timed_out_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID"},"team_name":{"type":"string","description":"The team's name"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a participant's conference invitation times out, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"timed_out_participant":{"type":"object","description":"The participant whose conference invitation timed out.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"timed_out_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement conference participant timeout.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","timed_out_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID"},"team_name":{"type":"string","description":"The team's name"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a participant's conference invitation times out, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"timed_out_participant":{"type":"object","description":"The participant whose conference invitation timed out.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number"}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"timed_out_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_hold":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_hold","requestBody":{"description":"# contact_center.engagement_user_hold\n\nThe **Engagement user hold** event is triggered when a user goes on hold in an engagement.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement user hold** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_hold`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user on hold in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_hold/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's hold time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's hold time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_hold\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user on hold in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_hold/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's hold time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's hold time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_hold\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_rejected":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_rejected","requestBody":{"description":"# contact_center.engagement_transfer_rejected\n\nThe **Engagement transfer rejected** event is triggered when an engagement transfer is rejected.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer rejected** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_rejected`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the rejected engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_rejected/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is rejected, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is rejected, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Smith\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"John Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the rejected engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_rejected/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is rejected, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is rejected, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Smith\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"John Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_status_changed":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_status_changed","requestBody":{"description":"# contact_center.user_status_changed\n\nThe **User status changed** event is triggered when a user status is changed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **User status changed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_status_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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user status change.","required":["user_id","display_name","previous_status_id","previous_status_name","current_status_id","current_status_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_status_changed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"previous_status_id":{"type":"string","description":"The user's previous status ID."},"previous_status_name":{"type":"string","description":"The user's previous status name."},"previous_sub_status_id":{"type":"string","description":"The user's previous reason ID when the user previous status is Not Ready."},"previous_sub_status_name":{"type":"string","description":"The user's previous reason when the user previous status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status category.\n\n**Default Not Ready reasons**\n * Break \n* End Shift \n* Forced \n* Meal \n* Meeting \n* Training \n"},"current_status_id":{"type":"string","description":"The user's current status ID."},"current_status_name":{"type":"string","description":"The user's current status name."},"current_sub_status_id":{"type":"string","description":"The user's current reason ID when the user current status is Not Ready."},"current_sub_status_name":{"type":"string","description":"The user's current reason when the user current status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status category.\n\n**Default Not Ready reasons**\n * Break \n* End Shift \n* Forced \n* Meal \n* Meeting \n* Training \n"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user's status was last changed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user's status was last changed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_status_changed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"previous_status_id\": \"2\",\n \"previous_status_name\": \"Not Ready\",\n \"previous_sub_status_id\": \"20\",\n \"previous_sub_status_name\": \"Break\",\n \"current_status_id\": \"2\",\n \"current_status_name\": \"Not Ready\",\n \"current_sub_status_id\": \"21\",\n \"current_sub_status_name\": \"Meal\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user status change.","required":["user_id","display_name","previous_status_id","previous_status_name","current_status_id","current_status_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_status_changed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"previous_status_id":{"type":"string","description":"The user's previous status ID."},"previous_status_name":{"type":"string","description":"The user's previous status name."},"previous_sub_status_id":{"type":"string","description":"The user's previous reason ID when the user previous status is Not Ready."},"previous_sub_status_name":{"type":"string","description":"The user's previous reason when the user previous status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status category.\n\n**Default Not Ready reasons**\n * Break \n* End Shift \n* Forced \n* Meal \n* Meeting \n* Training \n"},"current_status_id":{"type":"string","description":"The user's current status ID."},"current_status_name":{"type":"string","description":"The user's current status name."},"current_sub_status_id":{"type":"string","description":"The user's current reason ID when the user current status is Not Ready."},"current_sub_status_name":{"type":"string","description":"The user's current reason when the user current status is Not Ready.\n\n To query a list of default and custom Not Ready reasons, call [List System Statuses](/docs/contact-center/apis/#operation/listSystemStatus). Filter by queue_opt_out_and_not_ready_status status category.\n\n**Default Not Ready reasons**\n * Break \n* End Shift \n* Forced \n* Meal \n* Meeting \n* Training \n"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user's status was last changed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user's status was last changed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_status_changed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"previous_status_id\": \"2\",\n \"previous_status_name\": \"Not Ready\",\n \"previous_sub_status_id\": \"20\",\n \"previous_sub_status_name\": \"Break\",\n \"current_status_id\": \"2\",\n \"current_status_name\": \"Not Ready\",\n \"current_sub_status_id\": \"21\",\n \"current_sub_status_name\": \"Meal\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_updated","requestBody":{"description":"# contact_center.task_updated\n\nThe **Task updated** event is triggered when a task is updated.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Task updated** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's [flow](https://support.zoom.us/hc/en-us/articles/4472928851469-Managing-flows) ID."},"task_status":{"type":"string","description":"The task's assignment status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_updated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the updated task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's [flow](https://support.zoom.us/hc/en-us/articles/4472928851469-Managing-flows) ID."},"task_status":{"type":"string","description":"The task's assignment status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_updated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"pending\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\n}"}}}}}}}},"contact_center.recording_resumed":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_resumed","requestBody":{"description":"# contact_center.recording_resumed\n\nThe **Recording resumed** event is triggered when an engagement's recording is resumed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording resumed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_resumed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's resumed recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's resumption time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's resumption time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_resumed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_resumed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's resumed recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"date_time":{"type":"string","format":"date-time","description":"The recording's resumption time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's resumption time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_resumed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_resumed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.987Z\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_disposition_added":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_disposition_added","requestBody":{"description":"# contact_center.engagement_disposition_added\n\nThe **Engagement disposition added** event is triggered when a user completes a disposition for the engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement disposition added** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_disposition_added`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement disposition.","required":["disposition_id","disposition_name","status","last_modified_time","modified_by","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"disposition_id":{"type":"string","description":"The disposition's ID."},"disposition_name":{"type":"string","description":"The disposition's name."},"disposition_description":{"type":"string","description":"The disposition's description."},"status":{"type":"string","description":"The disposition's active status. \n* inactive - Deactivated. \n* active - Activated.","enum":["inactive","active"]},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the disposition was last modified in the admin portal."},"modified_by":{"type":"string","description":"The ID of the user who last modified the disposition."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"channel_id":{"type":"string","description":"The channel's ID.","deprecated":true},"channel_name":{"type":"string","description":"The channel's type. \n* voice \n* sms \n* chat \n* video \n* in_app_chat","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The engagement's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_disposition_added/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement disposition was added, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement disposition was added, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_disposition_added\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"disposition_id\": \"W_VATTk_Q5aW6z5rZtBxAQ\",\n \"disposition_name\": \"My disposition\",\n \"disposition_description\": \"This is an example disposition.\",\n \"status\": \"inactive\",\n \"last_modified_time\": \"2021-12-03T05:07:46Z\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement disposition.","required":["disposition_id","disposition_name","status","last_modified_time","modified_by","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"disposition_id":{"type":"string","description":"The disposition's ID."},"disposition_name":{"type":"string","description":"The disposition's name."},"disposition_description":{"type":"string","description":"The disposition's description."},"status":{"type":"string","description":"The disposition's active status. \n* inactive - Deactivated. \n* active - Activated.","enum":["inactive","active"]},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the disposition was last modified in the admin portal."},"modified_by":{"type":"string","description":"The ID of the user who last modified the disposition."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"channel_id":{"type":"string","description":"The channel's ID.","deprecated":true},"channel_name":{"type":"string","description":"The channel's type. \n* voice \n* sms \n* chat \n* video \n* in_app_chat","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The engagement's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_disposition_added/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement disposition was added, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement disposition was added, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_disposition_added\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"disposition_id\": \"W_VATTk_Q5aW6z5rZtBxAQ\",\n \"disposition_name\": \"My disposition\",\n \"disposition_description\": \"This is an example disposition.\",\n \"status\": \"inactive\",\n \"last_modified_time\": \"2021-12-03T05:07:46Z\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.asset_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.asset_created","requestBody":{"description":"# contact_center.asset_created\n\nThe **Asset created** event is triggered when a new asset is created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Asset created** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin`\n\n**Event type**: `contact_center.asset_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the added asset.","required":["asset_id","asset_name","asset_type","asset_language_code","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"asset_name":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"asset_description":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetDescription-Contact Center"},"asset_type":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetType-Contact Center"},"asset_language_code":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetLanguageCode-Contact Center"},"asset_items":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsResp-Contact Center"},"category_id":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/CategoryId-Contact Center"},"category_name":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/CategoryName-Contact Center"},"modified_by":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"AssetDescription-Contact Center":{"type":"string","description":"The asset's description."},"AssetType-Contact Center":{"type":"string","description":"The asset's type.","enum":["audio","image","slides","text","video","saved_reply"]},"AssetLanguageCode-Contact Center":{"type":"string","description":"The asset's default language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is created, to the millisecond.","format":"date-time"},"AssetItemsResp-Contact Center":{"type":"array","description":"A list of the asset's items. \n\n### Restriction\nEach item has a different asset_item_language, and only one item has a is_default set to true.","items":{"type":"object","required":["asset_item_id","asset_item_language","is_default"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","example":"en-US","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies to the asset_type is one of these: image, audio, video, slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"CategoryId-Contact Center":{"type":"string","description":"The asset category's ID."},"CategoryName-Contact Center":{"type":"string","description":"The asset category's name."}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"asset_name\": \"My Asset\",\n \"asset_description\": \"This is an example asset.\",\n \"asset_type\": \"audio\",\n \"asset_language_code\": \"en-US\",\n \"asset_items\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item\",\n \"asset_item_language\": \"en-US\",\n \"is_default\": true,\n \"asset_item_file_url\": \"https://file.zoom.us/example.mp3\",\n \"asset_item_content\": \"My Asset Item Content\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"category_id\": \"bnGEj1yrRb6qlNMvyMK08g\",\n \"category_name\": \"My Category\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the added asset.","required":["asset_id","asset_name","asset_type","asset_language_code","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"asset_name":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"asset_description":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetDescription-Contact Center"},"asset_type":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetType-Contact Center"},"asset_language_code":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetLanguageCode-Contact Center"},"asset_items":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsResp-Contact Center"},"category_id":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/CategoryId-Contact Center"},"category_name":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/CategoryName-Contact Center"},"modified_by":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_created/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"AssetDescription-Contact Center":{"type":"string","description":"The asset's description."},"AssetType-Contact Center":{"type":"string","description":"The asset's type.","enum":["audio","image","slides","text","video","saved_reply"]},"AssetLanguageCode-Contact Center":{"type":"string","description":"The asset's default language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is created, to the millisecond.","format":"date-time"},"AssetItemsResp-Contact Center":{"type":"array","description":"A list of the asset's items. \n\n### Restriction\nEach item has a different asset_item_language, and only one item has a is_default set to true.","items":{"type":"object","required":["asset_item_id","asset_item_language","is_default"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","example":"en-US","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies to the asset_type is one of these: image, audio, video, slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"CategoryId-Contact Center":{"type":"string","description":"The asset category's ID."},"CategoryName-Contact Center":{"type":"string","description":"The asset category's name."}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"asset_name\": \"My Asset\",\n \"asset_description\": \"This is an example asset.\",\n \"asset_type\": \"audio\",\n \"asset_language_code\": \"en-US\",\n \"asset_items\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item\",\n \"asset_item_language\": \"en-US\",\n \"is_default\": true,\n \"asset_item_file_url\": \"https://file.zoom.us/example.mp3\",\n \"asset_item_content\": \"My Asset Item Content\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"category_id\": \"bnGEj1yrRb6qlNMvyMK08g\",\n \"category_name\": \"My Category\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.team_members_unassigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_members_unassigned","requestBody":{"description":"# contact_center.team_members_unassigned\nThe **Team members unassigned** event is triggered when supervisors or agents are unassigned from a team.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team members unassigned** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin`,`contact_center_team:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team_member_unassigned:admin`\n\n**Event type**: `contact_center.team_members_unassigned`\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the unassigned members.","required":["team_id","user_ids","team_role","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"user_ids":{"type":"array","description":"The user's ID list assigned to the team.","example":"[IGTRVt3gQ2i-WjoUIjeZxw,T_X0vrroQPO4UwXGNeBS8A]"},"team_role":{"type":"string","description":"The user's role in the team.","example":"supervisor","enum":["supervisor","agent"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a user is unassigned from the team.","example":"2025-02-16T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_members_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"user_ids\": [\n \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"T_X0vrroQPO4UwXGNeBS8A\"\n ],\n \"team_role\": \"supervisor\",\n \"date_time_ms\": \"2025-02-16T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the unassigned members.","required":["team_id","user_ids","team_role","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"user_ids":{"type":"array","description":"The user's ID list assigned to the team.","example":"[IGTRVt3gQ2i-WjoUIjeZxw,T_X0vrroQPO4UwXGNeBS8A]"},"team_role":{"type":"string","description":"The user's role in the team.","example":"supervisor","enum":["supervisor","agent"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a user is unassigned from the team.","example":"2025-02-16T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_members_unassigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"user_ids\": [\n \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"T_X0vrroQPO4UwXGNeBS8A\"\n ],\n \"team_role\": \"supervisor\",\n \"date_time_ms\": \"2025-02-16T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.call_control_answer_call_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_answer_call_executed","requestBody":{"description":"# contact_center.call_control_answer_call_executed\nThe **Call control answer call executed** event is triggered when a call is answered by using [Command control of a user](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call control answer call executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_answer_call_executed`\n","content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name.","example":"contact_center.call_control_answer_call_executed"},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred.","example":"1767076587049"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"zPd1zOyTRlSAQh70ltxTIw"},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control answer call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a call was answered by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_answer_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name.","example":"contact_center.call_control_answer_call_executed"},"event_ts":{"type":"integer","format":"int64","description":"The timestamp when the event occurred.","example":"1767076587049"},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"zPd1zOyTRlSAQh70ltxTIw"},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control answer call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a call was answered by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_answer_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.team_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_deleted","requestBody":{"description":"# contact_center.team_deleted\nThe **Team deleted** event is triggered when a team is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin`,`contact_center_team:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin`\n\n**Event type**: `contact_center.team_deleted`\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the sales team"},"parent_team_id":{"type":"string","description":"The team's parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"parent_team_name":{"type":"string","description":"The team's parent team name.","example":"Online sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team is deleted.","example":"2025-02-19T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Sales Team\",\n \"team_description\": \"This is the sales team\",\n \"parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"parent_team_name\": \"Online sales team\",\n \"date_time_ms\": \"2025-02-15T09:27:15.988Z\"\n }\n }\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the sales team"},"parent_team_id":{"type":"string","description":"The team's parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"parent_team_name":{"type":"string","description":"The team's parent team name.","example":"Online sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team is deleted.","example":"2025-02-19T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Sales Team\",\n \"team_description\": \"This is the sales team\",\n \"parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"parent_team_name\": \"Online sales team\",\n \"date_time_ms\": \"2025-02-15T09:27:15.988Z\"\n }\n }\n}"}}}}}}}},"contact_center.call_control_end_call_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_end_call_executed","requestBody":{"description":"# contact_center.call_control_end_call_executed\nThe **Call control end call executed** event is triggered when a call is ended by using [Command control of a user](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call control end call executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_end_call_executed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control end call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a call was ended by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_end_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control end call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a call was ended by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_end_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.cx_engagement_end_data_ready":{"post":{"tags":["contact_center"],"operationId":"contact_center.cx_engagement_end_data_ready","requestBody":{"description":"# contact_center.cx_engagement_end_data_ready\nThe **CX engagement end data ready** event is triggered when the report V2 data collected at engagement end is ready.\n\n If you need some specific engagement information, use the [**Get Engagement API**](/docs/api/contact-center/#tag/reports-v2cx-analytics/get/contact_center/analytics/log/historical/engagement) to retrieve the data.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **CX Engagement End Data Ready** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_report:admin`\n\n**Event type**: `contact_center.cx_engagement_end_data_ready`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement-end report V2 data.","required":["engagement_id","engagement_direction","channel","start_time","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging","email","work_item"]},"start_time":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement-end data is ready, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.cx_engagement_end_data_ready\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"start_time\": \"2023-05-01T09:25:18.264Z\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement-end report V2 data.","required":["engagement_id","engagement_direction","channel","start_time","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging","email","work_item"]},"start_time":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement-end data is ready, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.cx_engagement_end_data_ready\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"start_time\": \"2023-05-01T09:25:18.264Z\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_upgrade_expired":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_upgrade_expired","requestBody":{"description":"# contact_center.engagement_upgrade_expired\nThe **Engagement Upgrade Expired** event is triggered when a Contact Center **voice or messaging** engagement being upgraded to video is expired.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Engagement Upgrade Expired** subscription under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_upgrade_expired`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the expired engagement's upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel's type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement expired."},"flow_name":{"type":"string","description":"The flow name where the engagement expired."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_expired/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement expired, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement expired, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_expired\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"John Smith\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the expired engagement's upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel's type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement expired."},"flow_name":{"type":"string","description":"The flow name where the engagement expired."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_expired/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement expired, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement expired, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_expired\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"John Smith\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_consumer_ended":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_consumer_ended","requestBody":{"description":"# contact_center.engagement_consumer_ended\n\nThe **Engagement consumer ended** event is triggered when a consumer ends an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement consumer ended** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_consumer_ended`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the consumer ended engagement.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the consumer ended engagement.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n }\n}"}}}}}}}},"contact_center.queue_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_deleted","requestBody":{"description":"# contact_center.queue_deleted\n\nThe **Queue deleted** event is triggered when a task queue is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**.\n * The **Queue deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin`\n\n**Event type**: `contact_center.queue_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted task queue.","required":["cc_queue_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","messaging"]}},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether the **Short Abandon** setting is enabled."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"Distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"wrap_up_expiration":{"type":"boolean","description":"If enabled, engagements auto close at the end of wrap-up duration."},"overflow_to_goodbye_message":{"type":"boolean","description":"If enabled, a goodbye message plays and then disconnects when the wait time is exceeded."},"overflow_to_queue_id":{"type":"string","description":"Queue ID. If overflow type is queue, the consumer is routed to this queue when the wait time is exceeded.","deprecated":true},"overflow_to_cc_queue_id":{"type":"string","description":"The Contact Center queue's ID. If overflow type is queue, the consumer is routed to this queue when the wait time is exceeded."},"overflow_to_flow_id":{"type":"string","description":"Flow ID. If overflow type is flow, the consumer is routed to this flow when the wait time is exceeded."},"overflow_to_inbox_id":{"type":"string","description":"Inbox ID. If overflow type is inbox, the consumer is routed to this inbox when the wait time is exceeded."},"auto_close_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent when auto close."},"auto_close_message":{"type":"string","description":"Warning message, will sent when auto close."},"auto_close_timeout":{"type":"integer","description":"Auto close message time, to the minute."},"auto_close_alert_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent before auto close."},"auto_close_alert_message":{"type":"string","description":"Warning message sent before auto close."},"auto_close_alert_message_time":{"type":"integer","description":"Auto close alert message time, to the minute."},"recording_storage_location":{"type":"string","description":"The recording storage location."},"service_level_threshold_in_seconds":{"type":"integer","description":"If channel type is voice or video, this threshold is answer time by agents for all inbound calls. Otherwise, this threshold is first message speed by agents for all engagements."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"If enabled, short-abandoned calls are excluded from all inbound calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"If enabled, long-abandoned calls are excluded from all inbound calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"If enabled, abandon quit engagements are excluded from total inbound messaging engagements."},"service_level_target_in_percentage":{"type":"integer","description":"A target for service level as the benchmark to refer to in reports."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"channel_types\": [\n \"chat\"\n ],\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"wrap_up_expiration\": true,\n \"overflow_to_goodbye_message\": true,\n \"overflow_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"overflow_to_flow_id\": \"psjHGHrHQbaX8Zk7ldc81Q\",\n \"overflow_to_inbox_id\": \"cMH8RJA0QsyJBCWIFbWfBQ\",\n \"auto_close_message\": \"This chat has been auto-closed due to inactivity.\",\n \"auto_close_message_enabled\": true,\n \"auto_close_timeout\": 10,\n \"auto_close_alert_message\": \"Chat will auto-close soon if you don’t reply\",\n \"auto_close_alert_message_enabled\": true,\n \"auto_close_alert_message_time\": 10,\n \"recording_storage_location\": \"us\",\n \"service_level_threshold_in_seconds\": 10,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80,\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted task queue.","required":["cc_queue_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","messaging"]}},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether the **Short Abandon** setting is enabled."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"Distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"wrap_up_expiration":{"type":"boolean","description":"If enabled, engagements auto close at the end of wrap-up duration."},"overflow_to_goodbye_message":{"type":"boolean","description":"If enabled, a goodbye message plays and then disconnects when the wait time is exceeded."},"overflow_to_queue_id":{"type":"string","description":"Queue ID. If overflow type is queue, the consumer is routed to this queue when the wait time is exceeded.","deprecated":true},"overflow_to_cc_queue_id":{"type":"string","description":"The Contact Center queue's ID. If overflow type is queue, the consumer is routed to this queue when the wait time is exceeded."},"overflow_to_flow_id":{"type":"string","description":"Flow ID. If overflow type is flow, the consumer is routed to this flow when the wait time is exceeded."},"overflow_to_inbox_id":{"type":"string","description":"Inbox ID. If overflow type is inbox, the consumer is routed to this inbox when the wait time is exceeded."},"auto_close_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent when auto close."},"auto_close_message":{"type":"string","description":"Warning message, will sent when auto close."},"auto_close_timeout":{"type":"integer","description":"Auto close message time, to the minute."},"auto_close_alert_message_enabled":{"type":"boolean","description":"If enabled, a warning message is sent before auto close."},"auto_close_alert_message":{"type":"string","description":"Warning message sent before auto close."},"auto_close_alert_message_time":{"type":"integer","description":"Auto close alert message time, to the minute."},"recording_storage_location":{"type":"string","description":"The recording storage location."},"service_level_threshold_in_seconds":{"type":"integer","description":"If channel type is voice or video, this threshold is answer time by agents for all inbound calls. Otherwise, this threshold is first message speed by agents for all engagements."},"service_level_exclude_short_abandoned_calls":{"type":"boolean","description":"If enabled, short-abandoned calls are excluded from all inbound calls."},"service_level_exclude_long_abandoned_calls":{"type":"boolean","description":"If enabled, long-abandoned calls are excluded from all inbound calls."},"service_level_exclude_abandoned_quit_engagements":{"type":"boolean","description":"If enabled, abandon quit engagements are excluded from total inbound messaging engagements."},"service_level_target_in_percentage":{"type":"integer","description":"A target for service level as the benchmark to refer to in reports."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the queue was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"channel_types\": [\n \"chat\"\n ],\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"wrap_up_expiration\": true,\n \"overflow_to_goodbye_message\": true,\n \"overflow_to_cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"overflow_to_flow_id\": \"psjHGHrHQbaX8Zk7ldc81Q\",\n \"overflow_to_inbox_id\": \"cMH8RJA0QsyJBCWIFbWfBQ\",\n \"auto_close_message\": \"This chat has been auto-closed due to inactivity.\",\n \"auto_close_message_enabled\": true,\n \"auto_close_timeout\": 10,\n \"auto_close_alert_message\": \"Chat will auto-close soon if you don’t reply\",\n \"auto_close_alert_message_enabled\": true,\n \"auto_close_alert_message_time\": 10,\n \"recording_storage_location\": \"us\",\n \"service_level_threshold_in_seconds\": 10,\n \"service_level_exclude_short_abandoned_calls\": true,\n \"service_level_exclude_long_abandoned_calls\": true,\n \"service_level_exclude_abandoned_quit_engagements\": true,\n \"service_level_target_in_percentage\": 80,\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.business_hours_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.business_hours_updated","requestBody":{"description":"# contact_center.business_hours_updated\n\nThe **Business hours updated** event is triggered when the business hours are updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Business hours updated** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hour:admin`\n\n**Event type**: `contact_center.business_hours_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the business hours.","required":["business_hour_id","modified_by","date_time_ms","updates"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated business hours.","properties":{"business_hour_name":{"type":"string","description":"The business hours' name."},"business_hour_description":{"type":"string","description":"The business hours' description."},"timezone":{"type":"string","description":"The business hours' timezone ID."},"account_default":{"type":"boolean","description":"Default business hours for the newly created queue."},"hours":{"type":"object","description":"Information about the hours.","properties":{"hour_type":{"description":"The type of business hours. \n* 1 - 24 hours, 7 days a week. \n* 2 - Custom hours.","enum":[1,2],"type":"integer"},"custom_hours":{"description":"The custom hours' settings. Returned only for the Custom hours type.","items":{"properties":{"day_of_week":{"description":"The day of the week. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","enum":[1,2,3,4,5,6,7],"type":"integer"},"custom_hour_type":{"description":"The type of custom hours. \n* 0 - Disabled. \n* 1 - 24 hours. \n* 2 - Customized hours.","enum":[0,1,2],"type":"integer"},"custom_hour_ranges":{"description":"The custom hours' range. Returned only for the Customized hours type.","items":{"properties":{"start_time":{"description":"The custom hours' start time, in HH:mm and 24-hour clock format.","type":"string"},"end_time":{"description":"The custom hours' end time, in HH:mm and 24-hour clock format.","type":"string"}}},"type":"array"}},"type":"object"},"type":"array"}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"updates\": {\n \"business_hour_name\": \"My Updated Business Hours\",\n \"business_hour_description\": \"This is an example business hours updated.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"hours\": {\n \"hour_type\": 1,\n \"custom_hours\": [\n {\n \"day_of_week\": 1,\n \"custom_hour_type\": 1,\n \"custom_hour_ranges\": [\n {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\"\n }\n ]\n }\n ]\n }\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the business hours.","required":["business_hour_id","modified_by","date_time_ms","updates"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are updated, to the millisecond."},"updates":{"type":"object","description":"Information about the updated business hours.","properties":{"business_hour_name":{"type":"string","description":"The business hours' name."},"business_hour_description":{"type":"string","description":"The business hours' description."},"timezone":{"type":"string","description":"The business hours' timezone ID."},"account_default":{"type":"boolean","description":"Default business hours for the newly created queue."},"hours":{"type":"object","description":"Information about the hours.","properties":{"hour_type":{"description":"The type of business hours. \n* 1 - 24 hours, 7 days a week. \n* 2 - Custom hours.","enum":[1,2],"type":"integer"},"custom_hours":{"description":"The custom hours' settings. Returned only for the Custom hours type.","items":{"properties":{"day_of_week":{"description":"The day of the week. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","enum":[1,2,3,4,5,6,7],"type":"integer"},"custom_hour_type":{"description":"The type of custom hours. \n* 0 - Disabled. \n* 1 - 24 hours. \n* 2 - Customized hours.","enum":[0,1,2],"type":"integer"},"custom_hour_ranges":{"description":"The custom hours' range. Returned only for the Customized hours type.","items":{"properties":{"start_time":{"description":"The custom hours' start time, in HH:mm and 24-hour clock format.","type":"string"},"end_time":{"description":"The custom hours' end time, in HH:mm and 24-hour clock format.","type":"string"}}},"type":"array"}},"type":"object"},"type":"array"}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"updates\": {\n \"business_hour_name\": \"My Updated Business Hours\",\n \"business_hour_description\": \"This is an example business hours updated.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"hours\": {\n \"hour_type\": 1,\n \"custom_hours\": [\n {\n \"day_of_week\": 1,\n \"custom_hour_type\": 1,\n \"custom_hour_ranges\": [\n {\n \"start_time\": \"09:00\",\n \"end_time\": \"18:00\"\n }\n ]\n }\n ]\n }\n }\n }\n }\n}"}}}}}}}},"contact_center.call_control_hold_call_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_hold_call_executed","requestBody":{"description":"# contact_center.call_control_hold_call_executed\nThe **Call control hold call executed event** is triggered when an active call is placed on hold by using [Command control of a user](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call control hold call executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_hold_call_executed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control hold call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when an active call is placed on hold by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_hold_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control hold call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when an active call is placed on hold by using the **Command Control of user** API, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_hold_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.queue_agent_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_agent_assigned","requestBody":{"description":"# contact_center.queue_agent_assigned\n\nThe **Queue agent assigned** event is triggered when an agent is assigned to the queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**\n * The **Queue agent assigned** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_agent_assigned:admin`\n\n**Event type**: `contact_center.queue_agent_assigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the assigned queue agent.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_agent_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the agent was assigned to the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the agent was assigned to the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_agent_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the assigned queue agent.","required":["cc_queue_id","user_id","date_time_ms"],"properties":{"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.queue_agent_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the agent was assigned to the queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the agent was assigned to the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_agent_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_joined":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_joined","requestBody":{"description":"# contact_center.engagement_conference_participant_joined\nThe **Engagement conference participant joined** event is triggered when the participant joins an engagement conference.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference paricipant joined** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_joined`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement conference participant joined.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","joining_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant joined the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"joining_participant":{"type":"object","description":"The participant who joined the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_joined\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n },\n {\n \"participant_user_id\": \"ppsafdjsahfdag\",\n \"participant_display_name\": \"Payne Miller\",\n \"participant_role\": \"invitee\"\n }\n ],\n \"joining_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement conference participant joined.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","joining_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant joined the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"joining_participant":{"type":"object","description":"The participant who joined the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_joined\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n },\n {\n \"participant_user_id\": \"ppsafdjsahfdag\",\n \"participant_display_name\": \"Payne Miller\",\n \"participant_role\": \"invitee\"\n }\n ],\n \"joining_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.business_hours_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.business_hours_deleted","requestBody":{"description":"# contact_center.business_hours_deleted\n\nThe **Business hours deleted** event is triggered when the business hours are deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Business hours deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:business_hour:admin`\n\n**Event type**: `contact_center.business_hours_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted business hours.","required":["business_hour_id","modified_by","date_time_ms"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted business hours.","required":["business_hour_id","modified_by","date_time_ms"],"properties":{"business_hour_id":{"type":"string","description":"The business hours' ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the business hours are deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the business hours are deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.business_hours_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"business_hour_id\": \"66ZjSQ7YTOescnINN_4vog\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_completed","requestBody":{"description":"# contact_center.task_completed\n\nThe **Task completed** event is triggered when a user completes a task.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Task completed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"completed\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 0,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"completed\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 0,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_deleted","requestBody":{"description":"# contact_center.inbox_message_deleted\nThe **Inbox message deleted** event is triggered when an agent or supervisor soft deletes or hard deletes a voicemail.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message deleted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","delete_type","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_deleted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"delete_type":{"type":"string","description":"The message's delete type.","enum":["Soft delete","Hard delete"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550101\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"delete_type\": \"Soft delete\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","delete_type","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_deleted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"delete_type":{"type":"string","description":"The message's delete type.","enum":["Soft delete","Hard delete"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550101\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"delete_type\": \"Soft delete\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_created","requestBody":{"description":"# contact_center.task_reservation_created\n\nThe **User created a task reservation** event is triggered when a user creates a task queue reservation.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **User created a task reservation** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_created/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_created/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.sms_status":{"post":{"tags":["contact_center"],"operationId":"contact_center.sms_status","requestBody":{"description":"# contact_center.sms_status\nThe **SMS status** event is triggered when an SMS message is sent by using the [Send an SMS](/docs/api/contact-center/#tag/sms/post/contact_center/sms). The receipt indicates whether the SMS was actually delivered to the consumer.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **SMS status** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:sms:admin`\n\n**Event type**: `contact_center.sms_status`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the SMS status.","required":["message_id","status","date_time_ms"],"properties":{"message_id":{"type":"string","description":"Call /v2/contact_center/sms to return the message ID. It uniquely represents this message."},"contact_center_number":{"type":"string","description":"The SMS' destionation number."},"status":{"type":"string","description":"The SMS sent status. \n* delivered \n* undelivered \n* failed ","enum":["delivered","undelivered","failed"]},"consumer_number":{"type":"string","description":"The SMS' source number."},"reason":{"type":"string","description":"If the SMS status is failed or undelivered, give the reason here."},"date_time_ms":{"type":"string","format":"date-time","description":"The SMS status update time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.sms_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"BW-JuqWVQ623CI4Q8yQK0Q\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"status\": \"delivered\",\n \"date_time_ms\": \"2022-02-15T09:27:15.321Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the SMS status.","required":["message_id","status","date_time_ms"],"properties":{"message_id":{"type":"string","description":"Call /v2/contact_center/sms to return the message ID. It uniquely represents this message."},"contact_center_number":{"type":"string","description":"The SMS' destionation number."},"status":{"type":"string","description":"The SMS sent status. \n* delivered \n* undelivered \n* failed ","enum":["delivered","undelivered","failed"]},"consumer_number":{"type":"string","description":"The SMS' source number."},"reason":{"type":"string","description":"If the SMS status is failed or undelivered, give the reason here."},"date_time_ms":{"type":"string","format":"date-time","description":"The SMS status update time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.sms_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"BW-JuqWVQ623CI4Q8yQK0Q\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"status\": \"delivered\",\n \"date_time_ms\": \"2022-02-15T09:27:15.321Z\"\n }\n }\n}"}}}}}}}},"contact_center.closure_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.closure_created","requestBody":{"description":"# contact_center.closure_created\n\nThe **Closure created** event is triggered when the closure is created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Closure created** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:closure_hour:admin`\n\n**Event type**: `contact_center.closure_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created closure set.","required":["closure_set_id","closure_set_name","timezone","account_default","modified_by","date_time_ms","closures"],"properties":{"closure_set_id":{"type":"string","description":"The closure's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is created, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is created, to the millisecond."},"closure_set_name":{"type":"string","description":"The closure set's name."},"closure_set_description":{"type":"string","description":"The closure set's description."},"timezone":{"type":"string","description":"The closure set's timezone ID."},"account_default":{"type":"boolean","description":"Default closure for the newly created queue."},"closures":{"description":"Information about the closures.","type":"array","items":{"required":["closure_id","closure_name"],"properties":{"closure_id":{"type":"string","description":"The closure's ID."},"closure_name":{"type":"string","description":"The closure's name."},"closure_hour_type":{"description":"The closure's time type. \n* 1 - All day. \n* 2 - Customized time.","enum":[1,2],"type":"integer"},"start_time":{"type":"string","format":"datetime","description":"The closure's start time."},"end_time":{"type":"string","format":"datetime","description":"The closure's end time."},"recurring_frequency":{"description":"The frequency of a closure's recurrence. \n* 0 - Never. \n* 1 - Annually. \n* 2 - Monthly. \n* 3 - Weekly.","enum":[0,1,2,3],"type":"integer"},"recurring_frequency_type":{"description":"The closure time's type of recurrence. Applies to Annually, Monthly, and Weekly repeat frequency. Returns only for the not Never recurrence type. \n* 1 - Specific. \n* 2 - Customized.","enum":[1,2],"type":"integer"},"recurring_month":{"description":"The recurrence month. Returns only for the Annually recurrence type. \n* 1 - January \n* 2 - February \n* 3 - March \n* 4 - April \n* 5 - May \n* 6 - June \n* 7 - July \n* 8 - August \n* 9 - September \n* 10 - October \n* 11 - November \n* 12 - December","type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12]},"recurring_week_interval":{"description":"The number of weekly recurrences. Returns only for the Customized recurrence time types. When the type is Annually/Customized or Monthly/Customized, the minimum value is 1 and the maximum value is 5. When it is Weekly/Customized, the minimum value is 1 and the maximum value is 12.","minimum":1,"maximum":12,"type":"integer"},"recurring_days_of_week":{"description":"The week days of a recurrence. Returns only for the Weekly/Customized, the Weekly/Specific, the Annually/Customized, and the Monthly/Customized recurrence time types. When the type is Weekly/Customized, there may be multiple values. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7]}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"closure_set_name\": \"My Closure Set\",\n \"closure_set_description\": \"This is an example closure set.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"closures\": [\n {\n \"closure_id\": \"eedtNa0bRfCffrd2lAryDw\",\n \"closure_name\": \"New Year\",\n \"closure_hour_type\": 1,\n \"start_time\": \"2023-01-01T00:00:00Z\",\n \"end_time\": \"2023-02-01T23:59:59Z\",\n \"recurring_frequency\": 0,\n \"recurring_frequency_type\": 1,\n \"recurring_month\": 1,\n \"recurring_week_interval\": 1,\n \"recurring_days_of_week\": [\n 1\n ]\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created closure set.","required":["closure_set_id","closure_set_name","timezone","account_default","modified_by","date_time_ms","closures"],"properties":{"closure_set_id":{"type":"string","description":"The closure's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is created, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is created, to the millisecond."},"closure_set_name":{"type":"string","description":"The closure set's name."},"closure_set_description":{"type":"string","description":"The closure set's description."},"timezone":{"type":"string","description":"The closure set's timezone ID."},"account_default":{"type":"boolean","description":"Default closure for the newly created queue."},"closures":{"description":"Information about the closures.","type":"array","items":{"required":["closure_id","closure_name"],"properties":{"closure_id":{"type":"string","description":"The closure's ID."},"closure_name":{"type":"string","description":"The closure's name."},"closure_hour_type":{"description":"The closure's time type. \n* 1 - All day. \n* 2 - Customized time.","enum":[1,2],"type":"integer"},"start_time":{"type":"string","format":"datetime","description":"The closure's start time."},"end_time":{"type":"string","format":"datetime","description":"The closure's end time."},"recurring_frequency":{"description":"The frequency of a closure's recurrence. \n* 0 - Never. \n* 1 - Annually. \n* 2 - Monthly. \n* 3 - Weekly.","enum":[0,1,2,3],"type":"integer"},"recurring_frequency_type":{"description":"The closure time's type of recurrence. Applies to Annually, Monthly, and Weekly repeat frequency. Returns only for the not Never recurrence type. \n* 1 - Specific. \n* 2 - Customized.","enum":[1,2],"type":"integer"},"recurring_month":{"description":"The recurrence month. Returns only for the Annually recurrence type. \n* 1 - January \n* 2 - February \n* 3 - March \n* 4 - April \n* 5 - May \n* 6 - June \n* 7 - July \n* 8 - August \n* 9 - September \n* 10 - October \n* 11 - November \n* 12 - December","type":"integer","enum":[1,2,3,4,5,6,7,8,9,10,11,12]},"recurring_week_interval":{"description":"The number of weekly recurrences. Returns only for the Customized recurrence time types. When the type is Annually/Customized or Monthly/Customized, the minimum value is 1 and the maximum value is 5. When it is Weekly/Customized, the minimum value is 1 and the maximum value is 12.","minimum":1,"maximum":12,"type":"integer"},"recurring_days_of_week":{"description":"The week days of a recurrence. Returns only for the Weekly/Customized, the Weekly/Specific, the Annually/Customized, and the Monthly/Customized recurrence time types. When the type is Weekly/Customized, there may be multiple values. \n* 1 - Monday \n* 2 - Tuesday \n* 3 - Wednesday \n* 4 - Thursday \n* 5 - Friday \n* 6 - Saturday \n* 7 - Sunday","type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6,7]}}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\",\n \"closure_set_name\": \"My Closure Set\",\n \"closure_set_description\": \"This is an example closure set.\",\n \"timezone\": \"America/New_York\",\n \"account_default\": true,\n \"closures\": [\n {\n \"closure_id\": \"eedtNa0bRfCffrd2lAryDw\",\n \"closure_name\": \"New Year\",\n \"closure_hour_type\": 1,\n \"start_time\": \"2023-01-01T00:00:00Z\",\n \"end_time\": \"2023-02-01T23:59:59Z\",\n \"recurring_frequency\": 0,\n \"recurring_frequency_type\": 1,\n \"recurring_month\": 1,\n \"recurring_week_interval\": 1,\n \"recurring_days_of_week\": [\n 1\n ]\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.task_canceled":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_canceled","requestBody":{"description":"# contact_center.task_canceled\n\nThe **Task canceled** event is triggered when a user cancels an assigned task.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Task canceled** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_canceled`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"canceled\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled task.","required":["task_id","engagement_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"flow_name":{"type":"string","description":"The flow name."},"channel_id":{"type":"string","description":"The task's channel ID."},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"]},"task_priority":{"type":"integer","minimum":0,"maximum":10,"description":"The task's priority, from 0 to 10. The greater the value, the higher the priority. The maximum value is 10."},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"task_status\": \"canceled\",\n \"flow_name\": \"My Flow\",\n \"channel_id\": \"ZTCBB294D00C3B3B7D6C74777FF24FA937B\",\n \"channel_name\": \"video\",\n \"task_priority\": 10,\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\"\n }\n }\n}"}}}}}}}},"contact_center.legacy_engagement_end_data_ready":{"post":{"tags":["contact_center"],"operationId":"contact_center.legacy_engagement_end_data_ready","requestBody":{"description":"# contact_center.legacy_engagement_end_data_ready\nThe **Legacy engagement end data ready** event is triggered when the report V1 data collected at engagement end is ready.\n\n If you need some specific engagement information, use the [**Get Engagement API**](/docs/api/contact-center/#tag/engagements/get/contact_center/engagements/{engagementId}) to retrieve the data.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Legacy Engagement End Data Ready** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_report:admin`\n\n**Event type**: `contact_center.legacy_engagement_end_data_ready`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement-end report V1 data.","required":["engagement_id","engagement_direction","channel","start_time","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging","email"]},"start_time":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement-end data is ready, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.legacy_engagement_end_data_ready\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"start_time\": \"2023-05-01T09:25:18.264Z\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement-end report V1 data.","required":["engagement_id","engagement_direction","channel","start_time","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging","email"]},"start_time":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement-end data is ready, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.legacy_engagement_end_data_ready\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"start_time\": \"2023-05-01T09:25:18.264Z\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_upgrade_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_upgrade_completed","requestBody":{"description":"# contact_center.engagement_upgrade_completed\nThe **Engagement Upgrade Completed** event is triggered when a Contact Center **voice** engagement being upgraded to video is completed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Engagement Upgrade Completed** subscription under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_upgrade_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel's type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement completed."},"flow_name":{"type":"string","description":"The flow name where the engagement completed."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed engagement upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel's type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement completed."},"flow_name":{"type":"string","description":"The flow name where the engagement completed."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement completed, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement completed, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.recording_started":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_started","requestBody":{"description":"# contact_center.recording_started\n\nThe **Recording started** event is triggered when an engagement's recording is started.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording started** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_started`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's started recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"date_time":{"type":"string","format":"date-time","description":"The recording's start time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's start time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's started recording.","required":["recording_id","engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"date_time":{"type":"string","format":"date-time","description":"The recording's start time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The recording's start time, to the millisecond."},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID, such as a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name, such as a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl111\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.consumer_messaging_opt_in":{"post":{"tags":["contact_center"],"operationId":"contact_center.consumer_messaging_opt_in","requestBody":{"description":"# contact_center.consumer_messaging_opt_in\nThe **Consumer messaging opt in** event is triggered when a consumer opts in to receiving messages from a Zoom Contact Center messaging channel.\n\nFor SMS, this event is triggered when:\n\n - The consumer sends a START keyword or a campaign-configured opt-in keyword in an SMS message.\n - The campaign is configured to automatically opt in consumers when they send an inbound SMS message.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Consumer messaging opt in** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_messaging:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:messaging:admin`\n\n**Event type**: `contact_center.consumer_messaging_opt_in`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the consumer opt-in event.","required":["date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement ID associated with the opt-in."},"sms":{"type":"object","description":"The SMS opt-in details.","properties":{"consumer_number":{"type":"string","description":"The consumer's phone number in E.164 format."},"contact_center_number":{"type":"string","description":"The Contact Center phone number in E.164 format."},"campaign_id":{"type":"string","description":"The 10DLC campaign ID. Returned only when the campaign is configured to apply opt-in and opt-out preferences to all phone numbers associated with the campaign."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The time of the opt-in event, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.consumer_messaging_opt_in\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"sms\": {\n \"consumer_number\": \"+12090001111\",\n \"contact_center_number\": \"+12090000000\",\n \"campaign_id\": \"C1TGZWS\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the consumer opt-in event.","required":["date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement ID associated with the opt-in."},"sms":{"type":"object","description":"The SMS opt-in details.","properties":{"consumer_number":{"type":"string","description":"The consumer's phone number in E.164 format."},"contact_center_number":{"type":"string","description":"The Contact Center phone number in E.164 format."},"campaign_id":{"type":"string","description":"The 10DLC campaign ID. Returned only when the campaign is configured to apply opt-in and opt-out preferences to all phone numbers associated with the campaign."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The time of the opt-in event, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.consumer_messaging_opt_in\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"sms\": {\n \"consumer_number\": \"+12090001111\",\n \"contact_center_number\": \"+12090000000\",\n \"campaign_id\": \"C1TGZWS\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\n}"}}}}}}}},"contact_center.closure_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.closure_deleted","requestBody":{"description":"# contact_center.closure_deleted\n\nThe **Closure deleted** event is triggered when the closure is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Closure deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:closure_hour:admin`\n\n**Event type**: `contact_center.closure_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted closure set.","required":["closure_set_id","modified_by","date_time_ms"],"properties":{"closure_set_id":{"type":"string","description":"The closure set's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted closure set.","required":["closure_set_id","modified_by","date_time_ms"],"properties":{"closure_set_id":{"type":"string","description":"The closure set's ID."},"modified_by":{"type":"string","description":"The ID of the user that last modified this data."},"date_time":{"type":"string","description":"The date and time when the closure is deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","description":"The date and time when the closure set is deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.closure_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"closure_set_id\": \"Ixo-Na0bRfCyQ4q2lAryDw\",\n \"modified_by\": \"a4sduuiQ7sdfrrtINNsepp\",\n \"date_time_ms\": \"2023-03-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_login":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_login","requestBody":{"description":"# contact_center.user_login\n\nThe **User login** event is triggered when a user logs in to Contact Center.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **User login** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_login`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user login.","required":["user_id","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_login/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user logged in to Contact Center, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user logged in to Contact Center, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_login\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user login.","required":["user_id","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_login/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user logged in to Contact Center, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user logged in to Contact Center, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_login\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_canceled":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_canceled","requestBody":{"description":"# contact_center.engagement_conference_canceled\nThe **Engagement conference canceled** event is triggered when an engagement conference is canceled.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement Conference Canceled** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_canceled`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement conference.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID"},"team_name":{"type":"string","description":"The team's name"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement conference was canceled, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+148087823321\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement conference.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID"},"team_name":{"type":"string","description":"The team's name"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement conference was canceled, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+148087823321\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\"\n }\n }\n}"}}}}}}}},"contact_center.user_skills_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_skills_assigned","requestBody":{"description":"# contact_center.user_skills_assigned\n\nThe **User skills assigned** event is triggered when skills are assigned to a user.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User skills assigned** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_skills_assigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the skills assigned to the user.","required":["user_id","user_email","role_id","role_name","display_name","skills","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_skills_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"skills":{"type":"array","description":"The skills assigned to the user.","items":{"type":"object","required":["skill_id"],"properties":{"skill_id":{"type":"string","description":"The skill's ID.","example":"s0pP7Z_AcR_6xUiAS2SLE1g"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the skills were assigned to the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_skills_assigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"skills\": [\n {\n \"skill_id\": \"s0pP7Z_AcR_6xUiAS2SLE1g\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the skills assigned to the user.","required":["user_id","user_email","role_id","role_name","display_name","skills","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_skills_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"skills":{"type":"array","description":"The skills assigned to the user.","items":{"type":"object","required":["skill_id"],"properties":{"skill_id":{"type":"string","description":"The skill's ID.","example":"s0pP7Z_AcR_6xUiAS2SLE1g"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the skills were assigned to the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_skills_assigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"skills\": [\n {\n \"skill_id\": \"s0pP7Z_AcR_6xUiAS2SLE1g\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_sent_file":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_sent_file","requestBody":{"description":"# contact_center.engagement_user_sent_file\n\nThe **Engagement user sent file** event is triggered when a user sends files.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement user sent file** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_sent_file`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-sent files in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","files"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_chat - Only applies to the messaging channel. \n* web_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel.\n* whatsapp - Only applies to the messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_sent_file/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"files":{"description":"The file details.","type":"array","items":{"required":["file_id","file_name","file_size","file_type","download_url"],"properties":{"file_id":{"type":"string","description":"The file's unique ID."},"file_name":{"type":"string","description":"The file's name."},"file_size":{"type":"integer","format":"int64","description":"The file's size."},"file_type":{"type":"string","description":"The file's type.","enum":["Image","Audio","Video","File","Link"]},"download_url":{"type":"string","description":"Attachment download link."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_sent_file\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"files\": [\n {\n \"file_id\": \"Chh7WtzyTaa-PIvsSpfwmA\",\n \"file_name\": \"My Image\",\n \"file_size\": 1796,\n \"file_type\": \"Image\",\n \"download_url\": \"https://www.zoom.us/v2/contact_center/attachments/0AYFv9ePSsmPUSJYHorUWQ/download?type=messaging_attachment\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-sent files in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","files"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_chat - Only applies to the messaging channel. \n* web_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel.\n* whatsapp - Only applies to the messaging channel.","enum":["web_chat","sms","facebook_messenger","whatsapp","in_app_chat"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_sent_file/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"files":{"description":"The file details.","type":"array","items":{"required":["file_id","file_name","file_size","file_type","download_url"],"properties":{"file_id":{"type":"string","description":"The file's unique ID."},"file_name":{"type":"string","description":"The file's name."},"file_size":{"type":"integer","format":"int64","description":"The file's size."},"file_type":{"type":"string","description":"The file's type.","enum":["Image","Audio","Video","File","Link"]},"download_url":{"type":"string","description":"Attachment download link."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_sent_file\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"files\": [\n {\n \"file_id\": \"Chh7WtzyTaa-PIvsSpfwmA\",\n \"file_name\": \"My Image\",\n \"file_size\": 1796,\n \"file_type\": \"Image\",\n \"download_url\": \"https://www.zoom.us/v2/contact_center/attachments/0AYFv9ePSsmPUSJYHorUWQ/download?type=messaging_attachment\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_consumer_answered":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_consumer_answered","requestBody":{"description":"# contact_center.engagement_consumer_answered\n\nThe **Engagement consumer answered** event is triggered when the consumer answers a voice or video engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement consumer answered** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_consumer_answered`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the engagement consumer answered.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's answer time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's answer time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_answered/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_answered\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"description":"Information about the engagement consumer answered.","properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The consumer's answer time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The consumer's answer time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_consumer_answered/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_consumer_answered\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550101\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_ended":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_ended","requestBody":{"description":"# contact_center.engagement_ended\nThe **Engagement ended** event is triggered when the engagement is ended.\n\nAn engagement is available via the [Get Engagement API](/docs/api/contact-center/#tag/engagements/get/contact_center/engagements/{engagementId}) once is completed processing, not immediately when is has ended. This API may return an empty response while the data is persisting.\n\nYou may need to retry this request for up to 1 minute to get engagement details, if querying shortly after an `engagement_ended webhook` event is received. Consider using a backoff between retries to avoid rate limiting.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement ended** subscription enabled under the **Contact Center** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_ended`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement ended.","required":["engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","whatsapp","facebook_messenger","sms"]},"flow_id":{"type":"string","description":"The flow ID where the engagement ended."},"flow_name":{"type":"string","description":"The flow name where the engagement ended."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement ended.","required":["engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","whatsapp","facebook_messenger","sms"]},"flow_id":{"type":"string","description":"The flow ID where the engagement ended."},"flow_name":{"type":"string","description":"The flow name where the engagement ended."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_opt_in":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_opt_in","requestBody":{"description":"# contact_center.user_opt_in\n\nThe **User opt in** event is triggered when a user opts in to a queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **User opt in** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_opt_in`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user queue opt-in.","required":["user_id","display_name","cc_queue_id","queue_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The queue's name."},"teams":{"$ref":"#/paths/contact_center.user_opt_in/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user opted in to a queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user opted in to a queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_opt_in\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user queue opt-in.","required":["user_id","display_name","cc_queue_id","queue_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The queue's name."},"teams":{"$ref":"#/paths/contact_center.user_opt_in/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user opted in to a queue, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user opted in to a queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_opt_in\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_timeout":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_timeout","requestBody":{"description":"# contact_center.engagement_transfer_timeout\n\nThe **Engagement transfer timeout** event is triggered when an engagement transfer times out.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer timeout** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_timeout`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement transfer timeout.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer's level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer's type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_timeout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer timed out, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer timed out, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"John Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement transfer timeout.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer's level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer's type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_timeout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer timed out, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer timed out, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Smith\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"John Doe\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.recording_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_completed","requestBody":{"description":"# contact_center.recording_completed\n\nThe **Recording completed** event is triggered when an engagement's recording is completed.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording completed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's recording completed.","required":["recording_id","engagement_id","engagement_direction","channel","users"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"recording_end_time":{"description":"The recording's end time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_end_time_ms":{"description":"The recording's end time, to the millisecond.","format":"date-time","type":"string"},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"recording_duration":{"type":"integer","description":"The recording's duration, to the second."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID - either a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name - either a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"recording_end_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"recording_duration\": 150,\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's recording completed.","required":["recording_id","engagement_id","engagement_direction","channel","users"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice \n* video","enum":["voice","video"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"recording_start_time":{"description":"The recording's start time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_start_time_ms":{"description":"The recording's start time, to the millisecond.","format":"date-time","type":"string"},"recording_end_time":{"description":"The recording's end time, to the second.","format":"date-time","type":"string","deprecated":true},"recording_end_time_ms":{"description":"The recording's end time, to the millisecond.","format":"date-time","type":"string"},"recording_type":{"type":"string","description":"The recording's type. \n* on_demand - Manually trigger recording. \n* automatic - Automatically trigger recording.","enum":["on_demand","automatic"]},"recording_duration":{"type":"integer","description":"The recording's duration, to the second."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The user's ID.","deprecated":true},"user_display_name":{"type":"string","description":"The user's display name.","deprecated":true},"consumer_id":{"type":"string","description":"The consumer's ID.","deprecated":true},"consumer_number":{"type":"string","description":"The consumer's phone number.","deprecated":true},"consumer_display_name":{"type":"string","description":"The consumer's display name.","deprecated":true},"owner_id":{"type":"string","description":"The recording's owner ID - either a queue ID or user ID."},"owner_name":{"type":"string","description":"The recording's owner name - either a queue name or user name."},"owner_type":{"type":"string","description":"The recording's owner type. \n* user - This recording belongs to a user. \n* queue - This recording belongs to a queue.","enum":["user","queue"]},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.recording_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"recording_start_time_ms\": \"2022-02-15T08:12:15.986Z\",\n \"recording_end_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"recording_type\": \"on_demand\",\n \"recording_duration\": 150,\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"owner_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"owner_name\": \"John Smith\",\n \"owner_type\": \"user\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Doe\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_accepted":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_accepted","requestBody":{"description":"# contact_center.engagement_transfer_accepted\n\nThe **Engagement transfer accepted** event is triggered when an engagement transfer is accepted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer accepted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_accepted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the accepted engagement transfer.","required":["task_id","date_time_ms","user_id","user_display_name","channel","engagement_direction","engagement_id","transfer_to_task_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_accepted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is accepted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is accepted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_accepted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"BtRE_dgERLyAJHYYL5MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"John Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the accepted engagement transfer.","required":["task_id","date_time_ms","user_id","user_display_name","channel","engagement_direction","engagement_id","transfer_to_task_id"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_accepted/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is accepted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is accepted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_accepted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"BtRE_dgERLyAJHYYL5MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"John Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.team_moved":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_moved","requestBody":{"description":"# contact_center.team_moved\nThe **Team moved** event is triggered when a team is moved to another parent team.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team moved** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:write:admin`,`contact_center_team:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin`\n\n**Event type**: `contact_center.team_moved`\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 timestamp when the event occurred.","example":1754387110151},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","new_parent_team_id","new_parent_team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Example Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is a example team."},"previous_parent_team_id":{"type":"string","description":"The team's previous parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"previous_parent_team_name":{"type":"string","description":"The team's previous parent team name.","example":"Previous Parent Example Team"},"new_parent_team_id":{"type":"string","description":"The team's new parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"new_parent_team_name":{"type":"string","description":"The team's new parent team name.","example":"Parent Example Team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was moved, to the millisecond.","example":"2025-09-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_moved\",\n \"event_ts\": 1754387110151,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Example Team\",\n \"team_description\": \"This is a example team.\",\n \"previous_parent_team_id\": \"thxZtEzfR4uq0L9RqVJ_bg\",\n \"previous_parent_team_name\": \"Previous Example Team\",\n \"new_parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"new_parent_team_name\": \"Parent Example Team\",\n \"date_time_ms\": \"2025-09-15T09:27:15.988Z\"\n }\n }\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 timestamp when the event occurred.","example":1754387110151},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","new_parent_team_id","new_parent_team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Example Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is a example team."},"previous_parent_team_id":{"type":"string","description":"The team's previous parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"previous_parent_team_name":{"type":"string","description":"The team's previous parent team name.","example":"Previous Parent Example Team"},"new_parent_team_id":{"type":"string","description":"The team's new parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"new_parent_team_name":{"type":"string","description":"The team's new parent team name.","example":"Parent Example Team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was moved, to the millisecond.","example":"2025-09-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_moved\",\n \"event_ts\": 1754387110151,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Example Team\",\n \"team_description\": \"This is a example team.\",\n \"previous_parent_team_id\": \"thxZtEzfR4uq0L9RqVJ_bg\",\n \"previous_parent_team_name\": \"Previous Example Team\",\n \"new_parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"new_parent_team_name\": \"Parent Example Team\",\n \"date_time_ms\": \"2025-09-15T09:27:15.988Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_created","requestBody":{"description":"# contact_center.user_created\n\nThe **User created** event is triggered when a user is created.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User created** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created user.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"status_id":{"type":"string","description":"The user's status ID."},"status_name":{"type":"string","description":"The user's status name.","enum":["Offline","Ready","Not Ready","Occupied"]},"client_integration":{"type":"string","description":"The contact center's client integration. \n* Default \n* Salesforce \n* Zendesk \n* ServiceNow \n* Microsoft_Dynamics_365","enum":["Default","Salesforce","Zendesk","ServiceNow","Microsoft_Dynamics_365"]},"user_access":{"type":"string","description":"The user's access status. \n* active - The user's role permissions allow them to access the Contact Center. \n* inactive - The user cannot access the Contact Center.","enum":["active","inactive"]},"country_iso_code":{"type":"string","description":"The [ISO country code](/docs/api/references/abbreviations/#countries)."},"channel_settings":{"type":"object","description":"Information about the channel settings.","properties":{"multi_channel_engagements":{"type":"object","description":"Information about the setting's multi-channel engagements.","properties":{"enable":{"type":"boolean","description":"Whether to allow users to receive voice or video engagements while handling chat and SMS engagements based on the max_agent_load value."},"max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, the maximum load percentage an user needs to undertake in order to receive voice and video calls. This value is based on the engagements the user is currently handling."},"email_max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this is the maximum load percentage that a user needs to take in order to receive voice and video calls. This value is based on the engagements the user is currently handling."}}},"concurrent_message_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent messaging conversations that can be assigned to a user."},"concurrent_email_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent email conversations that can be assigned to a user."},"messaging_occupied":{"type":"boolean","description":"Mark the user's status as Occupied if they lack capacity for an additional active messaging engagement."},"email_occupied":{"type":"boolean","description":"Mark the user's status as Occupied if they lack capacity for an additional active email engagement."}}},"emergency_calling":{"type":"boolean","description":"Allow users to contact emergency services through their device's native phone system or Zoom Phone."},"user_intents":{"type":"array","description":"The user's intents.","items":{"type":"object","properties":{"intent_group_id":{"type":"string","description":"The intent's group ID.","example":"Ql3qxUWXSHes4PmcOmzyOg"},"intent_id":{"type":"string","description":"The intent's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"user_package":{"type":"object","description":"The user's Contact Center plan.","properties":{"package_name":{"type":"string","description":"The Contact Center plan's name.","enum":["essentials","premium","elite"]}}},"user_add_ons_plans":{"type":"array","description":"The user's Contact Center add-ons plan.","items":{"type":"object","properties":{"add_ons_plan_name":{"type":"string","description":"The Contact Center add-ons plan's name.","enum":["ai_expert_assist","zoom_contact_center_for_service_cloud_voice"]}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was created, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was created, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"client_integration\": \"Salesforce\",\n \"status_id\": \"2\",\n \"status_name\": \"Not Ready\",\n \"user_access\": \"active\",\n \"country_iso_code\": \"US\",\n \"channel_settings\": {\n \"multi_channel_engagements\": {\n \"enable\": true,\n \"max_agent_load\": 50,\n \"email_max_agent_load\": 50\n },\n \"concurrent_message_capacity\": 4,\n \"concurrent_email_capacity\": 20,\n \"messaging_occupied\": true,\n \"email_occupied\": true\n },\n \"emergency_calling\": true,\n \"user_intents\": [\n {\n \"intent_id\": \"OlK7lczzT_e7h6p1Q6wGdg\",\n \"intent_group_id\": \"Ql3qxUWXSHes4PmcOmzyOg\"\n }\n ],\n \"user_package\": {\n \"package_name\": \"essentials\"\n },\n \"user_add_ons_plans\": [\n {\n \"add_ons_plan_name\": \"ai_expert_assist\"\n }\n ],\n \"date_time_ms\": \"2023-03-01T00:00:00.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created user.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"status_id":{"type":"string","description":"The user's status ID."},"status_name":{"type":"string","description":"The user's status name.","enum":["Offline","Ready","Not Ready","Occupied"]},"client_integration":{"type":"string","description":"The contact center's client integration. \n* Default \n* Salesforce \n* Zendesk \n* ServiceNow \n* Microsoft_Dynamics_365","enum":["Default","Salesforce","Zendesk","ServiceNow","Microsoft_Dynamics_365"]},"user_access":{"type":"string","description":"The user's access status. \n* active - The user's role permissions allow them to access the Contact Center. \n* inactive - The user cannot access the Contact Center.","enum":["active","inactive"]},"country_iso_code":{"type":"string","description":"The [ISO country code](/docs/api/references/abbreviations/#countries)."},"channel_settings":{"type":"object","description":"Information about the channel settings.","properties":{"multi_channel_engagements":{"type":"object","description":"Information about the setting's multi-channel engagements.","properties":{"enable":{"type":"boolean","description":"Whether to allow users to receive voice or video engagements while handling chat and SMS engagements based on the max_agent_load value."},"max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, the maximum load percentage an user needs to undertake in order to receive voice and video calls. This value is based on the engagements the user is currently handling."},"email_max_agent_load":{"type":"integer","minimum":1,"maximum":100,"description":"If the multi_channel_engagements value is true, this is the maximum load percentage that a user needs to take in order to receive voice and video calls. This value is based on the engagements the user is currently handling."}}},"concurrent_message_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent messaging conversations that can be assigned to a user."},"concurrent_email_capacity":{"type":"integer","minimum":0,"maximum":20,"description":"The maximum number of concurrent email conversations that can be assigned to a user."},"messaging_occupied":{"type":"boolean","description":"Mark the user's status as Occupied if they lack capacity for an additional active messaging engagement."},"email_occupied":{"type":"boolean","description":"Mark the user's status as Occupied if they lack capacity for an additional active email engagement."}}},"emergency_calling":{"type":"boolean","description":"Allow users to contact emergency services through their device's native phone system or Zoom Phone."},"user_intents":{"type":"array","description":"The user's intents.","items":{"type":"object","properties":{"intent_group_id":{"type":"string","description":"The intent's group ID.","example":"Ql3qxUWXSHes4PmcOmzyOg"},"intent_id":{"type":"string","description":"The intent's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"user_package":{"type":"object","description":"The user's Contact Center plan.","properties":{"package_name":{"type":"string","description":"The Contact Center plan's name.","enum":["essentials","premium","elite"]}}},"user_add_ons_plans":{"type":"array","description":"The user's Contact Center add-ons plan.","items":{"type":"object","properties":{"add_ons_plan_name":{"type":"string","description":"The Contact Center add-ons plan's name.","enum":["ai_expert_assist","zoom_contact_center_for_service_cloud_voice"]}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user was created, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user was created, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"client_integration\": \"Salesforce\",\n \"status_id\": \"2\",\n \"status_name\": \"Not Ready\",\n \"user_access\": \"active\",\n \"country_iso_code\": \"US\",\n \"channel_settings\": {\n \"multi_channel_engagements\": {\n \"enable\": true,\n \"max_agent_load\": 50,\n \"email_max_agent_load\": 50\n },\n \"concurrent_message_capacity\": 4,\n \"concurrent_email_capacity\": 20,\n \"messaging_occupied\": true,\n \"email_occupied\": true\n },\n \"emergency_calling\": true,\n \"user_intents\": [\n {\n \"intent_id\": \"OlK7lczzT_e7h6p1Q6wGdg\",\n \"intent_group_id\": \"Ql3qxUWXSHes4PmcOmzyOg\"\n }\n ],\n \"user_package\": {\n \"package_name\": \"essentials\"\n },\n \"user_add_ons_plans\": [\n {\n \"add_ons_plan_name\": \"ai_expert_assist\"\n }\n ],\n \"date_time_ms\": \"2023-03-01T00:00:00.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_assigned","requestBody":{"description":"# contact_center.inbox_message_assigned\nThe **Inbox message assigned** event is triggered when an agent or supervisor assigns a voicemail to a user, either themself or someone else.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message assigned** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_assigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the inbox message assigned.","required":["inbox_id","inbox_name","message_id","assign_type","user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"previous_user_id":{"type":"string","description":"The message previously assigned to a user's ID."},"previous_user_display_name":{"type":"string","description":"The message previously assigned to a user's display name."},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"assign_type":{"type":"string","description":"The message's assign type.","enum":["Manual","Auto Assign"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was assigned, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550101\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"previous_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxk\",\n \"previous_user_display_name\": \"Jane Doe\",\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"assign_type\": \"Manual\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the inbox message assigned.","required":["inbox_id","inbox_name","message_id","assign_type","user_id","user_display_name","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_assigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"previous_user_id":{"type":"string","description":"The message previously assigned to a user's ID."},"previous_user_display_name":{"type":"string","description":"The message previously assigned to a user's display name."},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"assign_type":{"type":"string","description":"The message's assign type.","enum":["Manual","Auto Assign"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was assigned, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550101\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"previous_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxk\",\n \"previous_user_display_name\": \"Jane Doe\",\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"assign_type\": \"Manual\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_entered_queue":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_entered_queue","requestBody":{"description":"# contact_center.task_entered_queue\n\nThe **Task entered queue** event is triggered when a task enters the task queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**\n * The **Task entered queue** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_entered_queue`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task that entered the queue.","required":["task_id","cc_queue_id","engagement_id","date_time_ms"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"task_id":{"type":"string","description":"The task's ID."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","in_app_chat"]},"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_entered_queue/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Use this option to distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"The distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"engagement_id":{"type":"string","description":"The engagement's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The time the task entered the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_entered_queue\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"queue_description\": \"This is an exmaple queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task that entered the queue.","required":["task_id","cc_queue_id","engagement_id","date_time_ms"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"task_id":{"type":"string","description":"The task's ID."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","in_app_chat"]},"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_entered_queue/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Use this option to distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"The distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"engagement_id":{"type":"string","description":"The engagement's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The time the task entered the queue, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_entered_queue\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"queue_description\": \"This is an exmaple queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.asset_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.asset_deleted","requestBody":{"description":"# contact_center.asset_deleted\n\nThe **Asset deleted** event is triggered when the asset is deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Asset deleted** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin`\n\n**Event type**: `contact_center.asset_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted asset.","required":["asset_id","asset_name","archived","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"asset_name":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"archived":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/Archived-Contact Center"},"archived_time":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/ArchivedTime-Contact Center"},"modified_by":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"ArchivedTime-Contact Center":{"type":"string","description":"The date and time when this data was archived.","format":"date-time"},"Archived-Contact Center":{"type":"boolean","description":"Is the asset archived? After archiving, it won't be deleted immediately, but will be automatically deleted after a period of time. During this time, you can restore it."},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is deleted, to the millisecond.","format":"date-time"}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"asset_name\": \"My Asset\",\n \"archived\": true,\n \"archived_time\": \"2025-06-26T09:27:15Z\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the deleted asset.","required":["asset_id","asset_name","archived","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"asset_name":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"archived":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/Archived-Contact Center"},"archived_time":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/ArchivedTime-Contact Center"},"modified_by":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_deleted/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"ArchivedTime-Contact Center":{"type":"string","description":"The date and time when this data was archived.","format":"date-time"},"Archived-Contact Center":{"type":"boolean","description":"Is the asset archived? After archiving, it won't be deleted immediately, but will be automatically deleted after a period of time. During this time, you can restore it."},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is deleted, to the millisecond.","format":"date-time"}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"asset_name\": \"My Asset\",\n \"archived\": true,\n \"archived_time\": \"2025-06-26T09:27:15Z\",\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.team_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_created","requestBody":{"description":"# contact_center.team_created\nThe **Team created** event is triggered when a new team is created.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team created** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin`,`contact_center_team:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team:admin`\n\n**Event type**: `contact_center.team_created`\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the sales team"},"parent_team_id":{"type":"string","description":"The team's parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"parent_team_name":{"type":"string","description":"The team's parent team name.","example":"Online sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was created.","example":"2025-02-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Sales Team\",\n \"team_description\": \"This is the sales team\",\n \"parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"parent_team_name\": \"Online sales team\",\n \"date_time_ms\": \"2025-02-15T09:27:15.988Z\"\n }\n }\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the team.","required":["team_id","team_name","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"team_name":{"type":"string","description":"The team's name.","example":"Sales Team"},"team_description":{"type":"string","description":"The team's description.","example":"This is the sales team"},"parent_team_id":{"type":"string","description":"The team's parent team ID.","example":"PZy04MG_Q7Gytg9k7CVU6w"},"parent_team_name":{"type":"string","description":"The team's parent team name.","example":"Online sales team"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the team was created.","example":"2025-02-15T09:27:15.988Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"team_name\": \"Sales Team\",\n \"team_description\": \"This is the sales team\",\n \"parent_team_id\": \"PZy04MG_Q7Gytg9k7CVU6w\",\n \"parent_team_name\": \"Online sales team\",\n \"date_time_ms\": \"2025-02-15T09:27:15.988Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_started":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_started","requestBody":{"description":"# contact_center.engagement_started\nThe **Engagement started** event is triggered when the engagement is started.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement started** subscription enabled under the **Contact Center** event.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_started:admin`\n\n**Event type**: `contact_center.engagement_started`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement started.","required":["engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_type":{"type":"string","description":"The engagement's channel type. \n* chat \n* in_app_chat \n* voice \n* video \n* sms \n* messaging","enum":["chat","in_app_chat","voice","video","sms","messaging"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"date_time":{"type":"string","format":"date-time","description":"The date and time the engagement started, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"transfer_from":{"type":"string","description":"The name of the other Zoom product if the engagement is transferred from another Zoom product to Contact Center. Currently only supports transfer from Zoom Phone for voice channel.","enum":["zoom_phone"]},"transfer_from_id":{"type":"string","description":"The unique session identifier of another Zoom product, such as a Zoom Phone call ID, if the engagement is transferred from another Zoom product to Contact Center. Currently only supports transfer from Zoom Phone for voice channel."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"transfer_from\": \"zoom_phone\",\n \"transfer_from_id\": \"7396294160320498337\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement started.","required":["engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_type":{"type":"string","description":"The engagement's channel type. \n* chat \n* in_app_chat \n* voice \n* video \n* sms \n* messaging","enum":["chat","in_app_chat","voice","video","sms","messaging"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"date_time":{"type":"string","format":"date-time","description":"The date and time the engagement started, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement started, to the millisecond."},"transfer_from":{"type":"string","description":"The name of the other Zoom product if the engagement is transferred from another Zoom product to Contact Center. Currently only supports transfer from Zoom Phone for voice channel.","enum":["zoom_phone"]},"transfer_from_id":{"type":"string","description":"The unique session identifier of another Zoom product, such as a Zoom Phone call ID, if the engagement is transferred from another Zoom product to Contact Center. Currently only supports transfer from Zoom Phone for voice channel."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"transfer_from\": \"zoom_phone\",\n \"transfer_from_id\": \"7396294160320498337\",\n \"date_time_ms\": \"2023-05-01T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_reserved":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_reserved","requestBody":{"description":"# contact_center.engagement_transfer_reserved\n\nThe **Engagement transfer reserved** event is triggered when an engagement transfer is reserved.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer reserved** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_reserved`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the reserved engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer's level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer's type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_reserved/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is reserved, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is reserved, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_reserved\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the reserved engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer's level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer's type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_reserved/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is reserved, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is reserved, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_reserved\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_upgrade_initiated":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_upgrade_initiated","requestBody":{"description":"# contact_center.engagement_upgrade_initiated\nThe **Engagement Upgrade Initiated** event is triggered when a Contact Center **voice** engagement is upgraded to video.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Engagement Upgrade Initiated** subscription under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_upgrade_initiated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the initiated engagement upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement initiated."},"flow_name":{"type":"string","description":"The flow name where the engagement initiated."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_initiated/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement upgrade was initiated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement upgrade was initiated, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_initiated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the initiated engagement upgrade.","required":["engagement_id","engagement_direction","channel","users","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms"]},"upgrade_to_channel":{"type":"string","description":"The upgraded channel type.","enum":["video"]},"upgrade_to_channel_source":{"type":"string","description":"The upgraded channel's source.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The flow ID where the engagement initiated."},"flow_name":{"type":"string","description":"The flow name where the engagement initiated."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"users":{"type":"array","description":"Information about the users.","items":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_upgrade_initiated/post/requestBody/content/application~1json/schema/components/schemas/Teams"}}}},"consumers":{"type":"array","description":"Information about the consumers.","items":{"type":"object","required":[],"properties":{"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."}}}},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement upgrade was initiated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement upgrade was initiated, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_upgrade_initiated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"upgrade_to_channel\": \"video\",\n \"upgrade_to_channel_source\": \"in_app_video\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"users\": [\n {\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n ],\n \"consumers\": [\n {\n \"consumer_id\": \"sFvHUPCcWSby7tIyEc6QMZg\",\n \"consumer_number\": \"+18005550100\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.asset_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.asset_updated","requestBody":{"description":"# contact_center.asset_updated\n\nThe **Asset updated** event is triggered when an asset is updated. This includes any changes to asset items contained within the asset such as adding, updating, and deleting asset items.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Asset updated** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_asset_library:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:asset_library:admin`\n\n**Event type**: `contact_center.asset_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the asset.","required":["asset_id","updates","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"updates":{"type":"object","description":"Information about the updated asset.","properties":{"asset_name":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"asset_description":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetDescription-Contact Center"},"asset_item_added":{"description":"A list of the added asset's items. This displays when the asset item is added.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsAdded-Contact Center"},"asset_item_updated":{"description":"A list of the updated asset's items. This displays when the asset item is updated.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsUpdated-Contact Center"},"asset_item_deleted":{"description":"A list of the deleted asset's items. This displays when the asset item is deleted.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsDeleted-Contact Center"},"category_id":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/CategoryId-Contact Center"},"restore":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/Restore-Contact Center"}}},"modified_by":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"AssetDescription-Contact Center":{"type":"string","description":"The asset's description."},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is updated, to the millisecond.","format":"date-time"},"AssetItemsAdded-Contact Center":{"type":"array","description":"A list of the added asset's items. This displays when the asset item is added.","items":{"type":"object","required":["asset_item_id","asset_item_language","is_default"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies when the asset_type is one of image, audio, video, or slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"AssetItemsUpdated-Contact Center":{"type":"array","description":"A list of the updated asset's items. This displays when the asset item is updated.","items":{"type":"object","required":["asset_item_id"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies when the asset_type is one of these: image, audio, video, or slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"AssetItemsDeleted-Contact Center":{"type":"array","description":"A list of the deleted asset's items. This displays when the asset item is deleted.","items":{"type":"object","required":["asset_item_id"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."}}}},"CategoryId-Contact Center":{"type":"string","description":"The asset category's ID."},"Restore-Contact Center":{"type":"boolean","description":"Whether this asset is restored."}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"updates\": {\n \"asset_name\": \"My Asset\",\n \"asset_description\": \"This is an exmaple asset.\",\n \"asset_item_added\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Added\",\n \"asset_item_language\": \"en-US\",\n \"is_default\": true,\n \"asset_item_file_url\": \"https://file.zoom.us/xxxx\",\n \"asset_item_content\": \"My Asset Item Content Added\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"asset_item_updated\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Updated\",\n \"asset_item_language\": \"es-ES\",\n \"is_default\": false,\n \"asset_item_file_url\": \"https://file.zoom.us/xxxx\",\n \"asset_item_content\": \"My Asset Item Content Updated\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"asset_item_deleted\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Deleted\"\n }\n ],\n \"category_id\": \"bnGEj1yrRb6qlNMvyMK08g\",\n \"restore\": true\n },\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the asset.","required":["asset_id","updates","modified_by","date_time_ms"],"properties":{"asset_id":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetId-Contact Center"},"updates":{"type":"object","description":"Information about the updated asset.","properties":{"asset_name":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetName-Contact Center"},"asset_description":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetDescription-Contact Center"},"asset_item_added":{"description":"A list of the added asset's items. This displays when the asset item is added.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsAdded-Contact Center"},"asset_item_updated":{"description":"A list of the updated asset's items. This displays when the asset item is updated.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsUpdated-Contact Center"},"asset_item_deleted":{"description":"A list of the deleted asset's items. This displays when the asset item is deleted.","$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/AssetItemsDeleted-Contact Center"},"category_id":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/CategoryId-Contact Center"},"restore":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/Restore-Contact Center"}}},"modified_by":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/ModifiedBy-Contact Center"},"date_time_ms":{"$ref":"#/paths/contact_center.asset_updated/post/requestBody/content/application~1json/schema/components/schemas/DateTimeMs-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"AssetId-Contact Center":{"type":"string","description":"The asset's ID."},"AssetName-Contact Center":{"type":"string","description":"The asset's name."},"AssetDescription-Contact Center":{"type":"string","description":"The asset's description."},"ModifiedBy-Contact Center":{"type":"string","description":"The ID of the user that last modified this data."},"DateTimeMs-Contact Center":{"type":"string","description":"The date and time when the asset is updated, to the millisecond.","format":"date-time"},"AssetItemsAdded-Contact Center":{"type":"array","description":"A list of the added asset's items. This displays when the asset item is added.","items":{"type":"object","required":["asset_item_id","asset_item_language","is_default"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies when the asset_type is one of image, audio, video, or slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"AssetItemsUpdated-Contact Center":{"type":"array","description":"A list of the updated asset's items. This displays when the asset item is updated.","items":{"type":"object","required":["asset_item_id"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."},"asset_item_language":{"type":"string","description":"The asset item's language code.","enum":["zh-CN","zh-TW","yue-CN","cmn-CN","da-DK","nl-NL","en-AU","en-NZ","en-GB","en-US","fr-CA","fr-FR","de-DE","it-IT","ja-JP","ko-KR","pl-PL","pt-BR","pt-PT","ro-RO","ru-RU","es-ES","es-MX","es-US","sv-SE","tr-TR"]},"is_default":{"type":"boolean","description":"Whether this item is the asset's default. Each asset can only have one isDefault set to true."},"asset_item_file_url":{"type":"string","description":"The asset item's file URL. \nThis data only applies when the asset_type is one of these: image, audio, video, or slides."},"asset_item_content":{"type":"string","description":"The asset item's content.\nThis data only applies to asset_types text and saved_reply."},"asset_item_voice":{"type":"string","description":"The asset item's text-to-speech voice. It only applies to the audio type.\n\nNot every language supports TTS, and each language has a different voice.\n\n| asset_item_language | asset_item_voice |\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| yue-CN | Hiujin |\n| cmn-CN | Zhiyu |\n| da-DK | Naja
Sofie
Mads |\n| nl-NL | Laura
Ruben
Lotte |\n| en-US | Joanna
Stephen
Kimberly
Matthew
Danielle
Gregory
Kevin
Salli
Kendra
Justin
Joey
Ivy
Ruth |\n| en-GB | Emma
Brian
Amy
Arthur |\n| en-AU | Olivia
Russell
Nicole |\n| en-NZ | Aria |\n| fr-FR | Celine
Lea
Remi
Mathieu |\n| fr-CA | Gabrielle
Liam
Chantal |\n| de-DE | Daniel
Vicki
Marlene
Hans |\n| it-IT | Adriano
Bianca
Giorgio
Carla |\n| ja-JP | Takumi
Kazuha
Tomoko
Mizuki |\n| ko-KR | Seoyeon |\n| pl-PL | Ola
Maja
Jan
Jacek
Ewa |\n| pt-PT | Ines
Cristiano |\n| pt-BR | Camila
Thiago
Vitoria
Ricardo |\n| ro-RO | Carmen |\n| ru-RU | Maxim
Tatyana |\n| es-US | Lupe
Pedro
Penelope
Miguel |\n| es-MX | Mia
Andres |\n| es-ES | Lucia
Sergio
Enrique
Conchita |\n| sv-SE | Elin
Astrid |\n| tr-TR | Filiz
Burcu |\n"}}}},"AssetItemsDeleted-Contact Center":{"type":"array","description":"A list of the deleted asset's items. This displays when the asset item is deleted.","items":{"type":"object","required":["asset_item_id"],"properties":{"asset_item_id":{"type":"string","description":"The asset item's ID."},"asset_item_name":{"type":"string","description":"The asset item's name."}}}},"CategoryId-Contact Center":{"type":"string","description":"The asset category's ID."},"Restore-Contact Center":{"type":"boolean","description":"Whether this asset is restored."}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.asset_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"asset_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"updates\": {\n \"asset_name\": \"My Asset\",\n \"asset_description\": \"This is an exmaple asset.\",\n \"asset_item_added\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Added\",\n \"asset_item_language\": \"en-US\",\n \"is_default\": true,\n \"asset_item_file_url\": \"https://file.zoom.us/xxxx\",\n \"asset_item_content\": \"My Asset Item Content Added\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"asset_item_updated\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Updated\",\n \"asset_item_language\": \"es-ES\",\n \"is_default\": false,\n \"asset_item_file_url\": \"https://file.zoom.us/xxxx\",\n \"asset_item_content\": \"My Asset Item Content Updated\",\n \"asset_item_voice\": \"Joanna\"\n }\n ],\n \"asset_item_deleted\": [\n {\n \"asset_item_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"asset_item_name\": \"My Asset Item Deleted\"\n }\n ],\n \"category_id\": \"bnGEj1yrRb6qlNMvyMK08g\",\n \"restore\": true\n },\n \"modified_by\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_sent_message":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_sent_message","requestBody":{"description":"# contact_center.engagement_user_sent_message\n\nThe **Engagement user sent message** event is triggered when a user sends a message.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement user sent message** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_sent_message`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-sent message in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","message_text"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_chat - Only applies to the messaging channel. \n* web_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel.\n* whatsapp - Only applies to the messaging channel.","enum":["in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_sent_message/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"message_text":{"type":"string","description":"The message's content."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_sent_message\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"message_text\": \"How can I help you?\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-sent message in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name","message_text"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["messaging"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_chat - Only applies to the messaging channel. \n* web_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel.\n* whatsapp - Only applies to the messaging channel.","enum":["in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_sent_message/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"message_text":{"type":"string","description":"The message's content."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_sent_message\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"messaging\",\n \"channel_source\": \"sms\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\",\n \"message_text\": \"How can I help you?\"\n }\n }\n}"}}}}}}}},"contact_center.task_exited_queue":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_exited_queue","requestBody":{"description":"# contact_center.task_exited_queue\n\nThe **Task exited queue** event is triggered when a task moves from one task queue to another task queue.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**\n * The **Task exited queue** subscription enabled under the **Contact Center** event\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_exited_queue`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task that exited the queue.","required":["task_id","channel","cc_queue_id","engagement_id","date_time_ms"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"task_id":{"type":"string","description":"The task's ID."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","in_app_chat"]},"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to the video channel. \n* kiosk_video - Only applies to the video channel. \n* web_video - Only applies to the video channel. \n* web_chat - Only applies to the messaging channel. \n* in_app_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel. \n* whatsapp - Only applies to the messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_exited_queue/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Use this option to distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"The distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"engagement_id":{"type":"string","description":"The engagement's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The task exited queue time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_exited_queue\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task that exited the queue.","required":["task_id","channel","cc_queue_id","engagement_id","date_time_ms"],"properties":{"flow_id":{"type":"string","description":"The task's flow ID."},"flow_name":{"type":"string","description":"The flow name."},"task_id":{"type":"string","description":"The task's ID."},"channel_types":{"type":"array","description":"The task queue's channel types.","items":{"type":"string","enum":["voice","chat","sms","video","in_app_chat"]},"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to the video channel. \n* kiosk_video - Only applies to the video channel. \n* web_video - Only applies to the video channel. \n* web_chat - Only applies to the messaging channel. \n* in_app_chat - Only applies to the messaging channel. \n* sms - Only applies to the messaging channel. \n* facebook_messenger - Only applies to the messaging channel. \n* whatsapp - Only applies to the messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_exited_queue/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"queue_description":{"type":"string","description":"The task queue's description."},"dispositions_count":{"type":"integer","description":"The count of dispositions."},"disposition_sets_count":{"type":"integer","description":"The count of disposition sets."},"max_wait_time":{"type":"integer","description":"Maximum wait time, to the second."},"wrap_up_time":{"type":"integer","description":"The task queue's wrap up time, to the second."},"max_engagement_in_queue":{"type":"integer","description":"The task queue's maximum engagement in queue. Value must be between 1 and 3000."},"short_abandon_enable":{"type":"boolean","description":"Whether to enable the **Short Abandon** setting."},"short_abandon_threshold":{"type":"integer","description":"The task queue's short abandon threshold, to the second."},"distribution_type":{"type":"integer","description":"Use this option to distribute incoming engagements."},"distribution_duration_in_seconds":{"type":"integer","description":"The distribution duration, to the second."},"connecting_media_id":{"type":"string","description":"Notify duration for each queue user, to the second."},"connecting_media_name":{"type":"string","description":"File name of the media in use while consumers are being connected.\nChannel type - voice"},"transferring_media_id":{"type":"string","description":"Media ID to use while users are being transferred.\nChannel type - voice"},"transferring_media_name":{"type":"string","description":"File name of the media to use while users are being transferred.\nChannel type - voice"},"holding_media_id":{"type":"string","description":"Media ID to use while users are on hold.\nChannel type - voice"},"holding_media_name":{"type":"string","description":"File name of the media to use while users are on hold.\nChannel type - voice"},"waiting_room_name":{"type":"string","description":"Name of the user's waiting room.\nChannel type - video"},"waiting_room_id":{"type":"string","description":"ID of the waiting room for users.\nChannel type - video"},"message_accept":{"type":"string","description":"Option to accept a message manually or automatically.\nChannel type - chat, SMS","enum":["manual","auto"]},"engagement_id":{"type":"string","description":"The engagement's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The task exited queue time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_exited_queue\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"queue_description\": \"This is an example queue.\",\n \"dispositions_count\": 1,\n \"disposition_sets_count\": 1,\n \"max_wait_time\": 50,\n \"wrap_up_time\": 50,\n \"max_engagement_in_queue\": 50,\n \"short_abandon_enable\": false,\n \"short_abandon_threshold\": 50,\n \"distribution_type\": 1,\n \"distribution_duration_in_seconds\": 30,\n \"connecting_media_id\": \"connectingAudioMp3\",\n \"connecting_media_name\": \"My Connecting Media\",\n \"transferring_media_id\": \"transferringAudioMp3\",\n \"transferring_media_name\": \"My Transferring Media\",\n \"holding_media_id\": \"holdingAudioMp3\",\n \"holding_media_name\": \"My Holding Media\",\n \"waiting_room_name\": \"My Waiting Room\",\n \"waiting_room_id\": \"vPtSZOzBSLWMiorssYWTZw\",\n \"message_accept\": \"manual\",\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.call_control_unhold_call_executed":{"post":{"tags":["contact_center"],"operationId":"contact_center.call_control_unhold_call_executed","requestBody":{"description":"# contact_center.call_control_unhold_call_executed\nThe **Call control unhold call executed** event is triggered when a held call is resumed by using [Command control of a user](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Call control unhold call executed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user_control:admin`\n\n**Event type**: `contact_center.call_control_unhold_call_executed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control unhold call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a held call was resumed by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_unhold_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["request_id","engagement_id","user_id","date_time_ms"],"description":"Information about the executed call control unhold call.","properties":{"request_id":{"type":"string","description":"The app request ID.","maxLength":64,"example":"xqJE_cgERLyAJHYYL5LLeg"},"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u154t5-ASlK83fZb1YWqgw"},"user_id":{"type":"string","description":"The user's ID.","example":"user_123456789"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when a held call was resumed by using the **Command Control of user** API, to the millisecond.","example":"2025-12-30T06:36:27Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.call_control_unhold_call_executed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"request_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"date_time_ms\": \"2025-09-03T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_skills_unassigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_skills_unassigned","requestBody":{"description":"# contact_center.user_skills_unassigned\n\nThe **User skills unassigned** event is triggered when skills are removed from a user.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User skills unassigned** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_skills_unassigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the skills unassigned from the user.","required":["user_id","user_email","role_id","role_name","display_name","skills","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_skills_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"skills":{"type":"array","description":"The skills unassigned from the user.","items":{"type":"object","required":["skill_id"],"properties":{"skill_id":{"type":"string","description":"The skill's ID.","example":"s0pP7Z_AcR_6xUiAS2SLE1g"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the skills were unassigned from the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_skills_unassigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"skills\": [\n {\n \"skill_id\": \"s0pP7Z_AcR_6xUiAS2SLE1g\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the skills unassigned from the user.","required":["user_id","user_email","role_id","role_name","display_name","skills","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_skills_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"skills":{"type":"array","description":"The skills unassigned from the user.","items":{"type":"object","required":["skill_id"],"properties":{"skill_id":{"type":"string","description":"The skill's ID.","example":"s0pP7Z_AcR_6xUiAS2SLE1g"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the skills were unassigned from the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_skills_unassigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"skills\": [\n {\n \"skill_id\": \"s0pP7Z_AcR_6xUiAS2SLE1g\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_rejected":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_rejected","requestBody":{"description":"# contact_center.task_reservation_rejected\n\nThe **User rejected a task reservation** event is triggered when a user rejects a task queue reservation.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **User rejected a task reservation** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_rejected`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the rejected task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video — Only applies to video channel. \n* web_chat — Only applies to messaging channel. \n* in_app_chat — Only applies to messaging channel. \n* sms — Only applies to messaging channel. \n* facebook_messenger — Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_rejected/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the rejected task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video — Only applies to video channel. \n* web_chat — Only applies to messaging channel. \n* in_app_chat — Only applies to messaging channel. \n* sms — Only applies to messaging channel. \n* facebook_messenger — Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_rejected/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_rejected\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.inbox_message_received":{"post":{"tags":["contact_center"],"operationId":"contact_center.inbox_message_received","requestBody":{"description":"# contact_center.inbox_message_received\nThe **Inbox message received** event is triggered when the Contact Center receives a voicemail.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Inbox message received** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_inbox:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:inbox:admin`\n\n**Event type**: `contact_center.inbox_message_received`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the received inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_received/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was received, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_received\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the received inbox message.","required":["inbox_id","inbox_name","message_id","engagement_id","engagement_direction","channel","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"teams":{"$ref":"#/paths/contact_center.inbox_message_received/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"inbox_id":{"type":"string","description":"The inbox's ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"message_id":{"type":"string","description":"The message's ID."},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the message was received, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.inbox_message_received\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"consumer_number\": \"+18005550101\",\n \"inbox_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"inbox_name\": \"My Inbox\",\n \"message_id\": \"KGTRVt3gQ2i-WjoUIjewXq\",\n \"date_time_ms\": \"2024-09-09T02:57:32.719Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_canceled":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_canceled","requestBody":{"description":"# contact_center.engagement_transfer_canceled\n\nThe **Engagement transfer canceled** event is triggered when an engagement transfer is canceled.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer canceled** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_canceled`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is canceled, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is canceled, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"WZZ5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"KJas_cgERLyAJHYYL5LLeg\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the canceled engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_canceled/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is canceled, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is canceled, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_canceled\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"WZZ5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"KJas_cgERLyAJHYYL5LLeg\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.recording_permanently_deleted":{"post":{"tags":["contact_center"],"operationId":"contact_center.recording_permanently_deleted","requestBody":{"description":"# contact_center.recording_permanently_deleted\n\nThe **Recording permanently deleted** event is triggered when an engagement's recording is permanently deleted.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Recording permanently deleted** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_recording:read:admin`,`contact_center_recording:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:recording:admin`\n\n**Event type**: `contact_center.recording_permanently_deleted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's permanently deleted recording.","required":["recording_id","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the recording was permanently deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the recording was permanently deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_permanently_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"date_time_ms\": \"2023-03-30T14:15:57.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement's permanently deleted recording.","required":["recording_id","date_time_ms"],"properties":{"recording_id":{"type":"string","description":"The recording's unique ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the recording was permanently deleted, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the recording was permanently deleted, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.recording_permanently_deleted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"recording_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"date_time_ms\": \"2023-03-30T14:15:57.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.queue_operating_hours_updated":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_operating_hours_updated","requestBody":{"description":"# contact_center.queue_operating_hours_updated\n\nThe **Queue operating hours updated** event is triggered when the queue operating hours are updated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Queue operating hours updated** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`,`contact_center_queue:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue_operating_hours_updated:admin`\n\n**Event type**: `contact_center.queue_operating_hours_updated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queue operating hours.","required":["cc_queue_id","updates","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the operating hours are updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the operating hours are updated, to the millisecond."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"updates":{"type":"object","description":"Information about the updated queue operating hours.","properties":{"business_hour_id":{"type":"string","description":"The business hour's ID."},"business_hour_name":{"type":"string","description":"The business hour's name."},"account_default_business_hour":{"type":"boolean","description":"Whether this is the account's default business hours."},"closure_set_id":{"type":"string","description":"The closure set's ID."},"closure_set_name":{"type":"string","description":"The closure set's name."},"account_default_closure_set":{"type":"boolean","description":"Whether this is the account's default closure set."}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_operating_hours_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2024-02-15T09:27:15.987Z\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"updates\": {\n \"business_hour_id\": \"5bBXuoUKQ6aBwFE8I37qkw\",\n \"business_hour_name\": \"My Business Hours\",\n \"account_default_business_hour\": false,\n \"closure_set_id\": \"GQJMxgNBT5mGdOzn-WlQOA\",\n \"closure_set_name\": \"My Closure Hours\",\n \"account_default_closure_set\": false\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queue operating hours.","required":["cc_queue_id","updates","date_time_ms"],"properties":{"date_time":{"type":"string","format":"date-time","description":"The date and time when the operating hours are updated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the operating hours are updated, to the millisecond."},"queue_id":{"type":"string","description":"The queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"updates":{"type":"object","description":"Information about the updated queue operating hours.","properties":{"business_hour_id":{"type":"string","description":"The business hour's ID."},"business_hour_name":{"type":"string","description":"The business hour's name."},"account_default_business_hour":{"type":"boolean","description":"Whether this is the account's default business hours."},"closure_set_id":{"type":"string","description":"The closure set's ID."},"closure_set_name":{"type":"string","description":"The closure set's name."},"account_default_closure_set":{"type":"boolean","description":"Whether this is the account's default closure set."}}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_operating_hours_updated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"date_time_ms\": \"2024-02-15T09:27:15.987Z\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"updates\": {\n \"business_hour_id\": \"5bBXuoUKQ6aBwFE8I37qkw\",\n \"business_hour_name\": \"My Business Hours\",\n \"account_default_business_hour\": false,\n \"closure_set_id\": \"GQJMxgNBT5mGdOzn-WlQOA\",\n \"closure_set_name\": \"My Closure Hours\",\n \"account_default_closure_set\": false\n }\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_initiated":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_initiated","requestBody":{"description":"# contact_center.engagement_transfer_initiated\n\nThe **Engagement transfer initiated** event is triggered when an engagement transfer is initiated.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer initiated** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_initiated`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the initiated engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","inbox","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement's queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement's queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_initiated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_inbox_id":{"type":"string","description":"The transfer's inbox ID. This displays when the transfer_level is inbox."},"transfer_to_inbox_name":{"type":"string","description":"The transfer's inbox name. This displays when the transfer_level is inbox."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is initiated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is initiated, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_initiated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"ZWW8234F77B9AC12225F3E2DD84B7F6E3A7\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_inbox_id\": \"1BECnH7FQpS3iYplEpiN1Q\",\n \"transfer_to_inbox_name\": \"My Inbox\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the initiated engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent","flow","inbox","did"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"transfer_to_flow_id":{"type":"string","description":"The transfer's flow ID. This displays when the transfer_level is flow."},"transfer_to_flow_name":{"type":"string","description":"The transfer's flow name. This displays when the transfer_level is flow."},"queue_id":{"type":"string","description":"The engagement's queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement's queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_initiated/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"transfer_to_inbox_id":{"type":"string","description":"The transfer's inbox ID. This displays when the transfer_level is inbox."},"transfer_to_inbox_name":{"type":"string","description":"The transfer's inbox name. This displays when the transfer_level is inbox."},"transfer_to_number":{"type":"string","description":"The transfer's phone number. This displays when the transfer_level is did."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is initiated, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is initiated, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_initiated\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"transfer_to_flow_id\": \"ZWW8234F77B9AC12225F3E2DD84B7F6E3A7\",\n \"transfer_to_flow_name\": \"My Transfer Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"Jane Doe\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"transfer_to_inbox_id\": \"1BECnH7FQpS3iYplEpiN1Q\",\n \"transfer_to_inbox_name\": \"My Inbox\",\n \"transfer_to_number\": \"+18005550110\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_takeover_started":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_takeover_started","requestBody":{"description":"# contact_center.engagement_takeover_started\nThe **Takeover started on an engagement** event is triggered when the user takes over an engagement in the Contact Center.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**.\n * The **Takeover started on an engagement** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_takeover_started`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement takeover.","required":["engagement_id","engagement_direction","channel","user_id","user_display_name","takeover_user_id","takeover_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_takeover_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"takeover_user_id":{"type":"string","description":"The takeover user's ID."},"takeover_user_display_name":{"type":"string","description":"The takeover user's display name."},"contact_center_number":{"type":"string","description":"The user's contact center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor initiation time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor initiation time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_takeover_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"takeover_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxs\",\n \"takeover_user_display_name\": \"John Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the started engagement takeover.","required":["engagement_id","engagement_direction","channel","user_id","user_display_name","takeover_user_id","takeover_user_display_name","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"user_id":{"type":"string","description":"The assigned user's ID."},"user_display_name":{"type":"string","description":"The assigned user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_takeover_started/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"takeover_user_id":{"type":"string","description":"The takeover user's ID."},"takeover_user_display_name":{"type":"string","description":"The takeover user's display name."},"contact_center_number":{"type":"string","description":"The user's contact center phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The monitor initiation time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The monitor initiation time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_takeover_started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"takeover_user_id\": \"KVTRVt3gQ2i-WjoUIjeZxs\",\n \"takeover_user_display_name\": \"John Doe\",\n \"contact_center_number\": \"+18005550100\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Smith\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_conference_participant_left":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_conference_participant_left","requestBody":{"description":"# contact_center.engagement_conference_participant_left\nThe **Engagement conference participant left** event is triggered when a participant leaves the conference.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement conference participant left** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_conference:admin`\n\n**Event type**: `contact_center.engagement_conference_participant_left`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant leaving the engagement conference.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","leaving_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant left the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number, only applies to phone number participant."}}}},"leaving_participant":{"type":"object","description":"The participant who left the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_left\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"leaving_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the participant leaving the engagement conference.","required":["engagement_id","engagement_direction","channel","flow_id","flow_number","date_time_ms","conference_id","conference_participants","leaving_participant"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel":{"type":"string","description":"The task's channel.","enum":["voice"]},"flow_id":{"type":"string","description":"The flow ID."},"flow_name":{"type":"string","description":"The flow name."},"flow_number":{"type":"string","description":"The flow's phone number."},"division_id":{"type":"string","description":"The division's ID."},"division_name":{"type":"string","description":"The division's name."},"teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the participant left the engagement conference, to the millisecond."},"conference_id":{"type":"string","description":"The conference's ID."},"conference_participants":{"type":"array","description":"The participants currently in the engagement conference.","items":{"type":"object","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_display_name":{"type":"string","description":"The participant's display name."},"participant_role":{"type":"string","description":"The participant's role.","enum":["customer","host","invitee"]},"participant_phone_number":{"type":"string","description":"The participant's phone number, only applies to phone number participant."}}}},"leaving_participant":{"type":"object","description":"The participant who left the engagement conference.","properties":{"participant_user_id":{"type":"string","description":"The participant's user ID."},"participant_queue_id":{"type":"string","description":"The queue ID from which the participant was invited to the conference."},"participant_phone_number":{"type":"string","description":"The participant's phone number."}}}},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_conference_participant_left\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"KGyggzS9QXWjt7L7yl2OxQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"enETUX_FQJGYXx3Tx69nSw\",\n \"flow_name\": \"My flow\",\n \"flow_number\": \"+14808782332\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"division_id\": \"865BmPAaSG69vc1ZI9cxlg\",\n \"division_name\": \"My division\",\n \"date_time_ms\": \"2025-12-15T07:50:48.536Z\",\n \"conference_id\": \"cc2bc81c-f6fe-4445-89c2-21a04994fb3d\",\n \"conference_participants\": [\n {\n \"participant_display_name\": \"Jane Doe\",\n \"participant_role\": \"customer\",\n \"participant_phone_number\": \"+147923561723\"\n },\n {\n \"participant_user_id\": \"dsafdsaghjfdsg\",\n \"participant_display_name\": \"Jane Smith\",\n \"participant_role\": \"host\"\n },\n {\n \"participant_user_id\": \"fhgdashjkgfds\",\n \"participant_display_name\": \"Olivia Martin\",\n \"participant_role\": \"invitee\"\n },\n {\n \"participant_display_name\": \"John Miller\",\n \"participant_role\": \"invitee\",\n \"participant_phone_number\": \"+147923567632\"\n }\n ],\n \"leaving_participant\": {\n \"participant_user_id\": \"ppsafdjsahfdag\"\n }\n }\n }\n}"}}}}}}}},"contact_center.voicemail_transcript_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.voicemail_transcript_completed","requestBody":{"description":"# contact_center.voicemail_transcript_completed\nThe **Voicemail Transcript Completed** event is triggered when a voice message transcript has been saved.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Voicemail Transcript Completed** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_voicemail:read:admin`,`contact_center_voicemail:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:voicemail_transcript_completed:admin`\n\n**Event type**: `contact_center.voicemail_transcript_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed voicemail transcript.","required":["inbox_id","inbox_name","message_id","engagement_id","date_time_ms"],"properties":{"message_id":{"type":"string","description":"The voicemail's unique ID."},"inbox_id":{"type":"string","description":"The inbox's unique ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"engagement_id":{"type":"string","description":"The engagement ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"teams":{"$ref":"#/paths/contact_center.voicemail_transcript_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transcript_url":{"type":"string","description":"The URL to the voicemail transcript."},"message_duration":{"type":"integer","description":"The inbox message's duration, to the second."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"status":{"type":"string","description":"The inbox message soft delete flag.","enum":["normal","deleted"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.voicemail_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"inbox_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"inbox_name\": \"My Inbox\",\n \"engagement_id\": \"y154t5-BSlK83fZb1YWqgq\",\n \"date_time_ms\": \"2023-05-15T09:27:15.987Z\",\n \"flow_id\": \"My Flow\",\n \"flow_name\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"cc_queue_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/voicemail/transcripts/download/ghyetrjj_sdfsdgfkdjfl111?type=voice\",\n \"message_duration\": 150,\n \"consumer_number\": \"+18005550101\",\n \"consumer_id\": \"ghyetrjj_sdfsdgfkdjfl123\",\n \"consumer_display_name\": \"Jane Doe\",\n \"status\": \"normal\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed voicemail transcript.","required":["inbox_id","inbox_name","message_id","engagement_id","date_time_ms"],"properties":{"message_id":{"type":"string","description":"The voicemail's unique ID."},"inbox_id":{"type":"string","description":"The inbox's unique ID."},"inbox_name":{"type":"string","description":"The inbox's name."},"engagement_id":{"type":"string","description":"The engagement ID."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement ended, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"teams":{"$ref":"#/paths/contact_center.voicemail_transcript_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transcript_url":{"type":"string","description":"The URL to the voicemail transcript."},"message_duration":{"type":"integer","description":"The inbox message's duration, to the second."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"status":{"type":"string","description":"The inbox message soft delete flag.","enum":["normal","deleted"]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.voicemail_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"ghyetrjj_sdfsdgfkdjfl11\",\n \"inbox_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"inbox_name\": \"My Inbox\",\n \"engagement_id\": \"y154t5-BSlK83fZb1YWqgq\",\n \"date_time_ms\": \"2023-05-15T09:27:15.987Z\",\n \"flow_id\": \"My Flow\",\n \"flow_name\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"cc_queue_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/voicemail/transcripts/download/ghyetrjj_sdfsdgfkdjfl111?type=voice\",\n \"message_duration\": 150,\n \"consumer_number\": \"+18005550101\",\n \"consumer_id\": \"ghyetrjj_sdfsdgfkdjfl123\",\n \"consumer_display_name\": \"Jane Doe\",\n \"status\": \"normal\"\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_accepted":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_accepted","requestBody":{"description":"# contact_center.task_reservation_accepted\n\nThe **User accepted a task reservation** event is triggered when a user accepts a task queue reservation.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **User accepted a task reservation** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_accepted`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the accepted task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_accepted/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_accepted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the accepted task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64},"teams":{"$ref":"#/paths/contact_center.task_reservation_accepted/post/requestBody/content/application~1json/schema/components/schemas/Teams"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_accepted\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_email_transcript_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_email_transcript_completed","requestBody":{"description":"# contact_center.engagement_email_transcript_completed\n\nThe **Engagement email transcript completed** event is triggered when a Contact Center engagement email transcript is completed.\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* Enable the **Email transcript completed** subscription under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement_email_transcript_completed:admin`\n\n**Event type**: `contact_center.engagement_email_transcript_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["engagement_id","engagement_direction","channel","channel_source"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u1ASlK83fZb54t5-1YWqgw"},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"],"example":"inbound"},"channel":{"type":"string","description":"The task's channel. \n* email","enum":["email"],"example":"email"},"channel_source":{"type":"string","description":"The channel's source. \n* email_address - Only applies to email channel.","enum":["email_address"],"example":"email_address"},"flow_id":{"type":"string","description":"The engagement's flow ID where the engagement ended.","example":"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9"},"flow_name":{"type":"string","description":"The engagement's flow name where the engagement ended.","example":"Email Flow"},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing contact center recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz","example":"https://api.zoom.us/v2/contact_center/email/messages?engagement_id=u1ASlK83fZb54t5-1YWqgw&direction=forward&page_size=30"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the email transcript was completed, to the millisecond.","example":"2023-05-15T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_email_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u1ASlK83fZb54t5-1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"email\",\n \"channel_source\": \"email_address\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"Email Flow\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/email/messages?engagement_id=u1ASlK83fZb54t5-1YWqgw&direction=forward&page_size=30\",\n \"date_time_ms\": \"2025-07-15T08:12:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","required":["engagement_id","engagement_direction","channel","channel_source"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID.","example":"u1ASlK83fZb54t5-1YWqgw"},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"],"example":"inbound"},"channel":{"type":"string","description":"The task's channel. \n* email","enum":["email"],"example":"email"},"channel_source":{"type":"string","description":"The channel's source. \n* email_address - Only applies to email channel.","enum":["email_address"],"example":"email_address"},"flow_id":{"type":"string","description":"The engagement's flow ID where the engagement ended.","example":"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9"},"flow_name":{"type":"string","description":"The engagement's flow name where the engagement ended.","example":"Email Flow"},"transcript_url":{"type":"string","description":"The URL to download the recording transcript file. \n\n If a user has authorized and installed your OAuth app containing contact center recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file, and set the access_token as a Bearer token in the Authorization header. \n\n curl -H 'Authorization: Bearer ' https://{{base-domain}}/rec/archive/download/xyz","example":"https://api.zoom.us/v2/contact_center/email/messages?engagement_id=u1ASlK83fZb54t5-1YWqgw&direction=forward&page_size=30"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the email transcript was completed, to the millisecond.","example":"2023-05-15T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_email_transcript_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u1ASlK83fZb54t5-1YWqgw\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"email\",\n \"channel_source\": \"email_address\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"Email Flow\",\n \"transcript_url\": \"https://api.zoom.us/v2/contact_center/email/messages?engagement_id=u1ASlK83fZb54t5-1YWqgw&direction=forward&page_size=30\",\n \"date_time_ms\": \"2025-07-15T08:12:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.user_phone_numbers_unassigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_phone_numbers_unassigned","requestBody":{"description":"# contact_center.user_phone_numbers_unassigned\n\nThe **User phone numbers unassigned** event is triggered when removing phone numbers from a user.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **User phone numbers unassigned** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_phone_numbers_unassigned`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user's unassigned phone numbers.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms","phone_numbers"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_phone_numbers_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"phone_numbers":{"type":"array","description":"The phone numbers unassigned from the user.","items":{"type":"object","required":["phone_number","phone_number_id"],"properties":{"phone_number":{"type":"string","description":"The phone number, in E164 format.","example":"+12093412723"},"phone_number_id":{"type":"string","description":"The phone number's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user phone numbers were unassigned from the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_phone_numbers_unassigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2025-12-12T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"+12093412723\",\n \"phone_number_id\": \"OlK7lczzT_e7h6p1Q6wGdg\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user's unassigned phone numbers.","required":["user_id","user_email","role_id","role_name","display_name","date_time_ms","phone_numbers"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.user_phone_numbers_unassigned/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"user_email":{"type":"string","format":"email","description":"The user's email address."},"role_id":{"type":"string","description":"The user's role ID."},"role_name":{"type":"string","description":"The user's role name."},"phone_numbers":{"type":"array","description":"The phone numbers unassigned from the user.","items":{"type":"object","required":["phone_number","phone_number_id"],"properties":{"phone_number":{"type":"string","description":"The phone number, in E164 format.","example":"+12093412723"},"phone_number_id":{"type":"string","description":"The phone number's ID.","example":"OlK7lczzT_e7h6p1Q6wGdg"}}}},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user phone numbers were unassigned from the user, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_phone_numbers_unassigned\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"Mt6sv4u0TAyPkwgsL2lxiA\",\n \"object\": {\n \"date_time_ms\": \"2025-12-12T09:27:15.987Z\",\n \"user_id\": \"giudgf_4576385jsdhfsfsd\",\n \"display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"user_email\": \"johndoe@example.com\",\n \"role_id\": \"27302393-4784-11ec-a3cd-122e3e29bb87\",\n \"role_name\": \"Admin\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"+12093412723\",\n \"phone_number_id\": \"OlK7lczzT_e7h6p1Q6wGdg\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_unhold":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_unhold","requestBody":{"description":"# contact_center.engagement_user_unhold\n\nThe **Engagement user unhold** event is triggered when a user comes off hold in an engagement.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement user unhold** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_unhold`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user that came off hold in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_unhold/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's off-hold time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's off-hold time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_unhold\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user that came off hold in the engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type. \n* voice ","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_unhold/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."},"date_time":{"type":"string","format":"date-time","description":"The user's off-hold time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's off-hold time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_unhold\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.user_logout":{"post":{"tags":["contact_center"],"operationId":"contact_center.user_logout","requestBody":{"description":"# contact_center.user_logout\n\nThe **User logout** event is triggered when a user logs out of Contact Center.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **User logout** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_user:read:admin`,`contact_center_user:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:user:admin`\n\n**Event type**: `contact_center.user_logout`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user logout.","required":["user_id","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_logout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user logged out of Contact Center, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user logged out of Contact Center, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_logout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user logout.","required":["user_id","display_name","date_time_ms"],"properties":{"user_id":{"type":"string","description":"The user's ID."},"display_name":{"type":"string","description":"The user's display name."},"user_email":{"type":"string","description":"The user's email."},"teams":{"$ref":"#/paths/contact_center.user_logout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time":{"type":"string","format":"date-time","description":"The date and time when the user logged out of Contact Center, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user logged out of Contact Center, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.user_logout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"user_id\": \"ukAAkZKfROKMSw1bj_RDFQ\",\n \"display_name\": \"John Doe\",\n \"user_email\": \"johndoe@example.com\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_completed":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_completed","requestBody":{"description":"# contact_center.task_reservation_completed\n\nThe **User completed a task reservation** event is triggered when a user completes a task queue reservation.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **User completed a task reservation** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_completed`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_reservation_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the completed task reservation.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","engagement_direction","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's channel type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* web_chat - Only applies to messaging channel. \n* in_app_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_reservation_completed/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_completed\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"outbound\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\"\n }\n }\n}"}}}}}}}},"contact_center.queue_scheduled_callback_created":{"post":{"tags":["contact_center"],"operationId":"contact_center.queue_scheduled_callback_created","requestBody":{"description":"# contact_center.queue_scheduled_callback_created\n\nThe **Queue Scheduled Callback Created** is triggered when a scheduled callback is booked.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n * A valid **Event Notification Endpoint URL**.\n * The **Queue Scheduled Callback Created** subscription enabled under the **Contact Center** event.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_queue:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:queue:admin`\n\n**Event type**: `contact_center.queue_scheduled_callback_created`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created scheduled callback.","required":["queue_channel","start_time","cc_queue_id","queue_name","attendees"],"properties":{"start_time":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/StartTime-Contact Center"},"cc_queue_id":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/QueueId-Contact Center"},"queue_name":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/QueueName-Contact Center"},"queue_channel":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/Channel-Contact Center"},"attendees":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/Attendees-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Channel-Contact Center":{"type":"string","description":"The queue's channel.","enum":["voice","video"]},"StartTime-Contact Center":{"type":"string","description":"The booking slot's start time.","format":"date-time"},"QueueId-Contact Center":{"type":"string","description":"The queue's ID."},"QueueName-Contact Center":{"type":"string","description":"The queue's name."},"Attendees-Contact Center":{"type":"array","description":"A list of the scheduled callback attendees","items":{"type":"object","required":["attendee_id","first_name","last_name","email","phone_number"],"properties":{"attendee_id":{"type":"string","description":"The attendee's ID."},"first_name":{"type":"string","description":"The attendee's first name."},"last_name":{"type":"string","description":"The attendee's last name."},"email":{"type":"string","description":"The attendee's email address.","format":"email"},"phone_number":{"type":"string","description":"The attendee's phone number, in E.164 format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_scheduled_callback_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"start_time\": \"2025-06-18T15:00:00Z\",\n \"cc_queue_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"queue_name\": \"My Queue\",\n \"queue_channel\": \"voice\",\n \"attendees\": [\n {\n \"attendee_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"phone_number\": \"+18005550100\"\n }\n ]\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the created scheduled callback.","required":["queue_channel","start_time","cc_queue_id","queue_name","attendees"],"properties":{"start_time":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/StartTime-Contact Center"},"cc_queue_id":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/QueueId-Contact Center"},"queue_name":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/QueueName-Contact Center"},"queue_channel":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/Channel-Contact Center"},"attendees":{"$ref":"#/paths/contact_center.queue_scheduled_callback_created/post/requestBody/content/application~1json/schema/components/schemas/Attendees-Contact Center"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Channel-Contact Center":{"type":"string","description":"The queue's channel.","enum":["voice","video"]},"StartTime-Contact Center":{"type":"string","description":"The booking slot's start time.","format":"date-time"},"QueueId-Contact Center":{"type":"string","description":"The queue's ID."},"QueueName-Contact Center":{"type":"string","description":"The queue's name."},"Attendees-Contact Center":{"type":"array","description":"A list of the scheduled callback attendees","items":{"type":"object","required":["attendee_id","first_name","last_name","email","phone_number"],"properties":{"attendee_id":{"type":"string","description":"The attendee's ID."},"first_name":{"type":"string","description":"The attendee's first name."},"last_name":{"type":"string","description":"The attendee's last name."},"email":{"type":"string","description":"The attendee's email address.","format":"email"},"phone_number":{"type":"string","description":"The attendee's phone number, in E.164 format."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.queue_scheduled_callback_created\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"start_time\": \"2025-06-18T15:00:00Z\",\n \"cc_queue_id\": \"WkdWelkzSnBjSFJwYjI0PQ11\",\n \"queue_name\": \"My Queue\",\n \"queue_channel\": \"voice\",\n \"attendees\": [\n {\n \"attendee_id\": \"beYjXoDOS_eV1QmTpj63PQ\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"phone_number\": \"+18005550100\"\n }\n ]\n }\n }\n}"}}}}}}}},"contact_center.engagement_survey_status":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_survey_status","requestBody":{"description":"# contact_center.engagement_survey_status\n\nThe **Engagement survey status** event is triggered when an engagement's survey is `sent`, `question_submitted`, `completed`, or `cancelled`.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement survey status** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_survey:read:admin`\n\n**Event type**: `contact_center.engagement_survey_status`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement survey.","required":["engagement_id","channel","survey_status","survey_id","survey_trigger_from","user_id","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"survey_status":{"type":"string","description":"The engagement survey's status. \n* sent \n* question_submitted \n* completed \n* cancelled","enum":["sent","question_submitted","completed","cancelled"]},"survey_id":{"type":"string","description":"The survey's ID."},"survey_question_id":{"type":"string","description":"The survey question's ID. Only has a value if the survey status is question_submitted and channel is voice."},"survey_trigger_from":{"type":"string","description":"The triggered survey's source. \n* queue \n* flow","enum":["queue","flow"]},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"consumer_email":{"type":"string","description":"The consumer's email."},"user_id":{"type":"string","description":"The last agent's ID."},"user_display_name":{"type":"string","description":"The last agent's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_survey_status/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement survey's status is triggered, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_survey_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"survey_status\": \"completed\",\n \"survey_id\": \"2yWjT4awTumcFKIrvcf4OA\",\n \"survey_question_id\": \"JocDev1cT-mIHREwDtMTVw\",\n \"survey_trigger_from\": \"queue\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_email\": \"janedoe@example.com\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2024-09-11T02:18:11.658Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the engagement survey.","required":["engagement_id","channel","survey_status","survey_id","survey_trigger_from","user_id","date_time_ms"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"channel":{"type":"string","description":"The task's channel. \n* voice \n* video \n* messaging","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel. \n* in_app_chat - Only applies to messaging channel. \n* web_chat - Only applies to messaging channel. \n* sms - Only applies to messaging channel. \n* facebook_messenger - Only applies to messaging channel. \n* whatsapp - Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","in_app_chat","web_chat","sms","facebook_messenger","whatsapp"]},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"survey_status":{"type":"string","description":"The engagement survey's status. \n* sent \n* question_submitted \n* completed \n* cancelled","enum":["sent","question_submitted","completed","cancelled"]},"survey_id":{"type":"string","description":"The survey's ID."},"survey_question_id":{"type":"string","description":"The survey question's ID. Only has a value if the survey status is question_submitted and channel is voice."},"survey_trigger_from":{"type":"string","description":"The triggered survey's source. \n* queue \n* flow","enum":["queue","flow"]},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"consumer_display_name":{"type":"string","description":"The consumer's display name."},"consumer_email":{"type":"string","description":"The consumer's email."},"user_id":{"type":"string","description":"The last agent's ID."},"user_display_name":{"type":"string","description":"The last agent's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_survey_status/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the engagement survey's status is triggered, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_survey_status\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"survey_status\": \"completed\",\n \"survey_id\": \"2yWjT4awTumcFKIrvcf4OA\",\n \"survey_question_id\": \"JocDev1cT-mIHREwDtMTVw\",\n \"survey_trigger_from\": \"queue\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_number\": \"+18005550101\",\n \"consumer_display_name\": \"Jane Doe\",\n \"consumer_email\": \"janedoe@example.com\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"date_time_ms\": \"2024-09-11T02:18:11.658Z\"\n }\n }\n}"}}}}}}}},"contact_center.task_reservation_timeout":{"post":{"tags":["contact_center"],"operationId":"contact_center.task_reservation_timeout","requestBody":{"description":"# contact_center.task_reservation_timeout\n\nThe **Task reservation timed out** event is triggered when a task queue reservation times out. When a task queue reservation times out, it is not deleted.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Task reservation timed out** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_task:read:admin`,`contact_center_task:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:task:admin`\n\n**Event type**: `contact_center.task_reservation_timeout`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task reservation's timeout.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video — Only applies to video channel. \n* kiosk_video — Only applies to video channel. \n* web_video — Only applies to video channel. \n* web_chat — Only applies to messaging channel. \n* in_app_chat — Only applies to messaging channel. \n* sms — Only applies to messaging channel. \n* facebook_messenger — Only applies to messaging channel. \n* whatsapp — Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_reservation_timeout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the task reservation's timeout.","required":["task_reservation_id","task_id","assigned_user_id","engagement_id","channel"],"properties":{"task_reservation_id":{"type":"string","description":"The reservation's ID."},"task_id":{"type":"string","description":"The task's ID."},"flow_id":{"type":"string","description":"The task's flow ID."},"assigned_user_id":{"type":"string","description":"The task's assigned user's ID."},"flow_name":{"type":"string","description":"The flow's name."},"channel_id":{"type":"string","description":"The task's channel ID.","deprecated":true},"channel_name":{"type":"string","description":"The task's type.","enum":["voice","sms","chat","video","in_app_chat"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video","messaging"]},"channel_source":{"type":"string","description":"The channel's source. \n* in_app_video — Only applies to video channel. \n* kiosk_video — Only applies to video channel. \n* web_video — Only applies to video channel. \n* web_chat — Only applies to messaging channel. \n* in_app_chat — Only applies to messaging channel. \n* sms — Only applies to messaging channel. \n* facebook_messenger — Only applies to messaging channel. \n* whatsapp — Only applies to messaging channel.","enum":["in_app_video","kiosk_video","web_video","web_chat","in_app_chat","sms","facebook_messenger","whatsapp"]},"queue_id":{"type":"string","description":"The task queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The task queue's name."},"teams":{"$ref":"#/paths/contact_center.task_reservation_timeout/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"created_time":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the second.","deprecated":true},"created_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was created, to the millisecond."},"last_modified_time":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the second.","deprecated":true},"last_modified_time_ms":{"type":"string","format":"date-time","description":"The date and time when the task was last modified, to the millisecond."},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"auto_assign":{"type":"boolean","description":"Whether the task gets manually assigned to a target."},"task_timeout":{"type":"integer","description":"The task queue's timeout, to the second."},"caller_number":{"type":"string","description":"The caller's phone number."},"callee_number":{"type":"string","description":"The callee's phone number."},"request_id":{"type":"string","description":"The app request ID when the task is created by using [**Command control of a user**](/docs/api/contact-center/#tag/call-control/post/contact_center/users/{userId}/commands).","maxLength":64}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.task_reservation_timeout\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_reservation_id\": \"ZWR1C1FB695C654A829FE56553A709E8EBB\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"assigned_user_id\": \"M2rStJNqSyOlmyw-ti2fGg\",\n \"flow_name\": \"My Flow\",\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"created_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"last_modified_time_ms\": \"2022-06-14T15:56:53.987Z\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"auto_assign\": false,\n \"task_timeout\": 86400,\n \"caller_number\": \"+18005550100\",\n \"callee_number\": \"+18005550101\",\n \"request_id\": \"968ffca1-167f-454d-bcff-7334a99cb1c5\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_ended":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_ended","requestBody":{"description":"# contact_center.engagement_user_ended\n\nThe **Engagement user ended** event is triggered when a user ends an engagement.\n\n## Prerequisites\n\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n * A valid **Event Notification Endpoint URL**.\n * The **Engagement user ended** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_ended`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-ended engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The user's end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-ended engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source.\n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The user's end time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's end time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_ended/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"web_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"+18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_user_answered":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_user_answered","requestBody":{"description":"# contact_center.engagement_user_answered\n\nThe **Engagement user answered** event is triggered when a user answers a voice or video engagement.\n\nFor **video** engagements, this event is triggered when\n* A user answers an inbound engagement.\n* A user accepts an invite from another agent to join an engagement.\n* A user answers a callback engagement.\n* A user answers a scheduled callback engagement.\n* A user answers an engagement after the engagement is transferred to a queue or flow.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement user answered** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_user_answered`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-answered engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The user's answer time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's answer time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_answered/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_answered\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the user-answered engagement.","required":["engagement_id","engagement_direction","channel","date_time_ms","user_id","user_display_name"],"properties":{"engagement_id":{"type":"string","description":"The engagement's ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_id":{"type":"string","description":"The engagement's channel ID.","deprecated":true},"channel_type":{"type":"string","description":"The task's channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","video"]},"channel_source":{"type":"string","description":"The channel's source. \n\n* in_app_video - Only applies to video channel. \n* kiosk_video - Only applies to video channel. \n* web_video - Only applies to video channel.","enum":["in_app_video","kiosk_video","web_video"]},"date_time":{"type":"string","format":"date-time","description":"The user's answer time, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The user's answer time, to the millisecond."},"flow_id":{"type":"string","description":"The engagement's flow ID."},"flow_name":{"type":"string","description":"The flow's name."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's display name."},"teams":{"$ref":"#/paths/contact_center.engagement_user_answered/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"flow_number":{"type":"string","description":"The flow's phone number."},"consumer_id":{"type":"string","description":"The consumer's address-book contact ID."},"consumer_display_name":{"type":"string","description":"The consumer's address-book contact display name."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_user_answered\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"engagement_id\": \"u154t5-ASlK83fZb1YWqgw\",\n \"engagement_direction\": \"outbound\",\n \"channel\": \"video\",\n \"channel_source\": \"in_app_video\",\n \"date_time_ms\": \"2022-02-15T09:27:15.987Z\",\n \"flow_id\": \"ZWWC0A840C726C2CE3ACF01041CB8CFD8B9\",\n \"flow_name\": \"My Flow\",\n \"cc_queue_id\": \"xqJE_cgERLyAJHYYL5LLeg\",\n \"queue_name\": \"My Queue\",\n \"consumer_number\": \"+18005550100\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"John Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"flow_number\": \"18005550101\",\n \"consumer_id\": \"szCyubr_aQhieHNWYbAGMYg\",\n \"consumer_display_name\": \"Jane Smith\"\n }\n }\n}"}}}}}}}},"contact_center.team_members_assigned":{"post":{"tags":["contact_center"],"operationId":"contact_center.team_members_assigned","requestBody":{"description":"# contact_center.team_members_assigned\nThe **Team members assigned** event is triggered when supervisors or agents are assigned to a team.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Team members assigned** subscription enabled under the **Contact Center** event.\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_team:read:admin`,`contact_center_team:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:team_member_assigned:admin`\n\n**Event type**: `contact_center.team_members_assigned`\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the assigned members.","required":["team_id","user_ids","team_role","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"user_ids":{"type":"array","description":"The user's ID list assigned to the team.","example":"[IGTRVt3gQ2i-WjoUIjeZxw,T_X0vrroQPO4UwXGNeBS8A]"},"team_role":{"type":"string","description":"The user's role in the team.","example":"supervisor","enum":["supervisor","agent"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user is assigned to the team.","example":"2025-02-16T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_members_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"user_ids\": [\n \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"T_X0vrroQPO4UwXGNeBS8A\"\n ],\n \"team_role\": \"supervisor\",\n \"date_time_ms\": \"2025-02-16T09:27:15.987Z\"\n }\n }\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 timestamp when the event occurred.","example":1666595018546},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID.","example":"D8cJuqWVQ623CI4Q8yQK0Q"},"object":{"type":"object","description":"Information about the assigned members.","required":["team_id","user_ids","team_role","date_time_ms"],"properties":{"team_id":{"type":"string","description":"The team's ID.","example":"2mDPBg3vSYC_l6crQgeCkA"},"user_ids":{"type":"array","description":"The user's ID list assigned to the team.","example":"[IGTRVt3gQ2i-WjoUIjeZxw,T_X0vrroQPO4UwXGNeBS8A]"},"team_role":{"type":"string","description":"The user's role in the team.","example":"supervisor","enum":["supervisor","agent"]},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the user is assigned to the team.","example":"2025-02-16T09:27:15.987Z"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.team_members_assigned\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"team_id\": \"2mDPBg3vSYC_l6crQgeCkA\",\n \"user_ids\": [\n \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"T_X0vrroQPO4UwXGNeBS8A\"\n ],\n \"team_role\": \"supervisor\",\n \"date_time_ms\": \"2025-02-16T09:27:15.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.engagement_transfer_queued":{"post":{"tags":["contact_center"],"operationId":"contact_center.engagement_transfer_queued","requestBody":{"description":"# contact_center.engagement_transfer_queued\n\nThe **Engagement transfer queued** event is triggered when an engagement transfer is queued.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Engagement transfer queued** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_engagement:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:engagement:admin`\n\n**Event type**: `contact_center.engagement_transfer_queued`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queued engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_queued/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is queued, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is queued, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_queued\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"John Smith\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the queued engagement transfer.","required":["task_id","transfer_to_task_id","engagement_id","engagement_direction","channel","user_id","user_display_name","date_time_ms"],"properties":{"task_id":{"type":"string","description":"The task's ID."},"transfer_to_task_id":{"type":"string","description":"The transfer task's ID."},"task_status":{"type":"string","description":"The task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"transfer_to_task_status":{"type":"string","description":"The transfer task's status.","enum":["pending","reserved","assigned","canceled","completed","wrapping"]},"task_timeout":{"type":"integer","description":"The task's timeout, to the second."},"transfer_to_task_timeout":{"type":"integer","description":"The transfer task's timeout, to the second."},"transfer_level":{"type":"string","description":"The transfer level.","enum":["queue","agent"]},"transfer_type":{"description":"The transfer type.","type":"string","enum":["warm","cold"]},"engagement_id":{"type":"string","description":"The task queue's engagement ID."},"engagement_direction":{"type":"string","description":"The engagement's direction.","enum":["inbound","outbound"]},"channel_name":{"type":"string","description":"The channel type.","enum":["voice"],"deprecated":true},"channel":{"type":"string","description":"The task's channel.","enum":["voice","messaging","email","work_item"]},"flow_id":{"type":"string","description":"The flow's ID."},"flow_name":{"type":"string","description":"The flow's name."},"flow_number":{"type":"string","description":"The flow's phone number."},"queue_id":{"type":"string","description":"The engagement queue's ID.","deprecated":true},"cc_queue_id":{"type":"string","description":"The Contact Center queue's ID."},"queue_name":{"type":"string","description":"The engagement queue's name."},"transfer_to_queue_id":{"type":"string","description":"The transfer queue's ID. This displays when the transfer_level is queue.","deprecated":true},"transfer_to_cc_queue_id":{"type":"string","description":"The Contact Center transfer queue's ID. This displays when the transfer_level is queue."},"transfer_to_queue_name":{"type":"string","description":"The transfer queue's name. This displays when the transfer_level is queue."},"user_id":{"type":"string","description":"The user's ID."},"user_display_name":{"type":"string","description":"The user's name."},"teams":{"$ref":"#/paths/contact_center.engagement_transfer_queued/post/requestBody/content/application~1json/schema/components/schemas/Teams"},"transfer_to_user_id":{"type":"string","description":"The transfer user's ID. This displays when the transfer_level is agent."},"transfer_to_user_display_name":{"type":"string","description":"The transfer user's name. This displays when the transfer_level is agent."},"consumer_id":{"type":"string","description":"The consumer's ID."},"consumer_display_name":{"type":"string","description":"The consumer's name."},"consumer_number":{"type":"string","description":"The consumer's phone number."},"date_time":{"type":"string","format":"date-time","description":"The date and time when the transfer is queued, to the second.","deprecated":true},"date_time_ms":{"type":"string","format":"date-time","description":"The date and time when the transfer is queued, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false,"components":{"schemas":{"Teams":{"type":"array","description":"The user's teams.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team's ID."},"team_name":{"type":"string","description":"The team's name."}}}}}}},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.engagement_transfer_queued\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"task_id\": \"ZWTFBC1C663A02CFCDD971EC9B538C49372\",\n \"transfer_to_task_id\": \"ZWTAF8GB6GW796WER6B8WET3BG8H3JWE89T\",\n \"task_status\": \"assigned\",\n \"transfer_to_task_status\": \"pending\",\n \"task_timeout\": 86400,\n \"transfer_to_task_timeout\": 86400,\n \"transfer_level\": \"queue\",\n \"transfer_type\": \"warm\",\n \"engagement_id\": \"HdOQ9e_aRdO0lyQutA17qQ\",\n \"engagement_direction\": \"inbound\",\n \"channel\": \"voice\",\n \"flow_id\": \"ZWW5670D99C6FC89113D2C1CC95A3E4D1E4\",\n \"flow_name\": \"My Flow\",\n \"flow_number\": \"+18005550100\",\n \"cc_queue_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"queue_name\": \"My Queue\",\n \"transfer_to_cc_queue_id\": \"pqMF_dhFSMzBKIZZM6MMfh\",\n \"transfer_to_queue_name\": \"My Transfer Queue\",\n \"user_id\": \"IGTRVt3gQ2i-WjoUIjeZxw\",\n \"user_display_name\": \"Jane Doe\",\n \"teams\": [\n {\n \"team_id\": \"cLEZQivXRSq2YFOUkW3ctw\",\n \"team_name\": \"My team\"\n }\n ],\n \"transfer_to_user_id\": \"WTTRVy3gQ2i-WjoUIjeHzh\",\n \"transfer_to_user_display_name\": \"John Smith\",\n \"consumer_id\": \"zeYjXoDOS_eV1QmTpj63PQ\",\n \"consumer_display_name\": \"Jane Smith\",\n \"consumer_number\": \"+18005550101\",\n \"date_time_ms\": \"2021-12-03T05:07:46.987Z\"\n }\n }\n}"}}}}}}}},"contact_center.message_status":{"post":{"tags":["contact_center"],"operationId":"contact_center.message_status","requestBody":{"description":"# contact_center.message_status\nThe **Message status** event is triggered when a message is sent by using the [**Send a Message**](/docs/api/contact-center/#tag/messaging/post/contact_center/messages) API. The receipt indicates whether the message was actually delivered to the consumer.\n\n## Prerequisites\n\nEnable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with:\n\n* A valid **Event Notification Endpoint URL**.\n* The **Message status** subscription enabled under the **Contact Center** event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center_messaging:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `contact_center:read:messaging:admin`\n\n**Event type**: `contact_center.message_status`\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the message status.","required":["message_id","date_time_ms"],"properties":{"message_id":{"type":"string","description":"The unique message identifier returned when the message was sent using the [**Send a Message**](/docs/api/contact-center/messages) API."},"from":{"type":"string","description":"The sender's identifier. Different channels use platform-specific formats. For number-based channels, such as WhatsApp, the value must be in E.164 format."},"to":{"type":"string","description":"The recipient's identifier. Different channels use platform-specific formats. For number-based channels, such as WhatsApp, the value must be in E.164 format."},"engagement_id":{"type":"string","description":"The engagement ID associated with the message."},"whatsapp_message":{"type":"object","description":"The WhatsApp message status details.","required":["status"],"properties":{"status":{"type":"string","description":"The WhatsApp message status.","enum":["sent","delivered","read","failed"]},"reason":{"type":"string","description":"A short description of the failure reason when the status is failed."},"error_detail":{"type":"string","description":"Additional detailed information about the failure when the status is failed."}},"additionalProperties":false},"sms_message":{"type":"object","description":"The SMS message status details.","required":["status"],"properties":{"status":{"type":"string","enum":["delivered","failed"],"description":"The SMS message status."},"reason":{"type":"string","description":"If the SMS status is failed, provide the failure reason."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The message status update time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.message_status\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"f21b5055-5ec2-4e3f-8dde-916d4f76a2ee\",\n \"from\": \"+12090000000\",\n \"to\": \"+12090001111\",\n \"whatsapp_message\": {\n \"status\": \"failed\",\n \"reason\": \"WhatsApp platform failed to send message\",\n \"error_detail\": \"{\\\"code\\\":\\\"131026\\\",\\\"message\\\":\\\"Message Undeliverable.\\\"}\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\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 timestamp when the event occurred."},"payload":{"type":"object","required":["account_id","object"],"properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"type":"object","description":"Information about the message status.","required":["message_id","date_time_ms"],"properties":{"message_id":{"type":"string","description":"The unique message identifier returned when the message was sent using the [**Send a Message**](/docs/api/contact-center/messages) API."},"from":{"type":"string","description":"The sender's identifier. Different channels use platform-specific formats. For number-based channels, such as WhatsApp, the value must be in E.164 format."},"to":{"type":"string","description":"The recipient's identifier. Different channels use platform-specific formats. For number-based channels, such as WhatsApp, the value must be in E.164 format."},"engagement_id":{"type":"string","description":"The engagement ID associated with the message."},"whatsapp_message":{"type":"object","description":"The WhatsApp message status details.","required":["status"],"properties":{"status":{"type":"string","description":"The WhatsApp message status.","enum":["sent","delivered","read","failed"]},"reason":{"type":"string","description":"A short description of the failure reason when the status is failed."},"error_detail":{"type":"string","description":"Additional detailed information about the failure when the status is failed."}},"additionalProperties":false},"sms_message":{"type":"object","description":"The SMS message status details.","required":["status"],"properties":{"status":{"type":"string","enum":["delivered","failed"],"description":"The SMS message status."},"reason":{"type":"string","description":"If the SMS status is failed, provide the failure reason."}},"additionalProperties":false},"date_time_ms":{"type":"string","format":"date-time","description":"The message status update time, to the millisecond."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"examples":{"json-example":{"summary":"JSON example","value":"{\n \"event\": \"contact_center.message_status\",\n \"event_ts\": 1764754270736,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"message_id\": \"f21b5055-5ec2-4e3f-8dde-916d4f76a2ee\",\n \"from\": \"+12090000000\",\n \"to\": \"+12090001111\",\n \"whatsapp_message\": {\n \"status\": \"failed\",\n \"reason\": \"WhatsApp platform failed to send message\",\n \"error_detail\": \"{\\\"code\\\":\\\"131026\\\",\\\"message\\\":\\\"Message Undeliverable.\\\"}\"\n },\n \"date_time_ms\": \"2025-12-03T09:31:10.735Z\"\n }\n }\n}"}}}}}}}}}}