Request phone number verification

Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.

POST /verified_numbers

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const verifiedNumber = await client.verifiedNumbers.create({
  phone_number: '[phone]',
  verification_method: 'sms',
});

console.log(verifiedNumber.phone_number);

200

{
  "phone_number": "[phone]",
  "verification_method": "sms"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

phone_number · string · required

Example:

"[phone]"

verification_method · enum<string> · required

Verification method.

Available options: sms, call

Example:

"sms"

extension · string

Optional DTMF extension sequence to dial after the call is answered. This parameter enables verification of phone numbers behind IVR systems that require extension dialing. Valid characters: digits 0-9, letters A-D, symbols * and #. Pauses: w = 0.5 second pause, W = 1 second pause. Maximum length: 50 characters. Only works with 'call' verification method.

Maximum string length: 50

Pattern: ^[0-9A-D*#wW]*$

Example:

"ww243w1"

Response

200

application/json

Expected response to a valid request.

phone_number · string

Example:

"[phone]"

verification_method · string

Example:

"sms"