643 matches
60 actions
Zoom
60 actions
Communication/Zoom
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:
phone:read:admin: Light
{
"type": "object",
"properties": {
"numberId": {
"type": "string"
}
},
"required": [
"numberId"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"assignee": {
"type": "object",
"properties": {
"extension_number": {
"type": "integer",
"description": "Extension number of the Phone."
},
"id": {
"type": "string",
"description": "Unique Identifier of the user to whom the number has been assigned."
},
"name": {
"type": "string",
"description": "Name of the user to whom the number has been assigned."
},
"type": {
"type": "string",
"description": "Indicates who the phone number belongs to.<br>\n`user`: Number has been assigned to an existing phone user allowing them to receive calls through their extension number or direct phone number.<br> `callQueue`: Phone number has been assigned to a [call queue](https://support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).<br> `commonAreaPhone`: Phone number has been assigned to a [ provisioned common area desk phone](https://support.zoom.us/hc/en-us/articles/360021119092-Provisioning-Phones-and-Devices).<br>\n`autoReceptionist`: Phone number has been assigned to an [auto receptionist](https://support.zoom.us/hc/en-us/articles/360021121312-Managing-Auto-Receptionists-and-Integrated-Voice-Response-IVR-).<br>",
"enum": [
"user",
"callQueue",
"autoReceptionist",
"commonAreaPhone"
]
}
}
},
"capability": {
"type": "array",
"description": "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.",
"items": {
"type": "string"
}
},
"display_name": {
"type": "string",
"description": "The display name for the phone number."
},
"id": {
"type": "string",
"description": "Unique Identifier of the Phone Number."
},
"location": {
"type": "string",
"description": "Location (city, state and country) where the Phone number is assigned."
},
"number": {
"type": "string",
"description": "Phone number in E164 format."
},
"number_type": {
"type": "string",
"description": "The type of number. Values can be one of the following:<br>\n`toll`, `tollfree`",
"enum": [
"toll",
"tollfree"
]
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Target [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) 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": {
"type": "string",
"description": "Name of the site where the phone number is assigned."
}
}
},
"source": {
"type": "string",
"description": "Source of phone number.",
"enum": [
"internal",
"external"
]
},
"status": {
"type": "string",
"description": "Status of the number.",
"enum": [
"pending",
"available"
]
}
}
}