mcp_config_internal_number_handling.json•3.6 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "This API allows a master account with SIP Connected Audio plan to list internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) assigned to a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo list internal numbers of a sub account, provide the account ID of the sub account in the `accountId` path parameter. To list internal numbers of a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`",
"name": "list_internal_numbers"
},
{
"description": "This API allows a master account with SIP Connected Audio plan to assign internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) to a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo add internal numbers to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add internal numbers to a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`",
"name": "add_internal_numbers"
},
{
"description": "This API allows a master account with SIP Connected Audio plan to delete a previously assigned internal phone number from a master account or a sub account.\u003cbr\u003e\u003cbr\u003eTo delete an internal number from a sub account, provide the account ID of the sub account in the `accountId` path parameter. To delete an internal number from a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) with SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`",
"name": "delete_internal_number"
},
{
"description": "With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer\u2019s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers\u0027 IP telephony network, will be connected over this trunk rather than over the PSTN. \u003cbr\u003e\u003cbr\u003eUse this API to delete all internal numbers assigned to a sub account. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a master account\u003cbr\u003e **Scopes:** `sip_trunk:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_all_sip_numbers"
}
]
}