Logo
Zoom Public API Documentation

Get Alert setting details

GET {{baseUrl}}/phone/alert_settings/:alertSettingId

Gets detailed information about a specific Alert setting.

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:alert_setting:admin

Rate Limit Label: LIGHT

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "alert_setting_id": "<string>", "alert_setting_name": "<string>", "module": "<integer>", "rule": "<integer>", "rule_conditions": [ { "rule_condition_type": 2, "rule_condition_value": "<string>" }, { "rule_condition_type": 2, "rule_condition_value": "<string>" } ], "targets": [ { "target_id": "<string>", "target_name": "<string>", "target_type": 1, "target_extension_number": "<long>", "site": { "id": "<string>", "name": "<string>" }, "assignees": [ { "extension_number": "<long>", "name": "<string>", "extension_type": "commonArea", "extension_id": "<string>" }, { "extension_number": "<long>", "name": "<string>", "extension_type": "commonArea", "extension_id": "<string>" } ] }, { "target_id": "<string>", "target_name": "<string>", "target_type": 3, "target_extension_number": "<long>", "site": { "id": "<string>", "name": "<string>" }, "assignees": [ { "extension_number": "<long>", "name": "<string>", "extension_type": "user", "extension_id": "<string>" }, { "extension_number": "<long>", "name": "<string>", "extension_type": "commonArea", "extension_id": "<string>" } ] } ], "time_frame_type": "all_day", "time_frame_from": "<string>", "time_frame_to": "<string>", "frequency": 30, "email_recipients": [ "<string>", "<string>" ], "chat_channels": [ { "chat_channel_name": "<string>", "token": "<string>", "end_point": "<string>" }, { "chat_channel_name": "<string>", "token": "<string>", "end_point": "<string>" } ], "status": 1 }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/alert_settings/:alertSettingId' -H 'Accept: application/json'

ENDPOINTS