Webex · Schema

CalloutRequest

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
meetingId	string	Unique identifier of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified.
meetingNumber	string	Number of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified.
address	string	SIP address of the invited SIP participant.
addressType	string	Type of the `address`. The default value is `sipAddress`. * `sipAddress` - SIP address.
invitationCorrelationId	string	An internal ID that is associated with the call-out invitation. Only UUIDs with hyphens are supported. The letters in the UUID must be in lowercase. A random UUID will be generated automatically if no
displayName	string	The display name of the invited SIP participant. The maximum length is 32 characters.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CalloutRequest",
  "title": "CalloutRequest",
  "type": "object",
  "required": [
    "address",
    "displayName"
  ],
  "properties": {
    "meetingId": {
      "type": "string",
      "example": "d8c3347d7ec04242ba9b856184b334ac",
      "description": "Unique identifier of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified."
    },
    "meetingNumber": {
      "type": "string",
      "example": "79100342367",
      "description": "Number of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified."
    },
    "address": {
      "type": "string",
      "example": "SIP:[email protected]",
      "description": "SIP address of the invited SIP participant."
    },
    "addressType": {
      "type": "string",
      "enum": [
        "sipAddress"
      ],
      "description": "Type of the `address`. The default value is `sipAddress`.\n * `sipAddress` - SIP address.\n"
    },
    "invitationCorrelationId": {
      "type": "string",
      "example": "871ab255-64e6-4cd2-a5af-d33953898356",
      "description": "An internal ID that is associated with the call-out invitation. Only UUIDs with hyphens are supported. The letters in the UUID must be in lowercase. A random UUID will be generated automatically if not specified."
    },
    "displayName": {
      "type": "string",
      "example": "Brenda DX80",
      "description": "The display name of the invited SIP participant. The maximum length is 32 characters."
    }
  }
}