Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const createVerificationResponse = await client.verifications.triggerSMS({ phone_number: '+13035551234', verify_profile_id: '12ade33a-21c0-473b-b055-b3c836e1c292', }); console.log(createVerificationResponse.data);

{ "data": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "sms", "record_type": "verification", "phone_number": "+13035551234", "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292", "custom_code": "43612", "timeout_secs": 300, "status": "accepted", "created_at": "2020-09-14T17:03:32.965812", "updated_at": "2020-09-14T17:03:32.965812" } }

Authorizations

Authorization

string

header

required

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

Body

application/json

The request body when creating a verification.

phone_number

string

required

+E164 formatted phone number.

Example:

"+13035551234"

verify_profile_id

string<uuid>

required

The identifier of the associated Verify profile.

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

custom_code

string | null

Send a self-generated numeric code to the end-user

Example:

"43612"

timeout_secs

integer

The number of seconds the verification code is valid for.

Example:

300

Response

Expected verifications response to a valid request.

data

Verification · object

required

Show child attributes

data.id

string<uuid>

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.type

enum<string>

The possible types of verification.

Available options:

sms,

call,

flashcall

Example:

"sms"

data.record_type

enum<string>

The possible verification record types.

Available options:

verification

Example:

"verification"

data.phone_number

string

+E164 formatted phone number.

Example:

"+13035551234"

data.verify_profile_id

string<uuid>

The identifier of the associated Verify profile.

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.custom_code

string | null

Send a self-generated numeric code to the end-user

Example:

"43612"

data.timeout_secs

integer

This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

Example:

300

data.status

enum<string>

The possible statuses of the verification request.

Available options:

pending,

accepted,

invalid,

expired,

error

Example:

"accepted"

data.created_at

string

Example:

"2020-09-14T17:03:32.965812"

data.updated_at

string

Example:

"2020-09-14T17:03:32.965812"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup