Back to Details

telnyx-verify-curl

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Verify - curl

Telnyx Verify - curl

Installation

安装

text
undefined
text
undefined

curl is pre-installed on macOS, Linux, and Windows 10+

curl is pre-installed on macOS, Linux, and Windows 10+

undefined
undefined

Setup

配置

bash
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
All examples below use 
$TELNYX_API_KEY
for authentication.
bash
export TELNYX_API_KEY="YOUR_API_KEY_HERE"
以下所有示例均使用
$TELNYX_API_KEY
进行身份验证。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
bash
undefined
所有API调用都可能失败，原因包括网络错误、速率限制（429）、校验错误（422）或身份验证错误（401）。在生产代码中请务必做好错误处理：
bash
undefined

Check HTTP status code in response

Check HTTP status code in response

response=$(curl -s -w "\n%{http_code}"
-X POST "https://api.telnyx.com/v2/messages"
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')
http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')
case $http_code in 2*) echo "Success: $body" ;; 422) echo "Validation error — check required fields and formats" ;; 429) echo "Rate limited — retry after delay"; sleep 1 ;; 401) echo "Authentication failed — check TELNYX_API_KEY" ;; *) echo "Error $http_code: $body" ;; esac

Common error codes: `401` invalid API key, `403` insufficient permissions,
`404` resource not found, `422` validation error (check field formats),
`429` rate limited (retry with exponential backoff).
response=$(curl -s -w "\n%{http_code}"
-X POST "https://api.telnyx.com/v2/messages"
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')
http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')
case $http_code in 2*) echo "Success: $body" ;; 422) echo "Validation error — check required fields and formats" ;; 429) echo "Rate limited — retry after delay"; sleep 1 ;; 401) echo "Authentication failed — check TELNYX_API_KEY" ;; *) echo "Error $http_code: $body" ;; esac

常见错误码：`401` 无效API密钥、`403` 权限不足、`404` 资源不存在、`422` 校验错误（请检查字段格式）、`429` 触发速率限制（请使用指数退避策略重试）。

Important Notes

重要注意事项

  • Phone numbers must be in E.164 format (e.g., 
    +13125550001
    ). Include the 
    +
    prefix and country code. No spaces, dashes, or parentheses.
  • Pagination: List endpoints return paginated results. Use 
    page[number]
    and 
    page[size]
    query parameters to navigate pages. Check 
    meta.total_pages
    in the response.
  • 电话号码 必须符合E.164格式（例如 
    +13125550001
    ），需包含
    +
    前缀和国家代码，不能包含空格、短横线或括号。
  • 分页： 列表类接口返回分页结果，可使用
    page[number]
    和
    page[size]
    查询参数浏览页面，可查看响应中的
    meta.total_pages
    获取总页数。

Lookup phone number data

查询电话号码数据

Returns information about the provided phone number.
GET /number_lookup/{phone_number}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/number_lookup/+18665552368"
Returns: 
caller_name
(object), 
carrier
(object), 
country_code
(string), 
fraud
(string | null), 
national_format
(string), 
phone_number
(string), 
portability
(object), 
record_type
(string)
返回指定电话号码的相关信息。
GET /number_lookup/{phone_number}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/number_lookup/+18665552368"
返回参数：
caller_name
（对象）、
carrier
（对象）、
country_code
（字符串）、
fraud
（字符串 | 空）、
national_format
（字符串）、
phone_number
（字符串）、
portability
（对象）、
record_type
（字符串）

List verifications by phone number

按电话号码查询验证记录

GET /verifications/by_phone_number/{phone_number}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verifications/by_phone_number/+13035551234"
Returns: 
created_at
(string), 
custom_code
(string | null), 
id
(uuid), 
phone_number
(string), 
record_type
(enum: verification), 
status
(enum: pending, accepted, invalid, expired, error), 
timeout_secs
(integer), 
type
(enum: sms, call, flashcall), 
updated_at
(string), 
verify_profile_id
(uuid)
GET /verifications/by_phone_number/{phone_number}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verifications/by_phone_number/+13035551234"
返回参数：
created_at
（字符串）、
custom_code
（字符串 | 空）、
id
（uuid）、
phone_number
（字符串）、
record_type
（枚举：verification）、
status
（枚举：pending, accepted, invalid, expired, error）、
timeout_secs
（整数）、
type
（枚举：sms, call, flashcall）、
updated_at
（字符串）、
verify_profile_id
（uuid）

