Bandwidth · JSON Structure

Mfa Mfa Voice Request Structure

MfaVoiceRequest schema from Bandwidth mfa API

Type: object Properties: 7 Required: 5
CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

MfaVoiceRequest is a JSON Structure definition published by Bandwidth, describing 7 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

from to applicationId scope message digits expirationTimeInMinutes

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/mfa-mfa-voice-request-structure.json",
  "name": "MfaVoiceRequest",
  "description": "MfaVoiceRequest schema from Bandwidth mfa API",
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "description": "The Bandwidth phone number to make the voice call from, in E.164 format",
      "example": "+19195551234"
    },
    "to": {
      "type": "string",
      "description": "The destination phone number to call with the MFA code, in E.164 format",
      "example": "+19195554321"
    },
    "applicationId": {
      "type": "string",
      "description": "The ID of the Bandwidth voice application to use for the call"
    },
    "scope": {
      "type": "string",
      "description": "An optional field to denote what scope or action the MFA code is for"
    },
    "message": {
      "type": "string",
      "description": "The message template spoken during the call. Use {CODE} as a placeholder for the generated MFA code.",
      "example": "Your verification code is {CODE}"
    },
    "digits": {
      "type": "int32",
      "minimum": 4,
      "maximum": 8,
      "description": "The number of digits in the generated MFA code (4-8)",
      "example": 6
    },
    "expirationTimeInMinutes": {
      "type": "double",
      "minimum": 1,
      "maximum": 15,
      "default": 3,
      "description": "The time in minutes before the MFA code expires (1-15, default 3 minutes)"
    }
  },
  "required": [
    "from",
    "to",
    "applicationId",
    "message",
    "digits"
  ]
}