List internal numbers

GET

/accounts/{accountId}/sip_trunk/internal_numbers

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.

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

Prerequisites:

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

Scope: sip_trunk:master

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/accounts//sip_trunk/internal_numbers'

响应示例

200 - 示例 1

{
    "internal_numbers": [
        {
            "allow_for_external_meetings": true,
            "allow_join": true,
            "country": "string",
            "display_number": "string",
            "labels": "string",
            "languages": "en-GB",
            "number": "string",
            "type": 0,
            "visible": true
        }
    ],
    "next_page_token": "string",
    "page_size": 30,
    "total_records": 0
}

请求参数

Path 参数

accountId

string

必需

Unique identifier of the account. To 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.

Query 参数

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200` **OK** List of internal numbers returned.

application/json

Body

internal_numbers

array [object {9}]

可选

allow_for_external_meetings

boolean

可选

Control whether the number can be used to attend 3rd party meetings.

allow_join

boolean

可选

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.

country

string

必需

Two letter country code of the country.

display_number

string

必需

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.

labels

string

必需

A short description for the phone number.

languages

enum<string>

必需

Specify the language in which this phone number should be displayed. Currently, the only supported languages are en-GB, en-US, de-DE.

枚举值:

en-GBen-USde-DE

number

string

必需

Phone number in E164 format.

type

enum<integer>

必需

Type of phone number.

The value can be one of the following:

0 : toll

1 : tollfree

枚举值:

visible

boolean

可选

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.

next_page_token

string

可选

page_size

integer

可选

The number of records that you specified to get in the response per page.

默认值:

total_records

integer

可选

The total number of records returned.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` * Your account does not have the permission to make updates on this account. Only a master account can perform this action on a sub account. * Request failed because this account i

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `2001` Account does not exist: {0}.

修改于 2024-04-24 09:06:48

Delete internal call-out country

Add internal numbers