Bandwidth · Schema

MfaVoiceRequest

MfaVoiceRequest schema from Bandwidth mfa API

CommunicationsCPaaSVoiceMessagingTelephonySMSMFA

Properties

Name	Type	Description
from	string	The Bandwidth phone number to make the voice call from, in E.164 format
to	string	The destination phone number to call with the MFA code, in E.164 format
applicationId	string	The ID of the Bandwidth voice application to use for the call
scope	string	An optional field to denote what scope or action the MFA code is for
message	string	The message template spoken during the call. Use {CODE} as a placeholder for the generated MFA code.
digits	integer	The number of digits in the generated MFA code (4-8)
expirationTimeInMinutes	number	The time in minutes before the MFA code expires (1-15, default 3 minutes)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bandwidth/refs/heads/main/json-schema/mfa-mfa-voice-request-schema.json",
  "title": "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": "integer",
      "minimum": 4,
      "maximum": 8,
      "description": "The number of digits in the generated MFA code (4-8)",
      "example": 6
    },
    "expirationTimeInMinutes": {
      "type": "number",
      "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"
  ]
}