Webex · Schema

InProgressDevice

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
correlationId string An internal ID that is associated with each join.
deviceType string The type of device.
audioType string The audio type that the participant is using. * `pstn` - `PSTN` * `voip` - `VoIP` * `inactive` - The participant is not connected to audio.
joinedTime string The time the device joined the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `joinedTime` will be filled in after the meeting ended
leftTime string The time the device left the meeting, `leftTime` is the exact moment when a specific device left the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still
View JSON Schema on GitHub

JSON Schema

webex-inprogressdevice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InProgressDevice",
  "title": "InProgressDevice",
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string",
      "example": "8ccced6c-b812-4dff-a5dd-4c5c28f8d47d",
      "description": "An internal ID that is associated with each join."
    },
    "deviceType": {
      "type": "string",
      "example": "mac",
      "description": "The type of device."
    },
    "audioType": {
      "type": "string",
      "enum": [
        "pstn",
        "voip",
        "inactive"
      ],
      "description": "The audio type that the participant is using.\n * `pstn` - `PSTN`\n * `voip` - `VoIP`\n * `inactive` - The participant is not connected to audio.\n"
    },
    "joinedTime": {
      "type": "string",
      "example": "2019-04-23T17:31:00.000Z",
      "description": "The time the device joined the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `joinedTime` will be filled in after the meeting ended. If you need real-time joined events, please refer to the webhooks guide."
    },
    "leftTime": {
      "type": "string",
      "example": "2019-04-23T17:32:00.000Z",
      "description": "The time the device left the meeting, `leftTime` is the exact moment when a specific device left the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `leftTime` will be filled in after the meeting ended. If you need real-time left events, please refer to the webhooks guide."
    }
  }
}