Webex · Schema

PartyInformation

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name string The party's name. Only present when the name is available and privacy is not enabled.
number string The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`, `+12223334444`, `*7
personId string The party's person ID. Only present when the person ID is available and privacy is not enabled.
placeId string The party's place ID. Only present when the place ID is available and privacy is not enabled.
privacyEnabled boolean Indicates whether privacy is enabled for the name, number and personId/placeId.
callType object The call type for the party.
View JSON Schema on GitHub

JSON Schema

webex-partyinformation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PartyInformation",
  "title": "PartyInformation",
  "type": "object",
  "required": [
    "privacyEnabled",
    "callType"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "John Smith",
      "description": "The party's name. Only present when the name is available and privacy is not enabled."
    },
    "number": {
      "type": "string",
      "example": "+12223334444",
      "description": "The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`, `+12223334444`, `*73`, `[email protected]`"
    },
    "personId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
      "description": "The party's person ID. Only present when the person ID is available and privacy is not enabled."
    },
    "placeId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ4MmEyLTRlNjktNTlhYS05ZjJmLWJjYTYzMTAxM2E2OA==",
      "description": "The party's place ID. Only present when the place ID is available and privacy is not enabled."
    },
    "privacyEnabled": {
      "type": "boolean",
      "description": "Indicates whether privacy is enabled for the name, number and personId/placeId."
    },
    "callType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CallTypeEnum"
        }
      ],
      "description": "The call type for the party."
    }
  }
}