Bandwidth · JSON Structure

Voice Update Conference Request Structure

UpdateConferenceRequest schema from Bandwidth voice API

Type: object Properties: 4
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

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

Properties

status redirectUrl redirectMethod 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-conference-request-structure.json",
  "name": "UpdateConferenceRequest",
  "description": "UpdateConferenceRequest schema from Bandwidth voice API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "active",
        "completed"
      ],
      "description": "Set to completed to end the conference and disconnect all members"
    },
    "redirectUrl": {
      "type": "uri",
      "description": "URL to redirect the conference to for new BXML instructions"
    },
    "redirectMethod": {
      "type": "string",
      "enum": [
        "POST",
        "GET"
      ],
      "default": "POST",
      "description": "The HTTP method for the redirect webhook"
    },
    "tag": {
      "type": "string",
      "description": "Custom tag for the conference"
    }
  }
}