Bandwidth · JSON Structure

Voice Update Call Request Structure

UpdateCallRequest schema from Bandwidth voice API

Type: object Properties: 6
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

UpdateCallRequest is a JSON Structure definition published by Bandwidth, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

state redirectUrl redirectMethod redirectFallbackUrl redirectFallbackMethod tag

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-structure/voice-update-call-request-structure.json",
  "name": "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": "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": "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"
    }
  }
}