Get detailed information about a specific .
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
Scopes:phone:write:admin
: Light
643 matches
60 actions
Zoom
60 actions
Communication/Zoom
Get detailed information about a specific .
Prerequisites:
phone:write:admin: Light
{
"type": "object",
"properties": {
"deviceId": {
"type": "string"
}
},
"required": [
"deviceId"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"assignee": {
"type": "object",
"description": "User to whom the device has been assigned.",
"properties": {
"extension_number": {
"type": "integer",
"description": "Extension number of the Zoom Phone used by the user."
},
"id": {
"type": "string",
"description": "User ID of the user to whom the device has been assigned."
},
"name": {
"type": "string",
"description": "Name of the user."
}
}
},
"device_type": {
"type": "string",
"description": "Includes manufacturer name and the model name."
},
"display_name": {
"type": "string",
"description": "Display name of the device."
},
"id": {
"type": "string",
"description": "Device ID - Unique Identifier of the Device."
},
"mac_address": {
"type": "string",
"description": "MAC address or serial number of the device."
},
"provision": {
"type": "object",
"description": "Provisioning information of a device.",
"properties": {
"sip_accounts": {
"type": "array",
"description": "SIP Account details registered during the device provisioning process. This object will only be returned if manual provisioning was used for the device. ",
"items": {
"type": "object",
"properties": {
"authorization_id": {
"type": "string",
"description": "Authorization ID of the SIP account provided in the provisioning process."
},
"outbound_proxy": {
"type": "string",
"description": "Outbound proxy provided in the provisioning process."
},
"password": {
"type": "string",
"description": "Password entered during the provisioning process. "
},
"shared_line": {
"type": "object",
"description": "Return additional provisioning information with generic device SIP credentials.",
"properties": {
"alias": {
"type": "string",
"description": "Alias."
},
"line_subscription": {
"type": "object",
"description": "Line subscription.",
"properties": {
"display_name": {
"type": "string",
"description": "Display name."
},
"extension_number": {
"type": "integer",
"description": "Extension number."
},
"phone_number": {
"type": "string",
"description": "Phone number."
}
}
},
"outbound_caller_id": {
"type": "string",
"description": "Outbound caller ID."
}
}
},
"sip_domain": {
"type": "string",
"description": "SIP Domain provided in the provisioning process.<br> \n "
},
"user_name": {
"type": "string",
"description": "User name of the SIP account provided in the provisioning process."
}
}
}
},
"type": {
"type": "string",
"description": "[Provisioning type](https://support.zoom.us/hc/en-us/articles/360033223411). The value can be one of the following:\n\n* `ztp` : Zero touch provisioning.\n* `assisted`: Assisted provisioning.\n* `manual`: Manual provisioning. \n\n",
"enum": [
"assisted",
"ztp",
"manual"
]
},
"url": {
"type": "string",
"description": "Provisioning URL. This field will only be returned for devices that were provisioned via `assisted` provisioning type."
}
}
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The [site](https://support.zoom.us/hc/en-us/articles/360020809672) of the phone user."
},
"name": {
"type": "string",
"description": "Name of the [site](https://support.zoom.us/hc/en-us/articles/360020809672)."
}
}
},
"status": {
"type": "string",
"description": "Status of the device. The value is either `online` or `offline`.",
"enum": [
"online",
"offline"
]
}
}
}