Verify verification code by phone number

通过电话号码校验验证码

POST /verifications/by_phone_number/{phone_number}/actions/verify
— Required: 
code
, 
verify_profile_id
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "17686",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/by_phone_number/+13035551234/actions/verify"
Returns: 
phone_number
(string), 
response_code
(enum: accepted, rejected)
POST /verifications/by_phone_number/{phone_number}/actions/verify
— 必填参数：
code
、
verify_profile_id
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "17686",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/by_phone_number/+13035551234/actions/verify"
返回参数：
phone_number
（字符串）、
response_code
（枚举：accepted, rejected）

Trigger Call verification

触发语音呼叫验证

POST /verifications/call
— Required: 
phone_number
, 
verify_profile_id
Optional: 
custom_code
(string | null), 
extension
(string | null), 
timeout_secs
(integer)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/call"
Returns: 
created_at
(string), 
custom_code
(string | null), 
id
(uuid), 
phone_number
(string), 
record_type
(enum: verification), 
status
(enum: pending, accepted, invalid, expired, error), 
timeout_secs
(integer), 
type
(enum: sms, call, flashcall), 
updated_at
(string), 
verify_profile_id
(uuid)
POST /verifications/call
— 必填参数：
phone_number
、
verify_profile_id
可选参数：
custom_code
（字符串 | 空）、
extension
（字符串 | 空）、
timeout_secs
（整数）
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/call"
返回参数：
created_at
（字符串）、
custom_code
（字符串 | 空）、
id
（uuid）、
phone_number
（字符串）、
record_type
（枚举：verification）、
status
（枚举：pending, accepted, invalid, expired, error）、
timeout_secs
（整数）、
type
（枚举：sms, call, flashcall）、
updated_at
（字符串）、
verify_profile_id
（uuid）

Trigger Flash call verification

触发闪呼验证

POST /verifications/flashcall
— Required: 
phone_number
, 
verify_profile_id
Optional: 
timeout_secs
(integer)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/flashcall"
Returns: 
created_at
(string), 
custom_code
(string | null), 
id
(uuid), 
phone_number
(string), 
record_type
(enum: verification), 
status
(enum: pending, accepted, invalid, expired, error), 
timeout_secs
(integer), 
type
(enum: sms, call, flashcall), 
updated_at
(string), 
verify_profile_id
(uuid)
POST /verifications/flashcall
— 必填参数：
phone_number
、
verify_profile_id
可选参数：
timeout_secs
（整数）
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/flashcall"
返回参数：
created_at
（字符串）、
custom_code
（字符串 | 空）、
id
（uuid）、
phone_number
（字符串）、
record_type
（枚举：verification）、
status
（枚举：pending, accepted, invalid, expired, error）、
timeout_secs
（整数）、
type
（枚举：sms, call, flashcall）、
updated_at
（字符串）、
verify_profile_id
（uuid）

Trigger SMS verification

触发短信验证

POST /verifications/sms
— Required: 
phone_number
, 
verify_profile_id
Optional: 
custom_code
(string | null), 
timeout_secs
(integer)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/sms"
Returns: 
created_at
(string), 
custom_code
(string | null), 
id
(uuid), 
phone_number
(string), 
record_type
(enum: verification), 
status
(enum: pending, accepted, invalid, expired, error), 
timeout_secs
(integer), 
type
(enum: sms, call, flashcall), 
updated_at
(string), 
verify_profile_id
(uuid)
POST /verifications/sms
— 必填参数：
phone_number
、
verify_profile_id
可选参数：
custom_code
（字符串 | 空）、
timeout_secs
（整数）
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "+13035551234",
  "verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}' \
  "https://api.telnyx.com/v2/verifications/sms"
返回参数：
created_at
（字符串）、
custom_code
（字符串 | 空）、
id
（uuid）、
phone_number
（字符串）、
record_type
（枚举：verification）、
status
（枚举：pending, accepted, invalid, expired, error）、
timeout_secs
（整数）、
type
（枚举：sms, call, flashcall）、
updated_at
（字符串）、
verify_profile_id
（uuid）

