About this integration
Send and receive messages across SMS, MMS, Voice, and 2FA channels via Infobip. Manage numbers, subscriptions, and billing, and run cross-channel failover sends. Connect it to any workflow without writing code.
You can choose from 4 triggers, 43 search modules and 49 actions. The connection type is basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Subdomain and 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 |
|---|---|---|
SubdomainRequired | text | The subdomain assigned to your account (a 6-character alphanumeric token like 'abcd12' from 'abcd12.api.infobip.com' in your Portal -> Developer -> API keys page). Enter only the subdomain part, not the full URL, and do not include '.api' -- the app adds 'api.infobip.com' itself. |
API KeyRequired | password | Your API key from Portal -> Developer -> API keys. Keep this secure. |
Use it in workflow automation
Start with Watch Email Events, then add Cancel Number.
Triggers, searches and actions
Explore the fields available for each Infobip trigger, search, and action — 4 triggers, 43 searchs, and 49 actions.
Triggers
Whenever something changes in the app, one of 4 available triggers can start a run immediately.
- Watch Email Events
- Watch SMS Events
- Watch Voice Events
- Watch WhatsApp Events
Searches
43 search modules let you query the app mid-run and feed the results to the next step.
- Get 2FA Application
- Get 2FA Message Template
- Get 2FA Verification Status
- Get Account Balance With Free Messages
- Get A List Of Available Products
Actions
Use 49 action modules to write data back into the app from anywhere in a run.
- Cancel Number
- Create 2FA Application
- Create 2FA Email Message Template
- Create 2FA SMS Or Voice Message Template
- Create Blocklists
Explore the fields available for each Infobip trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Results | array |
Message ID | text |
To | text |
From | text |
Sent at | text |
Done at | text |
Status | object |
| Field | Type |
|---|---|
Results | array |
Message ID | text |
Bulk ID | text |
To | text |
From (inbound) | text |
Sender (delivery) | text |
Message text (inbound) | text |
Clean text (inbound) | text |
Keyword (inbound) | text |
Sent at (delivery) | text |
Done at (delivery) | text |
| Field | Type |
|---|---|
Results | array |
Bulk ID | text |
Message ID | text |
From | text |
To | text |
Sent at | text |
Voice call | object |
Status | object |
| Field | Type |
|---|---|
Results | array |
Message ID | text |
To | text |
From | text |
Sent at | text |
Done at | text |
Received at (inbound) | text |
Status | object |
Searches
| Field | Type |
|---|---|
App IDRequired | choice |
| Field | Type |
|---|---|
Application ID | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
Name | text |
| Field | Type |
|---|---|
App IDRequired | choice |
| Field | Type |
|---|---|
Application ID | text |
Email Template ID | number |
From | text |
Landing Page ID | text |
Language | text |
Message ID | text |
Message Text | text |
PIN Length | number |
PIN Placeholder | text |
PIN Type | object |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
| Field | Type |
|---|---|
App IDRequired | choice |
MsisdnRequired | text |
Verified | boolean |
Sent | boolean |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Msisdn | text |
Sent At | number |
Verified | boolean |
Verified At | number |
| Field | Type |
|---|---|
Balance | number |
Allowed Minus | number |
Monthly Limit | number |
Monthly Balance | number |
Currency | object |
ID | number |
Code | text |
Currency Name | text |
Symbol | text |
Free Messages | object |
| Field | Type |
|---|---|
Maximum Number of Results | number |
| Field | Type |
|---|---|
ID | text |
| Field | Type |
|---|---|
Maximum Number of Results | number |
| Field | Type |
|---|---|
Application ID | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
Name | text |
| Field | Type |
|---|---|
App IDRequired | choice |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Application ID | text |
Email Template ID | number |
From | text |
Landing Page ID | text |
Language | text |
Message ID | text |
Message Text | text |
PIN Length | number |
PIN Placeholder | text |
PIN Type | object |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
| Field | Type |
|---|---|
Sender | text |
Destination | text |
Channel | choice |
Source Type | choice |
Account Key | text |
Get All Account Keys Blocklists | boolean |
Created Date From | text |
Created Date To | text |
Campaign | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Sender | text |
Destination | text |
Source Type | text |
Channel | text |
Account Key | text |
Created Date | text |
Campaign | text |
| Field | Type |
|---|---|
Number | text |
Capabilities | array |
Country | text |
State | text |
NPA | number |
NXX | number |
LATA | number |
Rate Center | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Country | text |
Country Name | text |
Type | text |
Capabilities | array |
Shared | boolean |
Price | object |
Price Per Month | number |
Setup Price | number |
Initial Month Price | number |
Currency | text |
Network | text |
Keywords | array |
Voice Setup | object |
Application ID | text |
Entity ID | text |
Action | object |
Channel | text |
Reservation Status | text |
Additional Setup Required | boolean |
| Field | Type |
|---|---|
Certificate IDRequired | text |
| Field | Type |
|---|---|
Certificate ID | text |
Issued By | text |
Issued To | text |
Valid From | number |
Valid Until | number |
Certificate Status | text |
Serial Number | text |
| Field | Type |
|---|---|
Certificate IDRequired | text |
| Field | Type |
|---|---|
Certificate ID | text |
Status | text |
| Field | Type |
|---|---|
Balance | number |
Currency | text |
| Field | Type |
|---|---|
Channel | choice |
Bulk ID | text |
Message ID | text |
Entity ID | text |
Application ID | text |
Campaign Reference ID | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Event | text |
Channel | text |
Sender | text |
Destination | text |
Sent At | text |
Done At | text |
Bulk ID | text |
Message ID | text |
Callback Data | text |
Message Count | number |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Platform | object |
Entity ID | text |
Application ID | text |
| Field | Type |
|---|---|
Search | text |
Sort By | choice |
Direction | choice |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Certificate ID | text |
Issued By | text |
Issued To | text |
Valid From | number |
Valid Until | number |
Certificate Status | text |
Serial Number | text |
| Field | Type |
|---|---|
Search | text |
Sort By | choice |
Direction | choice |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Certificate ID | text |
Status | text |
| Field | Type |
|---|---|
ChannelRequired | choice |
Application ID | text |
Entity ID | text |
Campaign Reference ID | text |
| Field | Type |
|---|---|
Results | array |
Event | text |
Message Count | number |
Pending Message Count | number |
| Field | Type |
|---|---|
Application ID | text |
Entity ID | text |
| Field | Type |
|---|---|
Results | text |
| Field | Type |
|---|---|
Application ID | text |
Entity ID | text |
Campaign Reference ID | text |
| Field | Type |
|---|---|
Results | array |
Application ID | text |
Message ID | text |
From | text |
To | text |
Text | text |
Clean Text | text |
Keyword | text |
Received At | text |
SMS Count | number |
Price | object |
Message Count | number |
Pending Message Count | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
Entity ID | text |
Application ID | text |
Campaign Reference ID | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Message ID | text |
To | text |
Sender | text |
Sent At | text |
Done At | text |
Message Count | number |
MCC MNC | text |
Callback Data | text |
Platform | object |
Entity ID | text |
Application ID | text |
| Field | Type |
|---|---|
MCC | text |
MNC | text |
Sender | text |
Destination | text |
Bulk ID | array |
Message ID | array |
General Status | choice |
Sent Since | text |
Sent Until | text |
Entity ID | text |
Application ID | text |
Campaign Reference ID | array |
Use Cursor | boolean |
| Field | Type |
|---|---|
Title | text |
MCC MNC | text |
Sender | text |
Destination | text |
Bulk ID | text |
Message ID | text |
Sent At | text |
Done At | text |
Message Count | number |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Platform | object |
Entity ID | text |
Application ID | text |
| Field | Type |
|---|---|
Maximum Number of Results | number |
| Field | Type |
|---|---|
Profile ID | text |
Webhook | object |
Content Type | text |
Notify URL | text |
Security | object |
Auth ID | text |
Client Certificate ID | text |
Max Bucket Size | number |
Window Size | number |
Connect Timeout | number |
Read Timeout | number |
Enabled Sslprotocols | array |
Headers | object |
Response Regex | text |
Response Body Regex | text |
Rate Limit | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
Channel | choice |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
To | text |
Sent At | text |
Done At | text |
Message Count | number |
MCC MNC | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Channel | text |
Callback Data | text |
Contact | object |
Name | text |
Phone Number | text |
User ID | text |
Parent User ID | text |
Username | text |
| Field | Type |
|---|---|
From | text |
To | text |
Bulk ID | array |
Message ID | array |
General Status | choice |
Channel | choice |
Sent Since | text |
Sent Until | text |
MCC | text |
MNC | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
To | text |
From | text |
Text | text |
Sent At | text |
Done At | text |
Message Count | number |
MCC MNC | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Channel | text |
No fields documented.
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
Application ID | text |
Entity ID | text |
Campaign Reference ID | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
To | text |
From | text |
Sent At | text |
Done At | text |
SMS Count | number |
MCC MNC | text |
Callback Data | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Entity ID | text |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
Entity ID | text |
Application ID | text |
Campaign Reference ID | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Message ID | text |
To | text |
Sender | text |
Sent At | text |
Done At | text |
Message Count | number |
MCC MNC | text |
Callback Data | text |
Platform | object |
Entity ID | text |
Application ID | text |
| Field | Type |
|---|---|
From | text |
To | text |
Bulk ID | array |
Message ID | array |
General Status | choice |
Sent Since | text |
Sent Until | text |
MCC | text |
MNC | text |
Application ID | text |
Entity ID | text |
Campaign Reference ID | array |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
To | text |
From | text |
Text | text |
Sent At | text |
Done At | text |
SMS Count | number |
MCC MNC | text |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Application ID | text |
| Field | Type |
|---|---|
MCC | text |
MNC | text |
Sender | text |
Destination | text |
Bulk ID | array |
Message ID | array |
General Status | choice |
Sent Since | text |
Sent Until | text |
Entity ID | text |
Application ID | text |
Campaign Reference ID | array |
Use Cursor | boolean |
| Field | Type |
|---|---|
Sender | text |
Destination | text |
Bulk ID | text |
Message ID | text |
Sent At | text |
Done At | text |
Message Count | number |
Price | object |
Price Per Message | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
Platform | object |
Entity ID | text |
Application ID | text |
Content | object |
Text | text |
Transliteration | text |
Language | text |
Campaign Reference ID | text |
| Field | Type |
|---|---|
Remaining Count | number |
| Field | Type |
|---|---|
Bulk IDRequired | text |
| Field | Type |
|---|---|
Bulk ID | text |
Send At | text |
| Field | Type |
|---|---|
Bulk IDRequired | text |
| Field | Type |
|---|---|
Bulk ID | text |
Status | text |
| Field | Type |
|---|---|
Maximum Number of Results | number |
| Field | Type |
|---|---|
Auth ID | text |
Type | text |
Credentials | object |
Username | text |
Password | text |
| Field | Type |
|---|---|
Profile IDRequired | text |
| Field | Type |
|---|---|
Profile ID | text |
Webhook | object |
Content Type | text |
Notify URL | text |
Security | object |
Auth ID | text |
Client Certificate ID | text |
Max Bucket Size | number |
Window Size | number |
Connect Timeout | number |
Read Timeout | number |
Enabled Sslprotocols | array |
Headers | object |
Response Regex | text |
Response Body Regex | text |
Rate Limit | number |
| Field | Type |
|---|---|
Number KeyRequired | choice |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Country | text |
Country Name | text |
Type | text |
Capabilities | array |
Shared | boolean |
Price | object |
Price Per Month | number |
Setup Price | number |
Initial Month Price | number |
Currency | text |
Network | text |
Keywords | array |
Voice Setup | object |
Application ID | text |
Entity ID | text |
Action | object |
Channel | text |
Reservation Status | text |
Additional Setup Required | boolean |
| Field | Type |
|---|---|
Auth IDRequired | text |
| Field | Type |
|---|---|
Auth ID | text |
Type | text |
Credentials | object |
Username | text |
Password | text |
| Field | Type |
|---|---|
ChannelRequired | choice |
| Field | Type |
|---|---|
Subscription ID | text |
Name | text |
Profile | object |
Profile ID | text |
Security | object |
Events | array |
Format | text |
Event | text |
Criteria | array |
Application ID | text |
Entity ID | text |
Calls Configuration ID | text |
Resources | array |
Users | array |
| Field | Type |
|---|---|
Scenario KeyRequired | choice |
| Field | Type |
|---|---|
Key | number |
Name | text |
Flow | array |
From | text |
Channel | text |
Default | boolean |
| Field | Type |
|---|---|
ChannelRequired | choice |
Application ID | text |
Entity ID | text |
Calls Configuration ID | text |
Resource | text |
User | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Subscription ID | text |
Name | text |
Profile | object |
Profile ID | text |
Security | object |
Events | array |
Format | text |
Event | text |
Criteria | array |
Application ID | text |
Entity ID | text |
Calls Configuration ID | text |
Resources | array |
Users | array |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Bulk ID | text |
Message ID | text |
From | text |
To | text |
Sent At | text |
MCC MNC | text |
Callback Data | text |
Voice Call | object |
Feature | text |
Start Time | text |
Answer Time | text |
End Time | text |
Duration | number |
Charged Duration | number |
File Duration | number |
Direction | text |
Dtmf Codes | text |
Answered By | text |
Price | object |
Price Per Second | number |
Currency | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Error | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Permanent | boolean |
| Field | Type |
|---|---|
Is Default | boolean |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Key | number |
Name | text |
Flow | array |
From | text |
Channel | text |
Default | boolean |
| Field | Type |
|---|---|
Number | text |
Maximum Number of Results | number |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Country | text |
Country Name | text |
Type | text |
Capabilities | array |
Shared | boolean |
Price | object |
Price Per Month | number |
Setup Price | number |
Initial Month Price | number |
Currency | text |
Network | text |
Keywords | array |
Voice Setup | object |
Application ID | text |
Entity ID | text |
Action | object |
Channel | text |
Reservation Status | text |
Additional Setup Required | boolean |
| Field | Type |
|---|---|
UsernameRequired | text |
PasswordRequired | text |
ToRequired | array |
Bulk ID | text |
From | text |
Text | text |
Flash | boolean |
Transliteration | text |
Language Code | text |
Intermediate Report | boolean |
Notify URL | text |
Notify Content Type | text |
Callback Data | text |
| Field | Type |
|---|---|
Message ID | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
To | text |
SMS Count | number |
| Field | Type |
|---|---|
ToRequired | array |
TextRequired | text |
Bulk ID | text |
From | text |
Flash | boolean |
Transliteration | text |
Language Code | text |
Intermediate Report | boolean |
Notify URL | text |
Notify Content Type | text |
Callback Data | text |
Validity Period | number |
Send At | text |
| Field | Type |
|---|---|
Message ID | text |
Status | object |
Group ID | number |
Group Name | text |
ID | number |
Name | text |
Description | text |
Action | text |
Destination | text |
Details | object |
Message Count | number |
Actions
| Field | Type |
|---|---|
Number KeyRequired | choice |
| Field | Type |
|---|---|
NameRequired | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
| Field | Type |
|---|---|
Application ID | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
Name | text |
| Field | Type |
|---|---|
App IDRequired | choice |
Email Template IDRequired | number |
From | text |
Landing Page ID | text |
PIN Length | number |
PIN Type | object |
| Field | Type |
|---|---|
Application ID | text |
Email Template ID | number |
From | text |
Landing Page ID | text |
Message ID | text |
PIN Length | number |
PIN Type | object |
| Field | Type |
|---|---|
App IDRequired | choice |
Message TextRequired | text |
PIN TypeRequired | object |
Language | text |
PIN Length | number |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
Speech Rate | number |
Voice Name | text |
| Field | Type |
|---|---|
Application ID | text |
Language | text |
Message ID | text |
Message Text | text |
PIN Length | number |
PIN Placeholder | text |
PIN Type | object |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
Speech Rate | number |
Voice Name | text |
| Field | Type |
|---|---|
BlocklistRequired | array |
| Field | Type |
|---|---|
ChannelRequired | choice |
Subscription IDRequired | text |
EventsRequired | array |
Profile IDRequired | text |
Name | text |
Criteria | array |
Resources | array |
Users | array |
Notify URL | text |
Security Settings ID | text |
Client Certificate ID | text |
Rate Limit (requests/sec) | number |
| Field | Type |
|---|---|
Subscription ID | text |
Profile | object |
Profile ID | text |
Security | object |
| Field | Type |
|---|---|
Name | text |
Flow | array |
Default | boolean |
| Field | Type |
|---|---|
Key | number |
Name | text |
Flow | array |
From | text |
Channel | text |
Default | boolean |
| Field | Type |
|---|---|
Profile IDRequired | text |
Webhook | object |
Content Type | text |
Notify URLRequired | text |
Security | object |
Auth IDRequired | text |
Type | choice |
Credentials | object |
Client Certificate ID | text |
Max Bucket Size | number |
Window Size | number |
Connect Timeout | number |
Read Timeout | number |
Enabled Sslprotocols | array |
Headers | object |
Response Regex | text |
Response Body Regex | text |
Rate Limit | number |
| Field | Type |
|---|---|
Profile ID | text |
Security | object |
Auth ID | text |
| Field | Type |
|---|---|
Auth IDRequired | text |
Type | choice |
Credentials | object |
UsernameRequired | text |
PasswordRequired | text |
| Field | Type |
|---|---|
Auth ID | text |
| Field | Type |
|---|---|
BlocklistRequired | array |
| Field | Type |
|---|---|
Certificate IDRequired | text |
| Field | Type |
|---|---|
Certificate ID | text |
| Field | Type |
|---|---|
Profile IDRequired | text |
| Field | Type |
|---|---|
Profile ID | text |
Security | object |
Auth ID | text |
| Field | Type |
|---|---|
Auth IDRequired | text |
| Field | Type |
|---|---|
Auth ID | text |
| Field | Type |
|---|---|
ChannelRequired | choice |
| Field | Type |
|---|---|
Subscription ID | text |
Profile | object |
Profile ID | text |
Security | object |
| Field | Type |
|---|---|
MessagesRequired | array |
Bulk ID | text |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
To | text |
Status | object |
Message ID | 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 |
|---|---|
TextRequired | text |
Language Code | text |
Transliteration | text |
| Field | Type |
|---|---|
Original Text | text |
Previews | array |
Text Preview | text |
Message Count | number |
Characters Remaining | number |
Configuration | object |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Application ID | text |
Entity ID | text |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Country | text |
Country Name | text |
Type | text |
Capabilities | array |
Shared | boolean |
Price | object |
Price Per Month | number |
Setup Price | number |
Initial Month Price | number |
Currency | text |
Network | text |
Keywords | array |
Voice Setup | object |
Application ID | text |
Entity ID | text |
Action | object |
Channel | text |
Reservation Status | text |
Additional Setup Required | boolean |
| Field | Type |
|---|---|
Callback URLRequired | text |
RequestRequired | object |
Filter ByRequired | object |
Aggregate By | array |
Options | object |
| Field | Type |
|---|---|
Request ID | text |
| Field | Type |
|---|---|
Send AtRequired | text |
Bulk IDRequired | text |
| Field | Type |
|---|---|
Bulk ID | text |
Send At | text |
| Field | Type |
|---|---|
PIN IDRequired | text |
Landing Page Placeholders | object |
Placeholders | object |
| Field | Type |
|---|---|
Email Status | object |
Description | text |
Name | text |
PIN ID | text |
To | text |
| Field | Type |
|---|---|
PIN IDRequired | text |
Placeholders | object |
Track Delivery | boolean |
| Field | Type |
|---|---|
Call Status | text |
External Message ID | text |
Nc Status | text |
PIN ID | text |
SMS Status | text |
To | text |
| Field | Type |
|---|---|
PIN IDRequired | text |
Placeholders | object |
Track Delivery | boolean |
| Field | Type |
|---|---|
Call Status | text |
External Message ID | text |
Nc Status | text |
PIN ID | text |
SMS Status | text |
To | text |
| Field | Type |
|---|---|
Application IDRequired | choice |
ToRequired | text |
From | text |
Landing Page Placeholders | object |
Placeholders | object |
| Field | Type |
|---|---|
Email Status | object |
Description | text |
Name | text |
PIN ID | text |
To | text |
| Field | Type |
|---|---|
Application IDRequired | choice |
ToRequired | text |
From | text |
Placeholders | object |
Track Delivery | boolean |
Nc Needed | boolean |
| Field | Type |
|---|---|
Call Status | text |
External Message ID | text |
Nc Status | text |
PIN ID | text |
SMS Status | text |
To | text |
| Field | Type |
|---|---|
Application IDRequired | choice |
ToRequired | text |
From | text |
Placeholders | object |
Track Delivery | boolean |
| Field | Type |
|---|---|
Call Status | text |
External Message ID | text |
Nc Status | text |
PIN ID | text |
SMS Status | text |
To | text |
| Field | Type |
|---|---|
EventsRequired | array |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
Destination | text |
Details | object |
| Field | Type |
|---|---|
MessagesRequired | array |
Options | object |
Schedule | object |
Tracking | object |
Message Ordering | object |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
Destination | text |
Details | object |
| Field | Type |
|---|---|
MessagesRequired | array |
Bulk ID | text |
Sending Speed Limit | object |
AmountRequired | number |
Time Unit | choice |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
To | text |
SMS Count | number |
| Field | Type |
|---|---|
MessagesRequired | array |
Bulk ID | text |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
To | text |
Status | object |
Message ID | text |
| Field | Type |
|---|---|
MessagesRequired | array |
Bulk ID | text |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Bcc | text |
Status | object |
Message ID | text |
Error Message | text |
| Field | Type |
|---|---|
MessagesRequired | array |
Options | object |
Schedule | object |
Tracking | object |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
Destination | text |
Details | object |
| Field | Type |
|---|---|
Scenario Key | choice |
Bulk ID | text |
Destinations | array |
SMS | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Transliteration | choice |
Language | object |
Regional | object |
Whats App | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Template Namespace | text |
Template Name | text |
Template Data | array |
Media Template Data | object |
Language | text |
File URL | text |
Image URL | text |
Viber | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Image URL | text |
File Name | text |
File Type | text |
File URL | text |
Button Text | text |
Button URL | text |
Tracking Data | text |
Voice | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Language | text |
Email | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Subject | text |
Push | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Custom Payload | object |
Notification Options | object |
Target Only Primary Devices | boolean |
Include Notifications Disabled Devices | boolean |
Person Subscriptions | array |
Device Subscriptions | array |
Line | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Type | choice |
URL | text |
Thumbnail URL | text |
Duration | number |
Package ID | text |
Sticker ID | text |
Alt Text | text |
Kakao Chingu | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Buttons | array |
Image URL | text |
Image Link | text |
Is Promotional | boolean |
Kakao Alim | object |
Text | text |
Validity Period | number |
Validity Period Time Unit | choice |
Template Code | text |
Buttons | array |
Title | text |
Group Key | text |
Notify | boolean |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
To | object |
Status | object |
Message ID | text |
| Field | Type |
|---|---|
MessagesRequired | array |
Bulk ID | text |
Sending Speed Limit | object |
AmountRequired | number |
Time Unit | choice |
URL Options | object |
Shorten URL | boolean |
Track Clicks | boolean |
Tracking URL | text |
Remove Protocol | boolean |
Custom Domain | text |
Tracking | object |
Base URL | text |
Process Key | text |
Track | text |
Type | text |
Include SMS Count In Response | boolean |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
To | text |
SMS Count | number |
| Field | Type |
|---|---|
MessagesRequired | array |
Options | object |
Schedule | object |
Tracking | object |
Include SMS Count In Response | boolean |
Conversion Tracking | object |
| Field | Type |
|---|---|
Bulk ID | text |
Messages | array |
Message ID | text |
Status | object |
Destination | text |
Details | object |
| Field | Type |
|---|---|
Certificate IDRequired | text |
Webhook URLRequired | text |
| Field | Type |
|---|---|
Certificate ID | text |
Webhook URL | text |
Result | text |
Fail Reasons | array |
Hint | text |
| Field | Type |
|---|---|
App IDRequired | choice |
NameRequired | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
| Field | Type |
|---|---|
Application ID | text |
Configuration | object |
Allow Multiple PIN Verifications | boolean |
PIN Attempts | number |
PIN Time To Live | text |
Send PIN Per Application Limit | text |
Send PIN Per Phone Number Limit | text |
Verify PIN Limit | text |
Enabled | boolean |
Name | text |
| Field | Type |
|---|---|
App IDRequired | choice |
Email Template ID | number |
From | text |
Landing Page ID | text |
PIN Length | number |
PIN Type | object |
| Field | Type |
|---|---|
Application ID | text |
Email Template ID | number |
From | text |
Landing Page ID | text |
Message ID | text |
PIN Length | number |
PIN Type | object |
| Field | Type |
|---|---|
App IDRequired | choice |
Language | text |
Message Text | text |
PIN Length | number |
PIN Type | object |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
Speech Rate | number |
Voice Name | text |
| Field | Type |
|---|---|
Application ID | text |
Language | text |
Message ID | text |
Message Text | text |
PIN Length | number |
PIN Placeholder | text |
PIN Type | object |
Regional | object |
India DLT | object |
Repeat Dtmf | text |
Sender ID | text |
Speech Rate | number |
Voice Name | text |
| Field | Type |
|---|---|
ChannelRequired | choice |
EventsRequired | array |
Profile IDRequired | text |
Name | text |
Criteria | array |
Resources | array |
Users | array |
Notify URL | text |
Security Settings ID | text |
Client Certificate ID | text |
Rate Limit (requests/sec) | number |
| Field | Type |
|---|---|
Subscription ID | text |
Profile | object |
Profile ID | text |
Security | object |
| Field | Type |
|---|---|
Profile IDRequired | text |
Webhook | object |
Content Type | text |
Notify URLRequired | text |
Security | object |
Auth IDRequired | text |
Client Certificate ID | text |
Max Bucket Size | number |
Window Size | number |
Connect Timeout | number |
Read Timeout | number |
Enabled Sslprotocols | array |
Headers | object |
Response Regex | text |
Response Body Regex | text |
Rate Limit | number |
| Field | Type |
|---|---|
Profile ID | text |
Security | object |
Auth ID | text |
| Field | Type |
|---|---|
Scenario KeyRequired | choice |
Name | text |
Flow | array |
Default | boolean |
| Field | Type |
|---|---|
Key | number |
Name | text |
Flow | array |
From | text |
Channel | text |
Default | boolean |
| Field | Type |
|---|---|
Number KeyRequired | choice |
Application IDRequired | text |
Entity ID | text |
| Field | Type |
|---|---|
Number Key | text |
Number | text |
Country | text |
Country Name | text |
Type | text |
Capabilities | array |
Shared | boolean |
Price | object |
Price Per Month | number |
Setup Price | number |
Initial Month Price | number |
Currency | text |
Network | text |
Keywords | array |
Voice Setup | object |
Application ID | text |
Entity ID | text |
Action | object |
Channel | text |
Reservation Status | text |
Additional Setup Required | boolean |
| Field | Type |
|---|---|
StatusRequired | choice |
Bulk IDRequired | text |
| Field | Type |
|---|---|
Bulk ID | text |
Status | text |
| Field | Type |
|---|---|
Auth IDRequired | text |
Type | choice |
Credentials | object |
UsernameRequired | text |
PasswordRequired | text |
| Field | Type |
|---|---|
Auth ID | text |
| Field | Type |
|---|---|
Certificate IDRequired | text |
Certificate ContentRequired | text |
Passphrase | text |
| Field | Type |
|---|---|
Certificate ID | text |
Status | text |
| Field | Type |
|---|---|
Content IDRequired | text |
Media TypeRequired | text |
File ContentRequired | text |
Validity Period (Minutes) | number |
| Field | Type |
|---|---|
Uploaded Content ID | text |
| Field | Type |
|---|---|
MessagesRequired | array |
Options | object |
Schedule | object |
Tracking | object |
Message Ordering | object |
| Field | Type |
|---|---|
Description | text |
Action | text |
Skippable Violations | array |
Property | text |
Violation | text |
| Field | Type |
|---|---|
PIN IDRequired | text |
PINRequired | text |
| Field | Type |
|---|---|
Attempts Remaining | number |
Msisdn | text |
PIN Error | object |
PIN ID | text |
Verified | boolean |