Logo
Zoom Public API Documentation

List SIP groups

GET {{baseUrl}}/phone/sip_groups?next_page_token=<string>&page_size=30

Use this API to list SIP (Session Initiation Protocol) groups.

Prerequisites: * Pro or a higher account with Zoom Phone license * Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:list_sip_groups:admin

Rate Limit Label: Light

 

Body PARAM

Key Datatype Required Description 
next_page_token
string The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size
number The number of records returned within a single API call.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_size": "<integer>", "sip_groups": [ { "description": "<string>", "display_name": "<string>", "id": "<string>", "send_sip_group_name": true, "sip_trunk": { "id": "<string>", "name": "<string>" } }, { "description": "<string>", "display_name": "<string>", "id": "<string>", "send_sip_group_name": false, "sip_trunk": { "id": "<string>", "name": "<string>" } } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/sip_groups?next_page_token=<string>&page_size=30?next_page_token=<string>&page_size=30' -H 'Accept: application/json'

ENDPOINTS