Call

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Call",
  "title": "Call",
  "type": "object",
  "required": [
    "id",
    "callSessionId",
    "personality",
    "state",
    "remoteParty",
    "created",
    "muteCapable",
    "muted"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA",
      "description": "The call identifier of the call."
    },
    "callSessionId": {
      "type": "string",
      "example": "MmFmNThiZjktYWE3Ny00NWE5LThiMDEtYzI4NDMxZWYwNzRm",
      "description": "The call session identifier of the call session the call belongs to. This can be used to correlate multiple calls that are part of the same call session."
    },
    "personality": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CallPersonalityEnum"
        }
      ],
      "description": " The personality of the call."
    },
    "state": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CallStateEnum"
        }
      ],
      "description": "The current state of the call."
    },
    "remoteParty": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PartyInformation"
        }
      ],
      "description": "The remote party's details. For example, if user A calls user B then B is the remote party in A's outgoing call details and A is the remote party in B's incoming call details."
    },
    "appearance": {
      "type": "number",
      "example": 1,
      "description": "The appearance value for the call. The appearance value can be used to display the user's calls in an order consistent with the user's devices. Only present when the call has an appearance value assigned."
    },
    "created": {
      "type": "string",
      "example": "2016-04-21T17:00:00.000Z",
      "description": "The date and time the call was created."
    },
    "answered": {
      "type": "string",
      "example": "2016-04-21T17:00:00.000Z",
      "description": "The date and time the call was answered. Only present when the call has been answered."
    },
    "redirections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RedirectionInformation"
      },
      "description": "The list of details for previous redirections of the incoming call ordered from most recent to least recent. For example, if user B forwards an incoming call to user C, then a redirection entry is present for B's forwarding in C's incoming call details. Only present when there were previous redirections and the incoming call's state is alerting."
    },
    "recall": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecallInformation"
        }
      ],
      "description": "The recall details for the incoming call. Only present when the incoming call is for a recall."
    },
    "recordingState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecordingStateEnum"
        }
      ],
      "description": "The call's current recording state. Only present when the user's call recording has been invoked during the life of the call."
    },
    "muteCapable": {
      "type": "boolean",
      "description": "Indicates whether the call is capable of using the [mute](/docs/api/v1/call-controls/mute) and [unmute](/docs/api/v1/call-controls/unmute) APIs.\u200b"
    },
    "muted": {
      "type": "boolean",
      "description": "Indicates whether the call is currently muted."
    }
  },
  "example": {
    "id": "string",
    "callSessionId": "string",
    "personality": "originator",
    "state": "connecting",
    "remoteParty": {
      "name": "string",
      "number": "string",
      "personId": "string",
      "placeId": "string",
      "privacyEnabled": true,
      "callType": "location"
    },
    "appearance": 1.23,
    "created": "string",
    "answered": "string",
    "redirections": [
      {
        "reason": "busy",
        "redirectingParty": {
          "status": "ok",
          "privacyEnabled": false,
          "callType": "external"
        }
      }
    ],
    "recall": {
      "type": "park",
      "party": {
        "status": "ok",
        "privacyEnabled": false,
        "callType": "external"
      }
    },
    "recordingState": "pending",
    "muteCapable": true,
    "muted": true
  }
}