Webex · Schema

CalloutResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
participantId	string	Participant ID. It can be used in the "Cancel Call Out a SIP Participant" API.
invitationCorrelationId	string	An internal ID that is associated with the call-out invitation.
meetingNumber	string	Number of the meeting to which the SIP participant is to be called out.
meetingId	string	Unique identifier of the meeting to which the SIP participant is to be called out.
address	string	SIP address of the invited SIP participant.
addressType	string	Type of the `address`. * `sipAddress` - SIP address.
displayName	string	The display name of the invited SIP participant.
state	string	The state of the invited SIP participant. * `pending` - The invited SIP participant is waiting for approval. Participants in the `pending` state will not be listed by the "List Meeting Participants" A

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CalloutResponse",
  "title": "CalloutResponse",
  "type": "object",
  "properties": {
    "participantId": {
      "type": "string",
      "example": "d8c3347d7ec04242ba9b856184b334ac_I_630641605678082408_57514861-50f7-3f5b-864f-ce0e308bf653",
      "description": "Participant ID. It can be used in the \"Cancel Call Out a SIP Participant\" API."
    },
    "invitationCorrelationId": {
      "type": "string",
      "example": "871ab255-64e6-4cd2-a5af-d33953898356",
      "description": "An internal ID that is associated with the call-out invitation."
    },
    "meetingNumber": {
      "type": "string",
      "example": "79100342367",
      "description": "Number of the meeting to which the SIP participant is to be called out."
    },
    "meetingId": {
      "type": "string",
      "example": "d8c3347d7ec04242ba9b856184b334ac",
      "description": "Unique identifier of the meeting to which the SIP participant is to be called out."
    },
    "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`.\n * `sipAddress` - SIP address.\n"
    },
    "displayName": {
      "type": "string",
      "example": "Brenda DX80",
      "description": "The display name of the invited SIP participant."
    },
    "state": {
      "type": "string",
      "enum": [
        "pending"
      ],
      "description": "The state of the invited SIP participant.\n * `pending` - The invited SIP participant is waiting for approval. Participants in the `pending` state will not be listed by the \"List Meeting Participants\" API.\n"
    }
  }
}