Get phone number details

A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to get details on a specific Phone number in a Zoom account.

Prerequisites:

Pro or higher plan with Zoom phone license
Scope: phone:read:admin

Rate Limit Label: Light

{ "assignee": { "extension_number": 10000, "name": "Main Auto Receptionist", "type": "autoReceptionist" }, "capability": [ "incoming", "outgoing" ], "display_name": "abc", "id": "Hfdgdfgdfg1ew", "location": "Milpitas,California,United States", "number": "+140000007", "number_type": "toll", "site": { "id": "CEfdfdfgA", "name": "Main Site" }, "source": "internal", "status": "available" }

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Phone number details retrieved successfully.

application/json

Body

assignee

object

可选

extension_number

integer

可选

Extension number of the Phone.

string

可选

Unique Identifier of the user to whom the number has been assigned.

name

string

可选

Name of the user to whom the number has been assigned.

type

enum<string>

可选

Indicates who the phone number belongs to.
user: Number has been assigned to an existing phone user allowing them to receive calls through their extension number or direct phone number.
callQueue: Phone number has been assigned to a call queue.
commonAreaPhone: Phone number has been assigned to a provisioned common area desk phone.
autoReceptionist: Phone number has been assigned to an auto receptionist.

枚举值:

usercallQueueautoReceptionistcommonAreaPhone

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.

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

site

object

可选

string

可选

Target site in which the phone number was assigned. Sites allow you to organize the phone users in your organization. For example, you sites could be created based on different office locations.

name

string

可选

Name of the site where the phone number is assigned.

source

enum<string>

可选

Source of phone number.

枚举值:

internalexternal

status

enum<string>

可选

Status of the number.

枚举值:

pendingavailable

🟠400**HTTP Status Code:** `400` **Bad Request**<br> **Error Code:** `400`<br> Phone number does not exist, phonenumberId:{phoneNumberId}

Get phone number details

请求参数

返回响应