Send a one-time passcode by phone call

POST 
/api/v1/voice-otp

Places a call to to and reads out code, digit by digit. The call is placed asynchronously: the response acknowledges that the job was accepted and reserved credit, not that the phone rang. Keep the returned callId and poll the status endpoint to learn the outcome.

Required capability: VOICE_OTP

Request

Responses

202

The call has been accepted and credit reserved.

400

Invalid payload, or no route available for this destination.

401

Missing or invalid API key.

402

Insufficient credit to place the call.

403

A capability required by this endpoint is not enabled on your account. Ask your account manager to switch it on.

429

Too many requests. Back off and retry.

503

The telephony engine is momentarily unreachable. Retry shortly.