Bandwidth · Schema

UpdateCallRequest

UpdateCallRequest schema from Bandwidth voice API

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name Type Description
state string Set to completed to hang up the call
redirectUrl string The URL to redirect the call to for new BXML instructions
redirectMethod string The HTTP method for the redirect webhook
redirectFallbackUrl string Fallback URL if the primary redirect URL fails
redirectFallbackMethod string The HTTP method for the fallback redirect webhook
tag string A custom string to attach to the call for tracking purposes
View JSON Schema on GitHub

JSON Schema

voice-update-call-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/voice-update-call-request-schema.json",
  "title": "UpdateCallRequest",
  "description": "UpdateCallRequest schema from Bandwidth voice API",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "active",
        "completed"
      ],
      "description": "Set to completed to hang up the call"
    },
    "redirectUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL to redirect the call to for new BXML instructions"
    },
    "redirectMethod": {
      "type": "string",
      "enum": [
        "POST",
        "GET"
      ],
      "default": "POST",
      "description": "The HTTP method for the redirect webhook"
    },
    "redirectFallbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "Fallback URL if the primary redirect URL fails"
    },
    "redirectFallbackMethod": {
      "type": "string",
      "enum": [
        "POST",
        "GET"
      ],
      "default": "POST",
      "description": "The HTTP method for the fallback redirect webhook"
    },
    "tag": {
      "type": "string",
      "maxLength": 256,
      "description": "A custom string to attach to the call for tracking purposes"
    }
  }
}