List alert settings with paging query
GET {{baseUrl}}/phone/alert_settings?page_size=30&next_page_token=<string>&module=2&rule=2&status=1
Gets alert settings for an account with paging query.
Prerequisites
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_alert_settings:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The number of records a single API call returns. |
| next_page_token | string | | The current page number of the returned records. |
| module | number | | This field filters the specific alert list by the module. The module and its code mappings are shown as:
Call Queue Management-1, Route Group Management-2, Devices &amp; Phones Management-3, Call Quality Management-4, Emergency Services Management-5 |
| rule | number | | This field filters the specific alert list by the rule. The rule and its code mappings display as:
Service Level-1, Inbound Abandoned Calls-2, Inbound Overflowed Calls-3, Inbound Avg Call Waiting Time-4, Inbound Forwarded to Voicemail-5, Number of Waiting Calls-6, Member Availability (Active)-7, Member Availability (Opt-in/Opt-out)-8, Route groups status change-9, Devices go offline-10, Devices go online-11, Device offline rate-12, QoS Alert-13, Emergency Call Alert-14.
When the value of the module is 1, the value of rule can only be in the range of 1 to 8.
When the value of the module is 2, the value of rule can only be 9.
When the value of the module is 3, the value of rule can only be in the range of 10 to 12.
When the value of the module is 4, the value of rule can only be 13.
When the value of the module is 5, the value of rule can only be 14. |
| status | number | | The alert's status:
0— Inactive.1— Active. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","alert_settings":[{"alert_setting_id":"\u003cstring\u003e","alert_setting_name":"\u003cstring\u003e","module":"\u003cinteger\u003e","rule":"\u003cinteger\u003e","rule_conditions":[{"rule_condition_type":5,"rule_condition_value":"\u003cstring\u003e"},{"rule_condition_type":2,"rule_condition_value":"\u003cstring\u003e"}],"targets":[{"target_name":"\u003cstring\u003e"},{"target_name":"\u003cstring\u003e"}],"time_frame_type":"specific_time","time_frame_from":"\u003cstring\u003e","time_frame_to":"\u003cstring\u003e","frequency":60,"email_recipients":["\u003cstring\u003e","\u003cstring\u003e"],"chat_channels":[{"chat_channel_name":"\u003cstring\u003e","token":"\u003cstring\u003e","end_point":"\u003cstring\u003e"},{"chat_channel_name":"\u003cstring\u003e","token":"\u003cstring\u003e","end_point":"\u003cstring\u003e"}],"status":1},{"alert_setting_id":"\u003cstring\u003e","alert_setting_name":"\u003cstring\u003e","module":"\u003cinteger\u003e","rule":"\u003cinteger\u003e","rule_conditions":[{"rule_condition_type":3,"rule_condition_value":"\u003cstring\u003e"},{"rule_condition_type":5,"rule_condition_value":"\u003cstring\u003e"}],"targets":[{"target_name":"\u003cstring\u003e"},{"target_name":"\u003cstring\u003e"}],"time_frame_type":"all_day","time_frame_from":"\u003cstring\u003e","time_frame_to":"\u003cstring\u003e","frequency":60,"email_recipients":["\u003cstring\u003e","\u003cstring\u003e"],"chat_channels":[{"chat_channel_name":"\u003cstring\u003e","token":"\u003cstring\u003e","end_point":"\u003cstring\u003e"},{"chat_channel_name":"\u003cstring\u003e","token":"\u003cstring\u003e","end_point":"\u003cstring\u003e"}],"status":1}]}