V1CallerIds

Initiate voice verification for a caller ID

Changed on
post/v1/CallerIds/VoiceVerifications

Request

  • Base URL
    https://numbers.twilio.com
  • URL
    https://numbers.twilio.com/v1/CallerIds/VoiceVerifications
  • Auth
    HTTP basic

Request body

phone_numberstring required

The phone number to verify in E.164 format.

friendly_namestring

A human-readable name for the caller ID.

custom_codestring

A custom verification code to use instead of a generated one.

call_delaystring

Number of seconds to delay the verification call (0-60).

status_callbackstring uri

URL to receive status callback events.

status_callback_method'HEAD' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE'

HTTP method for status callback requests.

extensionstring

Phone extension to dial after connecting.

custom_success_messagestring

Custom message to play after successful verification.

Response

Voice verification initiated

accountSidstring

The Account SID that owns this verification.

phoneNumberstring

The phone number being verified in E.164 format.

friendlyNamestring nullable

A human-readable name for this caller ID.

validationCodestring

The 6-digit validation code to be entered during the call.

callSidstring

The Call SID for the verification call.

Changes