Request a MFA token via phone call
POST/mfa/call
Request a MFA token via phone call
Permissions
The API token must include one of the following scopes: Voice or Messaging or Fax.
Request
- application/json
Body
required
The E164 number to use as the destination.
+14043287382
The E164 number from your account to use as the origin of the call. SignalWire will use a special verified number if not specified. If using a different caller ID, make sure it is a number you have purchased or have verified on your SignalWire account.
+12029167968
The message to play to the caller before the token is read. The message must be at most 500 characters. Defaults to "Your Personal Authorization Code is".
Here is your code
The number of characters in the token, from 4 to 20. Defaults to 6.
6
The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3.
3
Set to true
or false
, whether to include letters or just numbers in the token. Defaults to false
(numbers only).
false
The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800.
3600
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
The MFA request ID. Save this for verification.
Whether the request was successfully queued.
true
The destination of the MFA request.
+15554422333
Can be sms
for a text message or call
for a phone call.
call
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"success": true,
"to": "+15554422333",
"channel": "call"
}