About this integration
Sends and receives voice calls, SMS, MMS, WhatsApp, RCS, and email; manages phone numbers, SIM cards, AI assistants, and storage on the Telnyx communications platform. This integration exposes its full API as workflow modules.
The integration includes 1 trigger, 67 search modules and 69 actions. Connections use basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Create an API key in the Mission Control Portal (portal.telnyx.com → API Keys). Paste the key here — it is never displayed again after save. |
Use it in workflow automation
Start with Inbound SMS/MMS, then add Call Control Action.
Triggers, searches and actions
Browse every Telnyx module field below: 1 trigger, 67 searchs, and 69 actions you can drop onto the canvas.
Triggers
This integration includes 1 trigger — start a workflow the moment something changes in the app.
- Inbound SMS/MMS
Searches
Use any of 67 search modules to retrieve records without leaving the workflow canvas.
- Get Call Control Application
- Get Call Status
- Get Conference
- Get Email Domain
- Get Email Event Statistics
Actions
This integration includes 69 action modules — create, update, or delete records as part of any workflow.
- Call Control Action
- Cancel Fax
- Cancel Message
- Cancel Scheduled Email Message
- Conference Action
Explore the fields available for each Telnyx trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Messaging ProfileRequired | choice |
Public KeyRequired | text |
| Field | Type |
|---|---|
Record Type | text |
Event ID | text |
Event Type | text |
Occurred At | date |
Message | object |
Message ID | text |
Direction | text |
Type | text |
Messaging Profile ID | text |
From | object |
To | array |
Text | text |
Received At | date |
Searches
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
DTMF Type | text |
First Command Timeout | boolean |
First Command Timeout (sec) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
Record Type | text |
Call Session ID | text |
Call Leg ID | text |
Call Control ID | text |
Is Alive | boolean |
Client State | text |
Call Duration (sec) | number |
Start Time | date |
End Time | date |
| Field | Type |
|---|---|
Record Type | text |
Conference ID | text |
Name | text |
Created At | date |
Expires At | date |
Updated At | date |
Region | text |
Status | text |
End Reason | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Domain | text |
Domain Type | text |
Status | text |
Usable For Sending | boolean |
Usable For Inbound | boolean |
Verification | object |
Ownership | text |
SPF | text |
DKIM | text |
DMARC | text |
MX | text |
DNS Records | array |
ID | text |
Purpose | text |
DNS Record Type | text |
Host | text |
Recommended Value | text |
Actual Value | text |
Priority | number |
Required | boolean |
Status | text |
| Field | Type |
|---|---|
Record Type | text |
Counts | object |
Queued | number |
Sent | number |
Delivered | number |
Deferred | number |
Bounced | number |
Opened | number |
Clicked | number |
Complained | number |
Unsubscribed | number |
Failed | number |
Rates | object |
Delivery Rate (%) | number |
Bounce Rate (%) | number |
Deferred Rate (%) | number |
Open Rate (%) | number |
Click Rate (%) | number |
Complaint Rate (%) | number |
Time Range | object |
From | date |
To | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Status | text |
From | object |
Email | text |
Name | text |
To | array |
Recipient | object |
Cc | array |
Recipient | object |
Bcc | array |
Recipient | object |
Reply To | text |
Subject | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Subject | text |
HTML Body | text |
Text Body | text |
Variables | array |
Variable | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Connection ID | text |
Direction | text |
Media URL | text |
Media Name | text |
To | text |
From | text |
From Display Name | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
Webhook Event URL | text |
Webhook Event Failover URL | text |
Webhook Timeout (Seconds) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
IP Address | text |
Name | text |
Description | text |
Ports | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Global IP ID | text |
WireGuard Peer ID | text |
Status | text |
Is Connected | boolean |
Is In Maintenance | boolean |
Is Announced | boolean |
Created At | date |
| Field | Type |
|---|---|
Timestamp | date |
Global IP | object |
ID | text |
IP Address | text |
Transmitted | object |
Amount | number |
Unit | text |
Received | object |
Amount | number |
Unit | text |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Phone Number | text |
Messaging Profile ID | text |
Created At | date |
Updated At | date |
Country Code | text |
Type | text |
Health | object |
Message Count | number |
Inbound/Outbound Ratio | text |
Success Ratio | text |
Spam Ratio | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Messaging Profile ID | text |
Status | text |
Phone Numbers | array |
Record Type | text |
ID | text |
Phone Number | text |
Status | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Enabled | boolean |
Webhook URL | text |
Webhook Failover URL | text |
Webhook API Version | text |
Health Webhook URL (Deprecated) | text |
Whitelisted Destinations | array |
| Field | Type |
|---|---|
RCS Agent ID | text |
User ID | text |
Messaging Profile ID | text |
Webhook URL | text |
Webhook Failover URL | text |
Agent Name | text |
Enabled | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Phone Number | text |
SIM Card ID | text |
Status | text |
Connection ID | text |
Connection Name | text |
Mobile Voice Enabled | boolean |
Customer Reference | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | text |
Customer Reference | text |
Phone Numbers | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
Connections Count | number |
Traffic Type | text |
Service Plan | text |
Concurrent Call Limit | number |
Enabled | boolean |
Tags | array |
| Field | Type |
|---|---|
Record Type | text |
Phone Number | text |
RCS Agent ID | text |
Agent Name | text |
Features | array |
| Field | Type |
|---|---|
Recording ID | text |
Record Type | text |
Call Control ID | text |
Call Leg ID | text |
Call Session ID | text |
Conference ID | text |
Channels | text |
Source | text |
Status | text |
| Field | Type |
|---|---|
ID | text |
Recording ID | text |
Record Type | text |
Status | text |
Transcription Text | text |
Duration (ms) | number |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Short Code | text |
Country Code | text |
Messaging Profile ID | text |
Tags | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Verification ID | text |
Type | text |
Record Type | text |
Phone Number | text |
Verify Profile ID | text |
Custom Code | text |
Timeout (sec) | number |
Status | text |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Verification Status | choice |
Business Name | text |
Corporate Website | text |
Business Address Line 1 | text |
Business Address Line 2 | text |
Business City | text |
Business State | text |
Business ZIP | text |
| Field | Type |
|---|---|
Phone Number | text |
Record Type | text |
Verified At | date |
| Field | Type |
|---|---|
Enabled | boolean |
PIN | text |
Greeting | object |
Mode | text |
Media Name | text |
| Field | Type |
|---|---|
Window Active | boolean |
Window Expires At | date |
Last User Message At | date |
Window Type | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Template ID | text |
Name | text |
Category | choice |
Language | text |
Status | text |
Rejection Reason | text |
Components | array |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Phone Number ID | text |
Display Name | text |
Profile Photo URL | text |
Category | text |
About | text |
Description | text |
Email | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
DTMF Type | text |
First Command Timeout | boolean |
First Command Timeout (sec) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
Record Type | text |
Call Leg ID | text |
Call Session ID | text |
Event Timestamp | date |
Event Name | text |
Event Type | text |
Metadata | object |
| Field | Type |
|---|---|
Record Type | text |
Participant ID | text |
Call Leg ID | text |
Call Control ID | text |
Conference | object |
Conference ID | text |
Name | text |
Whisper Call Control IDs | array |
Call Control ID | text |
Created At | date |
Updated At | date |
End Conference On Exit | boolean |
| Field | Type |
|---|---|
Record Type | text |
Conference ID | text |
Name | text |
Created At | date |
Expires At | date |
Updated At | date |
Region | text |
Status | text |
End Reason | text |
| Field | Type |
|---|---|
Record Type | text |
Call Session ID | text |
Call Leg ID | text |
Call Control ID | text |
Client State | text |
Call Duration (sec) | number |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Domain | text |
Domain Type | text |
Status | text |
Usable For Sending | boolean |
Usable For Inbound | boolean |
Verification | object |
Ownership | text |
SPF | text |
DKIM | text |
DMARC | text |
MX | text |
DNS Records | array |
ID | text |
Purpose | text |
DNS Record Type | text |
Host | text |
Recommended Value | text |
Actual Value | text |
Priority | number |
Required | boolean |
Status | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Type | text |
Occurred At | date |
Email Message ID | text |
Email Summary | object |
From | object |
To | array |
Cc | array |
Subject | text |
Payload | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Status | text |
From | object |
Email | text |
Name | text |
To | array |
Recipient | object |
Cc | array |
Recipient | object |
Bcc | array |
Recipient | object |
Reply To | text |
Subject | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Subject | text |
HTML Body | text |
Text Body | text |
Variables | array |
Variable | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
Webhook Event URL | text |
Webhook Event Failover URL | text |
Webhook Timeout (Seconds) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Connection ID | text |
Direction | text |
Media URL | text |
Media Name | text |
To | text |
From | text |
From Display Name | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Global IP ID | text |
WireGuard Peer ID | text |
Status | text |
Is Connected | boolean |
Is In Maintenance | boolean |
Is Announced | boolean |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
IP Address | text |
Name | text |
Description | text |
Ports | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Messaging Profile ID | text |
Status | text |
Phone Numbers | array |
Record Type | text |
ID | text |
Phone Number | text |
Status | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Phone Number | text |
Messaging Profile ID | text |
Created At | date |
Updated At | date |
Country Code | text |
Type | text |
Health | object |
Message Count | number |
Inbound/Outbound Ratio | text |
Success Ratio | text |
Spam Ratio | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Phone Number | text |
Messaging Profile ID | text |
Created At | date |
Updated At | date |
Country Code | text |
Number Type | text |
Health | object |
Message Count | number |
Inbound/Outbound Ratio | number |
Success Ratio | number |
Spam Ratio | number |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Enabled | boolean |
Webhook URL | text |
Webhook Failover URL | text |
Webhook API Version | text |
Health Webhook URL (Deprecated) | text |
Whitelisted Destinations | array |
| Field | Type |
|---|---|
RCS Agent ID | text |
User ID | text |
Messaging Profile ID | text |
Webhook URL | text |
Webhook Failover URL | text |
Agent Name | text |
Enabled | boolean |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
URL Domain | text |
Use Case | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Phone Number | text |
SIM Card ID | text |
Status | text |
Connection ID | text |
Connection Name | text |
Mobile Voice Enabled | boolean |
Customer Reference | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | text |
Customer Reference | text |
Phone Numbers | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
From | text |
To | text |
Messaging Profile ID | text |
Keyword | text |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
Connections Count | number |
Traffic Type | text |
Service Plan | text |
Concurrent Call Limit | number |
Enabled | boolean |
Tags | array |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | choice |
Job Type | choice |
Estimated Completion | date |
Created At | date |
Updated At | date |
Phone Numbers | array |
Phone Number | text |
ID | text |
Successful Operations | array |
Phone Number | text |
ID | text |
| Field | Type |
|---|---|
Recording ID | text |
Record Type | text |
Call Control ID | text |
Call Leg ID | text |
Call Session ID | text |
Conference ID | text |
Channels | text |
Source | text |
Status | text |
| Field | Type |
|---|---|
ID | text |
Recording ID | text |
Record Type | text |
Status | text |
Transcription Text | text |
Duration (ms) | number |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Short Code | text |
Country Code | text |
Messaging Profile ID | text |
Tags | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Verification Status | choice |
Business Name | text |
Corporate Website | text |
Business Address Line 1 | text |
Business Address Line 2 | text |
Business City | text |
Business State | text |
Business ZIP | text |
| Field | Type |
|---|---|
Phone Number | text |
Record Type | text |
Verified At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
WABA ID | text |
Status | text |
Phone Numbers Count | number |
Business Verification Status | text |
Account Review Status | text |
Country | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Template ID | text |
Name | text |
Category | choice |
Language | text |
Status | text |
Rejection Reason | text |
Components | array |
| Field | Type |
|---|---|
Record Type | text |
Phone Number | text |
Phone Number ID | text |
WABA ID | text |
User ID | text |
Display Name | text |
Quality Rating | text |
Status | text |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | choice |
Job Type | choice |
Estimated Completion | date |
Created At | date |
Updated At | date |
Phone Numbers | array |
Phone Number | text |
ID | text |
Successful Operations | array |
Phone Number | text |
ID | text |
| Field | Type |
|---|---|
Record Type | text |
Phone Number | text |
Range | number |
Region Information | array |
Cost Information | object |
Upfront Cost | text |
Monthly Cost | text |
Currency | text |
Features | array |
| Field | Type |
|---|---|
Record Type | text |
Phone Number | text |
Vanity Format | text |
Best Effort | boolean |
Quickship | boolean |
Reservable | boolean |
Region Information | array |
Cost Information | object |
Upfront Cost | text |
Monthly Cost | text |
Currency | text |
Features | array |
Actions
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Status | text |
From | object |
Email | text |
Name | text |
To | array |
Recipient | object |
Cc | array |
Recipient | object |
Bcc | array |
Recipient | object |
Reply To | text |
Subject | text |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Call Control ID | text |
Call Leg ID | text |
Call Session ID | text |
Is Alive | boolean |
Client State | text |
Call Duration (sec) | number |
Recording ID | text |
Start Time | date |
End Time | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
DTMF Type | text |
First Command Timeout | boolean |
First Command Timeout (sec) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
Record Type | text |
Conference ID | text |
Name | text |
Created At | date |
Expires At | date |
Region | text |
Connection ID | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Domain | text |
Domain Type | text |
Status | text |
Usable For Sending | boolean |
Usable For Inbound | boolean |
Verification | object |
Ownership | text |
SPF | text |
DKIM | text |
DMARC | text |
MX | text |
DNS Records | array |
ID | text |
Purpose | text |
DNS Record Type | text |
Host | text |
Recommended Value | text |
Actual Value | text |
Priority | number |
Required | boolean |
Status | text |
| Field | Type |
|---|---|
Email Message | object |
Record Type | text |
ID | text |
Status | text |
From | object |
To | array |
Cc | array |
Bcc | array |
Reply To | text |
Subject | text |
Template ID | text |
Suppressed Recipients | array |
Suppressed Recipient | object |
| Field | Type |
|---|---|
Successful Messages | array |
Email Message | object |
Failed Messages | array |
Error | object |
Batch Summary | object |
Total | number |
Succeeded | number |
Failed | number |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Subject | text |
HTML Body | text |
Text Body | text |
Variables | array |
Variable | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
Webhook Event URL | text |
Webhook Event Failover URL | text |
Webhook Timeout (Seconds) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
IP Address | text |
Name | text |
Description | text |
Ports | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Global IP ID | text |
WireGuard Peer ID | text |
Status | text |
Is Connected | boolean |
Is In Maintenance | boolean |
Is Announced | boolean |
Created At | date |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Messaging Profile ID | text |
Status | text |
Phone Numbers | array |
Record Type | text |
ID | text |
Phone Number | text |
Status | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Enabled | boolean |
Webhook URL | text |
Webhook Failover URL | text |
Webhook API Version | text |
Health Webhook URL (Deprecated) | text |
Whitelisted Destinations | array |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | text |
Customer Reference | text |
Phone Numbers | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
Connections Count | number |
Traffic Type | text |
Service Plan | text |
Concurrent Call Limit | number |
Enabled | boolean |
Tags | array |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Verification ID | text |
Type | text |
Record Type | text |
Phone Number | text |
Verify Profile ID | text |
Custom Code | text |
Timeout (sec) | number |
Status | text |
Created At | date |
| Field | Type |
|---|---|
Verification ID | text |
Type | text |
Record Type | text |
Phone Number | text |
Verify Profile ID | text |
Custom Code | text |
Timeout (sec) | number |
Status | text |
Created At | date |
| Field | Type |
|---|---|
Phone Number | text |
Verification Method | text |
| Field | Type |
|---|---|
Verify Profile ID | text |
Name | text |
Webhook URL | text |
Webhook Failover URL | text |
Daily Spend Limit Enabled | boolean |
Daily Spend Limit (USD) | number |
Record Type | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Enabled | boolean |
PIN | text |
Greeting | object |
Mode | text |
Media Name | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Template ID | text |
Name | text |
Category | choice |
Language | text |
Status | text |
Rejection Reason | text |
Components | array |
| Field | Type |
|---|---|
Verification ID | text |
Type | text |
Record Type | text |
Phone Number | text |
Verify Profile ID | text |
Custom Code | text |
Timeout (sec) | number |
Status | text |
Created At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | choice |
Job Type | choice |
Estimated Completion | date |
Created At | date |
Updated At | date |
Phone Numbers | array |
Phone Number | text |
ID | text |
Successful Operations | array |
Phone Number | text |
ID | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
DTMF Type | text |
First Command Timeout | boolean |
First Command Timeout (sec) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Domain | text |
Domain Type | text |
Status | text |
Usable For Sending | boolean |
Usable For Inbound | boolean |
Verification | object |
Ownership | text |
SPF | text |
DKIM | text |
DMARC | text |
MX | text |
DNS Records | array |
ID | text |
Purpose | text |
DNS Record Type | text |
Host | text |
Recommended Value | text |
Actual Value | text |
Priority | number |
Required | boolean |
Status | text |
No fields documented.
No fields documented.
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
Webhook Event URL | text |
Webhook Event Failover URL | text |
Webhook Timeout (Seconds) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
IP Address | text |
Name | text |
Description | text |
Ports | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Global IP ID | text |
WireGuard Peer ID | text |
Status | text |
Is Connected | boolean |
Is In Maintenance | boolean |
Is Announced | boolean |
Created At | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Enabled | boolean |
Webhook URL | text |
Webhook Failover URL | text |
Webhook API Version | text |
Health Webhook URL (Deprecated) | text |
Whitelisted Destinations | array |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
Connections Count | number |
Traffic Type | text |
Service Plan | text |
Concurrent Call Limit | number |
Enabled | boolean |
Tags | array |
| Field | Type |
|---|---|
Recording ID | text |
Record Type | text |
Call Control ID | text |
Call Leg ID | text |
Call Session ID | text |
Conference ID | text |
Channels | text |
Source | text |
Status | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | text |
Customer Reference | text |
Phone Numbers | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Deeplink URL | text |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Result | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Rendered Subject | text |
Rendered HTML Body | text |
Rendered Text Body | text |
Variables | array |
Variable | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Connection ID | text |
Direction | text |
Media URL | text |
Media Name | text |
To | text |
From | text |
From Display Name | text |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Messaging Profile ID | text |
Organization ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
CC | array |
Recipient | object |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Organization ID | text |
Messaging Profile ID | text |
From | object |
Agent ID | text |
Carrier | text |
Agent Name | text |
To | array |
Recipient | object |
Body | object |
Content Message | object |
Event | object |
Expire Time | date |
TTL | text |
| Field | Type |
|---|---|
Record Type | text |
Direction | text |
Message ID | text |
Type | text |
Organization ID | text |
Messaging Profile ID | text |
From | object |
Phone Number | text |
Carrier | text |
Line Type | text |
To | array |
Recipient | object |
Body | text |
| Field | Type |
|---|---|
ID | text |
Verification Request ID | text |
Verification Status | choice |
Business Name | text |
Corporate Website | text |
Business Address Line 1 | text |
Business Address Line 2 | text |
Business City | text |
Business State | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | choice |
Job Type | choice |
Estimated Completion | date |
Created At | date |
Updated At | date |
Phone Numbers | array |
Phone Number | text |
ID | text |
Successful Operations | array |
Phone Number | text |
ID | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
DTMF Type | text |
First Command Timeout | boolean |
First Command Timeout (sec) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Subject | text |
HTML Body | text |
Text Body | text |
Variables | array |
Variable | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Status | choice |
Job Type | choice |
Estimated Completion | date |
Created At | date |
Updated At | date |
Phone Numbers | array |
Phone Number | text |
ID | text |
Successful Operations | array |
Phone Number | text |
ID | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Application Name | text |
Active | boolean |
Anchorsite Override | text |
Webhook Event URL | text |
Webhook Event Failover URL | text |
Webhook Timeout (Seconds) | number |
Tags | array |
Tag | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Global IP ID | text |
WireGuard Peer ID | text |
Status | text |
Is Connected | boolean |
Is In Maintenance | boolean |
Is Announced | boolean |
Created At | date |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Name | text |
Enabled | boolean |
Webhook URL | text |
Webhook Failover URL | text |
Webhook API Version | text |
Health Webhook URL (Deprecated) | text |
Whitelisted Destinations | array |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Phone Number | text |
Status | text |
Connection ID | text |
Customer Reference | text |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Name | text |
Connections Count | number |
Traffic Type | text |
Service Plan | text |
Concurrent Call Limit | number |
Enabled | boolean |
Tags | array |
| Field | Type |
|---|---|
Record Type | text |
ID | text |
Short Code | text |
Country Code | text |
Messaging Profile ID | text |
Tags | array |
Created At | date |
Updated At | date |
| Field | Type |
|---|---|
Enabled | boolean |
PIN | text |
Greeting | object |
Mode | text |
Media Name | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Template ID | text |
Name | text |
Category | choice |
Language | text |
Status | text |
Rejection Reason | text |
Components | array |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Phone Number ID | text |
Display Name | text |
Profile Photo URL | text |
Category | text |
About | text |
Description | text |
Email | text |
| Field | Type |
|---|---|
ID | text |
Record Type | text |
Domain | text |
Domain Type | text |
Status | text |
Usable For Sending | boolean |
Usable For Inbound | boolean |
Verification | object |
Ownership | text |
SPF | text |
DKIM | text |
DMARC | text |
MX | text |
DNS Records | array |
ID | text |
Purpose | text |
DNS Record Type | text |
Host | text |
Recommended Value | text |
Actual Value | text |
Priority | number |
Required | boolean |
Status | text |
| Field | Type |
|---|---|
Phone Number | text |
Record Type | text |
Verified At | date |
| Field | Type |
|---|---|
Phone Number | text |
Response Code | text |