mcp_config_sip_trunk_management.json•8.96 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "Using this API, a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) owner can assign SIP trunk(s) to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "post_phone_s_i_p_trunk"
},
{
"description": "Update details of a SIP trunk that is assigned to a sub account.\u003cbr\u003e **Scope**:\u003cbr\u003e * `phone:master` \u003cbr\u003e **Prerequisites**:\u003cbr\u003e Business or Enterprise Account.\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "update_phone_s_i_p_trunk"
},
{
"description": "Specify the list of [call-out](https://support.zoom.us/hc/en-us/articles/200942859-How-To-Use-Telephone-Call-Out-) countries for a master account or a sub account. To add call-out enabled countries to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To add call-out enabled countries 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_callout_countries"
},
{
"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 assign internal numbers 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": "assign_sip_trunk_numbers"
},
{
"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\u003e Using this API, a master account owner can copy the SIP Connected Audio configurations applied on the master account and enable those configurations on a sub account. The owner can also disable the configuration in the sub account where it was previously enabled. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with SIP Connected Audio plan enabled. * master account Owner\u003cbr\u003e **Scopes:** `sip_trunk:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "assign_s_i_p_config"
},
{
"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\u2019 IP telephony network, will be connected over this trunk rather than over the PSTN.\u003cbr\u003e\u003cbr\u003e Use this API to list all the SIP trunks assigned to a master account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the `accountId` path parameter. To retrieve SIP trunks of a master account, provide `me` as the value of the `accountId` path parameter. \u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:read:admin` \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account must either be a master account or a sub account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.",
"name": "list_s_i_p_trunks"
},
{
"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\u2019 IP telephony network, will be connected over this trunk rather than over the PSTN.\u003cbr\u003e\u003cbr\u003eUse this API to assign SIP trunk(s) that are available on a master account to a sub account. \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a master account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`",
"name": "assign_s_i_p_trunks"
},
{
"description": "Use this API to remove existing SIP trunk of a sub account.\u003cbr\u003e \u003cbr\u003e\u003cb\u003ePrerequisites:\u003c/b\u003e\u003cbr\u003e * The account making this API request must be a master account with [API Partner Plan](https://zoom.us/plan/api) and SIP Connected Audio Plan.\u003cbr\u003e\u003cbr\u003e **Scope:** `sip_trunk:master`",
"name": "delete_s_i_p_trunk"
},
{
"description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "device_list"
},
{
"description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `h323:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "device_delete"
},
{
"description": "List [BYOC SIP trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf) that are assigned to an account. **Scopes**:\u003cbr\u003e * `phone:write:admin` or `phone:master`\u003cbr\u003e **Prerequisites**:\u003cbr\u003e * Business or Enterprise Account \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "list_b_y_o_c_s_i_p_trunk"
},
{
"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 list all the numbers that are configured for SIP Connected Audio in a Zoom 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` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "list_sip_trunk_numbers"
}
]
}