POST /accounts/{accountId}/sip_trunk/internal_numbers

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.

To 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.
Prerequisites:

The account making this API request must be a master account with SIP Connected Audio Plan.

Scope: sip_trunk:master

Servers

https://api.zoom.us/v2

Path parameters

Name	Type	Required	Description
`accountId`	String	Yes	Unique identifier of the account. To 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.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`internal_numbers[]`	Array	No
`internal_numbers[].labels`	String	Yes	A short description for the phone number.
`internal_numbers[].number`	String	Yes	Phone number in E164 format.
`internal_numbers[].visible`	Boolean	No	Specify whether you want this number to be visible (in Zoom Client and Zoom Portal) to the account users or not. The value could be one of the following: `true`: Make the number visible. `false`: Hide the number.
`internal_numbers[].allow_join`	Boolean	No	Specify whether this number can be used by users to join a meeting or not. `true` : This number can be used to join a meeting. `false`: This number can not be used to join a meeting. Note that if the value of `visible` field is set to `true`, the value of this field will always be `true`.
`internal_numbers[].display_number`	String	Yes	Phone number with display format. For instance, if the value in the number field is `+1888888000`, the value of this field could be `+1 888 888 000`.
`internal_numbers[].allow_for_external_meetings`	Boolean	No	Control whether the number can be used to attend 3rd party meetings.
`internal_numbers[].type`	Integer	Yes	Type of phone number. The value can be one of the following: `0` : toll `1` : tollfree Valid values: `0` `1`
`internal_numbers[].country`	String	Yes	Two letter country code of the country.
`internal_numbers[].languages`	String	Yes	Specify the language in which this phone number should be displayed. Currently, the only supported languages are `en-GB`, `en-US`, `de-DE`. Valid values: `"en-US"` `"en-GB"` `"de-DE"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.