Retrieve verification

查询验证记录详情

GET /verifications/{verification_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verifications/12ade33a-21c0-473b-b055-b3c836e1c292"
Returns: 
created_at
(string), 
custom_code
(string | null), 
id
(uuid), 
phone_number
(string), 
record_type
(enum: verification), 
status
(enum: pending, accepted, invalid, expired, error), 
timeout_secs
(integer), 
type
(enum: sms, call, flashcall), 
updated_at
(string), 
verify_profile_id
(uuid)
GET /verifications/{verification_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verifications/12ade33a-21c0-473b-b055-b3c836e1c292"
返回参数：
created_at
（字符串）、
custom_code
（字符串 | 空）、
id
（uuid）、
phone_number
（字符串）、
record_type
（枚举：verification）、
status
（枚举：pending, accepted, invalid, expired, error）、
timeout_secs
（整数）、
type
（枚举：sms, call, flashcall）、
updated_at
（字符串）、
verify_profile_id
（uuid）

Verify verification code by ID

通过ID校验验证码

POST /verifications/{verification_id}/actions/verify
Optional: 
code
(string), 
status
(enum: accepted, rejected)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "code": "12345"
  }' \
  "https://api.telnyx.com/v2/verifications/12ade33a-21c0-473b-b055-b3c836e1c292/actions/verify"
Returns: 
phone_number
(string), 
response_code
(enum: accepted, rejected)
POST /verifications/{verification_id}/actions/verify
可选参数：
code
（字符串）、
status
（枚举：accepted, rejected）
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "code": "12345"
  }' \
  "https://api.telnyx.com/v2/verifications/12ade33a-21c0-473b-b055-b3c836e1c292/actions/verify"
返回参数：
phone_number
（字符串）、
response_code
（枚举：accepted, rejected）

List all Verify profiles

查询所有验证配置文件列表

Gets a paginated list of Verify profiles.
GET /verify_profiles
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles"
Returns: 
call
(object), 
created_at
(string), 
flashcall
(object), 
id
(uuid), 
language
(string), 
name
(string), 
rcs
(object), 
record_type
(enum: verification_profile), 
sms
(object), 
updated_at
(string), 
webhook_failover_url
(string), 
webhook_url
(string)
获取验证配置文件的分页列表。
GET /verify_profiles
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles"
返回参数：
call
（对象）、
created_at
（字符串）、
flashcall
（对象）、
id
（uuid）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
record_type
（枚举：verification_profile）、
sms
（对象）、
updated_at
（字符串）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）

Create a Verify profile

创建验证配置文件

Creates a new Verify profile to associate verifications with.
POST /verify_profiles
— Required: 
name
Optional: 
call
(object), 
flashcall
(object), 
language
(string), 
rcs
(object), 
sms
(object), 
webhook_failover_url
(string), 
webhook_url
(string)
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Test Profile"
}' \
  "https://api.telnyx.com/v2/verify_profiles"
Returns: 
call
(object), 
created_at
(string), 
flashcall
(object), 
id
(uuid), 
language
(string), 
name
(string), 
rcs
(object), 
record_type
(enum: verification_profile), 
sms
(object), 
updated_at
(string), 
webhook_failover_url
(string), 
webhook_url
(string)
创建新的验证配置文件，用于关联验证请求。
POST /verify_profiles
— 必填参数：
name
可选参数：
call
（对象）、
flashcall
（对象）、
language
（字符串）、
rcs
（对象）、
sms
（对象）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Test Profile"
}' \
  "https://api.telnyx.com/v2/verify_profiles"
返回参数：
call
（对象）、
created_at
（字符串）、
flashcall
（对象）、
id
（uuid）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
record_type
（枚举：verification_profile）、
sms
（对象）、
updated_at
（字符串）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）

Retrieve Verify profile message templates

查询验证配置文件的消息模板

List all Verify profile message templates.
GET /verify_profiles/templates
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles/templates"
Returns: 
id
(uuid), 
text
(string)
列出验证配置文件的所有消息模板。
GET /verify_profiles/templates
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles/templates"
返回参数：
id
（uuid）、
text
（字符串）

