list_phone_users
Retrieve a list of Zoom phone users by specifying site ID, page size, and next page token for efficient user management and integration with Zoom API MCP Server.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next_page_token | No | Next page token | |
| page_size | No | Number of records returned | |
| site_id | No | Site ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"next_page_token": {
"description": "Next page token",
"type": "string"
},
"page_size": {
"description": "Number of records returned",
"maximum": 300,
"minimum": 1,
"type": "number"
},
"site_id": {
"description": "Site ID",
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/tools/phone.js:13-25 (handler)The handler function constructs query parameters from inputs and calls the Zoom API GET /phone/users endpoint to list phone users, then processes the response or error.handler: async ({ page_size, next_page_token, site_id }) => { try { const params = {}; if (page_size) params.page_size = page_size; if (next_page_token) params.next_page_token = next_page_token; if (site_id) params.site_id = site_id; const response = await zoomApi.get('/phone/users', { params }); return handleApiResponse(response); } catch (error) { return handleApiError(error); } }
- src/tools/phone.js:8-12 (schema)Zod-based input schema defining optional parameters for pagination (page_size, next_page_token) and filtering (site_id).schema: { page_size: z.number().min(1).max(300).optional().describe("Number of records returned"), next_page_token: z.string().optional().describe("Next page token"), site_id: z.string().optional().describe("Site ID") },
- src/server.js:51-51 (registration)Registers the entire phoneTools array (imported from './tools/phone.js'), which includes the 'list_phone_users' tool, with the MCP server using the generic registerTools function.registerTools(phoneTools);