Webex · Schema

HostedAgent

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Unique identifier for the person or workspace agent identified as call destination.
type object Type of agent for call destination.
firstName string First name for the hosted agent specified by `id`.
lastName string Last name for the hosted agent specified by `id`.
locationName string Name of hosted agent's location.
locationId string Unique identifier for hosted agent's location.
phoneNumber string Phone number for the hosted agent.
extension string Extension for the hosted agent.
View JSON Schema on GitHub

JSON Schema

webex-hostedagent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HostedAgent",
  "title": "HostedAgent",
  "type": "object",
  "required": [
    "id",
    "type",
    "firstName",
    "lastName",
    "locationName",
    "locationId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMjU4YjhmZi1lODIxLTQ3MDktYTI2My1mMmI4OWZjN2FlYmQ",
      "description": "Unique identifier for the person or workspace agent identified as call destination."
    },
    "type": {
      "$ref": "#/components/schemas/HostedAgentType",
      "description": "Type of agent for call destination."
    },
    "firstName": {
      "type": "string",
      "example": "firstName",
      "description": "First name for the hosted agent specified by `id`."
    },
    "lastName": {
      "type": "string",
      "example": "lastName",
      "description": "Last name for the hosted agent specified by `id`."
    },
    "locationName": {
      "type": "string",
      "example": "locationName",
      "description": "Name of hosted agent's location."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
      "description": "Unique identifier for hosted agent's location."
    },
    "phoneNumber": {
      "type": "string",
      "example": "9874531287",
      "description": "Phone number for the hosted agent."
    },
    "extension": {
      "type": "string",
      "example": "111",
      "description": "Extension for the hosted agent."
    }
  }
}