Vapi · Schema

RelayResponse

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
status string The status of the relay request
callId string The unique identifier of the call, if delivered to a live call
sessionId string The unique identifier of the session, if delivered to a headless session
chatId string
View JSON Schema on GitHub

JSON Schema

vapi-relayresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RelayResponse",
  "title": "RelayResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "deliveredLive",
        "deliveredHeadless",
        "failed"
      ],
      "description": "The status of the relay request"
    },
    "callId": {
      "type": "string",
      "description": "The unique identifier of the call, if delivered to a live call"
    },
    "sessionId": {
      "type": "string",
      "description": "The unique identifier of the session, if delivered to a headless session"
    },
    "chatId": {
      "type": "string"
    }
  },
  "required": [
    "status"
  ]
}