Get a shared line group

v1.0.0

A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.

Prerequisties:

Pro or higher account with Zoom Phone license.
Account owner or admin privileges

Scopes: phone:read:admin or phone:write:admin

: Light

Input

{
  "type": "object",
  "properties": {
    "sharedLineGroupId": {
      "type": "string"
    }
  },
  "required": [
    "sharedLineGroupId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "display_name": {
      "type": "string",
      "description": "Display Name of the Shared Line Group."
    },
    "extension_number": {
      "type": "integer",
      "description": "Extension number assigned to the Shared Line Group."
    },
    "id": {
      "type": "string",
      "description": "Unique Identifier of the Shared Line Group."
    },
    "members": {
      "type": "object",
      "description": "View current [members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_3ffbbb77-a009-4c09-91e4-81fc264b61d6) of the shared line group.",
      "properties": {
        "common_area_phones": {
          "type": "array",
          "description": "[Common Area Phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) that are members of the shared line group.",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the [Common Area Phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). "
              },
              "name": {
                "type": "string",
                "description": "Name of the [Common Area Phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). "
              }
            }
          }
        },
        "users": {
          "type": "array",
          "description": "Users who are members of the Shared Line Group.",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the user."
              },
              "name": {
                "type": "string",
                "description": "Name of the user."
              }
            }
          }
        }
      }
    },
    "phone_numbers": {
      "type": "array",
      "description": "Object representing information about phone number(s) assigned to the group.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the phone number."
          },
          "number": {
            "type": "string",
            "description": "Phone number in E164 format."
          }
        }
      }
    },
    "primary_number": {
      "type": "string",
      "description": "If you have multiple direct phone numbers assigned to the shared line group, this is the primary number selected for desk phones. The primary number shares the same line as the extension number. This means if a caller is routed to the shared line group through an auto receptionist, the line associated with the primary number will be used."
    },
    "site": {
      "type": "object",
      "description": "Site assigned to the Shared Line Group.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique Identifier of the [Site](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/getasite)."
        },
        "name": {
          "type": "string",
          "description": "Name of the Site."
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Status of the Shared Line Group.",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "Timezone used for the Business Hours."
    }
  }
}