List phone numbers

GET

/phone/numbers

Phone

A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters.

Prerequisites:

Pro or higher plan with Zoom phone license
Scope: phone:read:admin
Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/numbers'

响应示例

{
  "next_page_token": "",
  "page_size": 30,
  "phone_numbers": [
    {
      "assignee": {
        "extension_number": 12,
        "id": "cgfdgfghghim",
        "name": "Peter Jenner",
        "type": "user"
      },
      "capability": [
        "incoming",
        "outgoing"
      ],
      "display_name": "abc",
      "id": "execvbfgbgr",
      "location": "Milpitas,California,United States",
      "number": "0000111100",
      "number_type": "tollfree",
      "site": {
        "id": "sdfsdfgrg",
        "name": "SF office"
      },
      "source": "internal",
      "status": "pending"
    },
    {
      "assignee": {
        "extension_number": 1,
        "id": "dfgdfghdfhgh",
        "name": "Receptionist",
        "type": "autoReceptionist"
      },
      "id": "fdgfdgfdh",
      "location": "San Jose,California,United States",
      "number": "111111111",
      "number_type": "toll",
      "site": {
        "id": "jhdfsdghfdg",
        "name": "San Jose office"
      },
      "source": "external",
      "status": "available"
    }
  ],
  "total_records": 2
}

请求参数

Query 参数

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.

type

enum<string>

可选

Query response by number assignment. The value can be one of the following:

assigned: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account.
unassigned: The number is not assigned to anyone.
all: Include both assigned and unassigned numbers in the response.
byoc: Include Bring Your Own Carrier (BYOC) numbers only in the response.

枚举值:

assignedunassignedall

extension_type

enum<string>

可选

The type of assignee to whom the number is assigned. The value can be one of the following:
user
callQueue
autoReceptionist
commonAreaPhone

枚举值:

usercallQueueautoReceptionistcommonAreaPhone

page_size

integer

可选

The number of records returned within a single API call.

<= 100

默认值:

number_type

enum<string>

可选

The type of phone number. The value can be either toll or tollfree.

枚举值:

tolltollfree

pending_numbers

boolean

可选

Include or exclude pending numbers in the response. The value can be either true or false.

site_id

string

可选

Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See Managing multiple sites or Adding a site for details.

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Phone numbers listed successfully.

application/json

Body

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call.

phone_numbers

array [object {12}]

可选

assignee

object

可选

capability

array[string]

可选

The capability for the phone number, whether it can take incoming calls, make outgoing calls, or both. Values include incoming, outgoing, or both of these values.

carrier

object

可选

Displayed when the type request parameter is byoc.

display_name

string

可选

The display name for the phone number.

string

可选

Unique Identifier of the Phone Number.

location

string

可选

Location (city, state and country) where the Phone number is assigned.

number

string

可选

Phone number in E164 format.

number_type

enum<string>

可选

The type of number. Values can be one of the following:
toll, tollfree

枚举值:

tolltollfree

sip_group

object

可选

Displayed when the type request parameter is byoc.

site

object

可选

source

enum<string>

可选

Source of phone number.

枚举值:

internalexternal

status

enum<string>

可选

Status of the number.

枚举值:

pendingavailable

total_records

integer

可选

The total number of records returned.

Change main company number

Get phone number details