Webex · Schema

DirectMessage

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	The unique identifier for the message.
roomId	string	The room ID of the message.
roomType	string	The type of room. Will always be `direct`.
text	string	The message, in plain text. If `markdown` is specified this parameter may be optionally used to provide alternate text for UI clients that do not support rich text.
markdown	string	The message, in Markdown format.
files	array	Public URLs for files attached to the message. For the supported media types and the behavior of file uploads, see [Message Attachments](/docs/api/basics#message-attachments).
personId	string	The person ID of the message author.
personEmail	string	The email address of the message author.
created	string	The date and time the message was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DirectMessage",
  "title": "DirectMessage",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
      "description": "The unique identifier for the message."
    },
    "roomId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vODQxZjY5MjAtNDdlZC00NmE0LWI2YmItZTVjM2M1YTc3Yzgy",
      "description": "The room ID of the message."
    },
    "roomType": {
      "type": "string",
      "example": "direct",
      "description": "The type of room. Will always be `direct`."
    },
    "text": {
      "type": "string",
      "example": "Hey there, what do you think of this project update presentation (http://sharepoint.example.com/presentation.pptx)?",
      "description": "The message, in plain text. If `markdown` is specified this parameter may be *optionally* used to provide alternate text for UI clients that do not support rich text."
    },
    "markdown": {
      "type": "string",
      "example": "Hey there, what do you think of [this project update presentation](http://sharepoint.example.com/presentation.pptx)?",
      "description": "The message, in Markdown format."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "http://www.example.com/images/media.png"
      },
      "description": "Public URLs for files attached to the message. For the supported media types and the behavior of file uploads, see [Message Attachments](/docs/api/basics#message-attachments)."
    },
    "personId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "description": "The person ID of the message author."
    },
    "personEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address of the message author."
    },
    "created": {
      "type": "string",
      "example": "2015-10-18T14:26:16+00:00",
      "description": "The date and time the message was created."
    }
  }
}