Create message template

创建消息模板

Create a new Verify profile message template.
POST /verify_profiles/templates
— Required: 
text
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Your {{app_name}} verification code is: {{code}}."
}' \
  "https://api.telnyx.com/v2/verify_profiles/templates"
Returns: 
id
(uuid), 
text
(string)
创建新的验证配置文件消息模板。
POST /verify_profiles/templates
— 必填参数：
text
bash
curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Your {{app_name}} verification code is: {{code}}."
}' \
  "https://api.telnyx.com/v2/verify_profiles/templates"
返回参数：
id
（uuid）、
text
（字符串）

Update message template

更新消息模板

Update an existing Verify profile message template.
PATCH /verify_profiles/templates/{template_id}
— Required: 
text
bash
curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Your {{app_name}} verification code is: {{code}}."
}' \
  "https://api.telnyx.com/v2/verify_profiles/templates/12ade33a-21c0-473b-b055-b3c836e1c292"
Returns: 
id
(uuid), 
text
(string)
更新已有的验证配置文件消息模板。
PATCH /verify_profiles/templates/{template_id}
— 必填参数：
text
bash
curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Your {{app_name}} verification code is: {{code}}."
}' \
  "https://api.telnyx.com/v2/verify_profiles/templates/12ade33a-21c0-473b-b055-b3c836e1c292"
返回参数：
id
（uuid）、
text
（字符串）

Retrieve Verify profile

查询验证配置文件详情

Gets a single Verify profile.
GET /verify_profiles/{verify_profile_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
Returns: 
call
(object), 
created_at
(string), 
flashcall
(object), 
id
(uuid), 
language
(string), 
name
(string), 
rcs
(object), 
record_type
(enum: verification_profile), 
sms
(object), 
updated_at
(string), 
webhook_failover_url
(string), 
webhook_url
(string)
获取单个验证配置文件的信息。
GET /verify_profiles/{verify_profile_id}
bash
curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
返回参数：
call
（对象）、
created_at
（字符串）、
flashcall
（对象）、
id
（uuid）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
record_type
（枚举：verification_profile）、
sms
（对象）、
updated_at
（字符串）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）

Update Verify profile

更新验证配置文件

PATCH /verify_profiles/{verify_profile_id}
Optional: 
call
(object), 
flashcall
(object), 
language
(string), 
name
(string), 
rcs
(object), 
sms
(object), 
webhook_failover_url
(string), 
webhook_url
(string)
bash
curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
Returns: 
call
(object), 
created_at
(string), 
flashcall
(object), 
id
(uuid), 
language
(string), 
name
(string), 
rcs
(object), 
record_type
(enum: verification_profile), 
sms
(object), 
updated_at
(string), 
webhook_failover_url
(string), 
webhook_url
(string)
PATCH /verify_profiles/{verify_profile_id}
可选参数：
call
（对象）、
flashcall
（对象）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
sms
（对象）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）
bash
curl \
  -X PATCH \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
返回参数：
call
（对象）、
created_at
（字符串）、
flashcall
（对象）、
id
（uuid）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
record_type
（枚举：verification_profile）、
sms
（对象）、
updated_at
（字符串）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）

Delete Verify profile

删除验证配置文件

DELETE /verify_profiles/{verify_profile_id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
Returns: 
call
(object), 
created_at
(string), 
flashcall
(object), 
id
(uuid), 
language
(string), 
name
(string), 
rcs
(object), 
record_type
(enum: verification_profile), 
sms
(object), 
updated_at
(string), 
webhook_failover_url
(string), 
webhook_url
(string)
DELETE /verify_profiles/{verify_profile_id}
bash
curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/verify_profiles/12ade33a-21c0-473b-b055-b3c836e1c292"
返回参数：
call
（对象）、
created_at
（字符串）、
flashcall
（对象）、
id
（uuid）、
language
（字符串）、
name
（字符串）、
rcs
（对象）、
record_type
（枚举：verification_profile）、
sms
（对象）、
updated_at
（字符串）、
webhook_failover_url
（字符串）、
webhook_url
（字符串）