Webex · Schema

ChatObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the chat snippet.
chatTime string Chat time for the chat snippet in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
text string The text of the chat snippet.
meetingId string A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the chat belongs.
type string Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message
sender object Information of the sender of the chat snippet.
receivers array Information of the receivers of the chat snippet.
View JSON Schema on GitHub

JSON Schema

webex-chatobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatObject",
  "title": "ChatObject",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "1aea8390-e375-4547-b7ff-58ecd9e0b03d",
      "description": "A unique identifier for the chat snippet."
    },
    "chatTime": {
      "type": "string",
      "example": "2021-07-06T09:22:34Z",
      "description": "Chat time for the chat snippet in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
    },
    "text": {
      "type": "string",
      "example": "hi",
      "description": "The text of the chat snippet."
    },
    "meetingId": {
      "type": "string",
      "example": "a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928",
      "description": "A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the chat belongs."
    },
    "type": {
      "type": "string",
      "example": "private",
      "description": "Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to \"host and presenter\"."
    },
    "sender": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "example": "[email protected]",
          "description": "Email address of the sender of the meeting chat snippet."
        },
        "displayName": {
          "type": "string",
          "example": "John Andersen",
          "description": "Display name for the sender."
        },
        "personId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81YmVkZWUyMC1hNjI3LTQ4YTUtODg0Yi04NjVhODhlZmFhNzM",
          "description": "A unique identifier for the sender."
        },
        "orgId": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81OWU2NzUyNy00NjUxLTRjOTAtYjJmMC00Zjg2YzNiYjY2MDg",
          "description": "The ID of the organization to which the sender belongs."
        }
      },
      "description": "Information of the sender of the chat snippet."
    },
    "receivers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "example": "[email protected]",
            "description": "Email address of the receiver of the meeting chat snippet."
          },
          "displayName": {
            "type": "string",
            "example": "Catherine Sinu",
            "description": "Display name for the receiver."
          },
          "personId": {
            "type": "string",
            "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81YmVkZWUyMC1hNjI3LTQ4YTUtODg0Yi04NjVhODhlZmFhNzM",
            "description": "A unique identifier for the receiver."
          },
          "orgId": {
            "type": "string",
            "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81OWU2NzUyNy00NjUxLTRjOTAtYjJmMC00Zjg2YzNiYjY2MDg",
            "description": "The ID of the organization to which the receiver belongs."
          }
        }
      },
      "description": "Information of the receivers of the chat snippet."
    }
  }
}