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
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: '+15551234567',
verification_method: 'sms',
});
console.log(verifiedNumber.phone_number);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
verified_number = client.verified_numbers.create(
phone_number="+15551234567",
verification_method="sms",
)
print(verified_number.phone_number)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
verifiedNumber, err := client.VerifiedNumbers.New(context.TODO(), telnyx.VerifiedNumberNewParams{
PhoneNumber: "+15551234567",
VerificationMethod: telnyx.VerifiedNumberNewParamsVerificationMethodSMS,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", verifiedNumber.PhoneNumber)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateParams;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
VerifiedNumberCreateParams params = VerifiedNumberCreateParams.builder()
.phoneNumber("+15551234567")
.verificationMethod(VerifiedNumberCreateParams.VerificationMethod.SMS)
.build();
VerifiedNumberCreateResponse verifiedNumber = client.verifiedNumbers().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
verified_number = telnyx.verified_numbers.create(phone_number: "+15551234567", verification_method: :sms)
puts(verified_number)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$verifiedNumber = $client->verifiedNumbers->create(
phoneNumber: '+15551234567', verificationMethod: 'sms', extension: 'ww243w1'
);
var_dump($verifiedNumber);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx verified-numbers create \
--api-key 'My API Key' \
--phone-number +15551234567 \
--verification-method smscurl --request POST \
--url https://api.telnyx.com/v2/verified_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "+15551234567",
"verification_method": "sms"
}
'{
"phone_number": "+15551234567",
"verification_method": "sms"
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Example:
"+15551234567"
Verification method.
Available options:
sms, call Example:
"sms"
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:
50Pattern:
^[0-9A-D*#wW]*$Example:
"ww243w1"
Was this page helpful?
⌘I
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: '+15551234567',
verification_method: 'sms',
});
console.log(verifiedNumber.phone_number);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
verified_number = client.verified_numbers.create(
phone_number="+15551234567",
verification_method="sms",
)
print(verified_number.phone_number)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
verifiedNumber, err := client.VerifiedNumbers.New(context.TODO(), telnyx.VerifiedNumberNewParams{
PhoneNumber: "+15551234567",
VerificationMethod: telnyx.VerifiedNumberNewParamsVerificationMethodSMS,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", verifiedNumber.PhoneNumber)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateParams;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
VerifiedNumberCreateParams params = VerifiedNumberCreateParams.builder()
.phoneNumber("+15551234567")
.verificationMethod(VerifiedNumberCreateParams.VerificationMethod.SMS)
.build();
VerifiedNumberCreateResponse verifiedNumber = client.verifiedNumbers().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
verified_number = telnyx.verified_numbers.create(phone_number: "+15551234567", verification_method: :sms)
puts(verified_number)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$verifiedNumber = $client->verifiedNumbers->create(
phoneNumber: '+15551234567', verificationMethod: 'sms', extension: 'ww243w1'
);
var_dump($verifiedNumber);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx verified-numbers create \
--api-key 'My API Key' \
--phone-number +15551234567 \
--verification-method smscurl --request POST \
--url https://api.telnyx.com/v2/verified_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_number": "+15551234567",
"verification_method": "sms"
}
'{
"phone_number": "+15551234567",
"verification_method": "sms"
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {
"url": "<string>"
}
}
]
}