Requirements
Before you set up the credential, make sure you have an active SMSAPI account and an API access token from your account settings ready.[3]https://www.smsapi.com
Get your SMSAPI credentials
Connect SMSAPI in WEXTL
- Log in to your WEXTL account, add the SMSAPI node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your SMSAPI account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
SMSAPI node modules
The list below is a reference of every SMSAPI node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each SMSAPI node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Bulk SendsTrigger
| Field | Type |
|---|---|
| Message Type | text |
| Total Messages | text |
| Credits Needed | text |
| Source | text |
| Info | text |
| Message Text | text |
Watch HLR ResultsTrigger
| Field | Type |
|---|---|
| Lookup ID | text |
| Checked Number | text |
| Mobile Country Code | text |
| Mobile Network Code | text |
| Network or Error | text |
| Status | text |
| Checked At | text |
| Ported | text |
| Ported From | text |
| Custom ID | text |
Watch Incoming MMSTrigger
| Field | Type |
|---|---|
| Recipient Number | text |
| Sender Number | text |
| Subject | text |
| Message Time | text |
Watch Incoming SMSTrigger
| Field | Type |
|---|---|
| Recipient Number | text |
| Sender Number | text |
| Message Text | text |
| Message Time | text |
| Username | text |
| Original Message ID | text |
Watch MMS Delivery ReportsTrigger
| Field | Type |
|---|---|
| Message ID | text |
| Status Code | text |
| Recipient Number | text |
| Custom ID | text |
| Report Time | text |
| Username | text |
Watch Short Link ClicksTrigger
| Field | Type |
|---|---|
| Message ID | text |
| Custom ID | text |
| Link Suffix | text |
| Recipient Number | text |
| First Click Time | text |
| Device Type | text |
| Operating System | text |
| Browser | text |
| Username | text |
| IP Address | text |
Watch SMS Delivery ReportsTrigger
| Field | Type |
|---|---|
| Message ID | text |
| Status Code | text |
| Status Name | text |
| Custom ID | text |
| Sent At | text |
| Report Time | text |
| Username | text |
| Credits Used | text |
| Sender Name | text |
| Recipient Number | text |
| Mobile Country Code | text |
Watch Voice Message ReportsTrigger
| Field | Type |
|---|---|
| Message ID | text |
| Status Code | text |
| Recipient Number | text |
| Custom ID | text |
| Report Time | text |
| Username | text |
| Key Pressed | text |
| Call Duration | text |
Get a ContactSearch
Get a Contact GroupSearch
Get a Contact Group MemberSearch
Get a Contact Group PermissionSearch
Get a Group of a ContactSearch
Get a Sender NameSearch
Get a Short URLSearch
Get a Sub-UserSearch
Get Account ProfileSearch
| Field | Type |
|---|---|
| Name | text |
| text | |
| Username | text |
| Phone Number | text |
| Payment Type | text |
| User Type | text |
| Points | number |
Get an SMS TemplateSearch
Get API StatusSearch
| Field | Type |
|---|---|
| Authorized | boolean |
| Unavailable Services | array |
Get Opt-Out SettingsSearch
| Field | Type |
|---|---|
| Brand | text |
Get Short URL ClicksSearch
Get Short URL Clicks by DeviceSearch
Get Sub-User Sender Name AccessSearch
Get Sub-User Template AccessSearch
Get the Sender Name StatementSearch
| Field | Type |
|---|---|
| Content | text |
| Sections | array |
Get the Trashed Contacts CountSearch
| Field | Type |
|---|---|
| Trashed Contacts | number |
List Available Contact FieldsSearch
List Available SMS TemplatesSearch
List Blacklisted NumbersSearch
List Contact Field OptionsSearch
List Contact FieldsSearch
List Contact Group PermissionsSearch
List Contact GroupsSearch
List ContactsSearch
| Field | Type |
|---|---|
LimitRequired | number |
| Search Text | text |
| Phone Numbers | array |
| Phone Number | text |
| Emails | array |
| text | |
| First Names | array |
| First Name | text |
| Last Names | array |
| Last Name | text |
| In Groups | choice |
| Gender | choice |
| Birthday Dates | array |
| Birthday Date | text |
| Order By | choice |
| Field | Type |
|---|---|
| ID | text |
| First Name | text |
| Last Name | text |
| Phone Number | text |
| text | |
| Gender | text |
| Birthday Date | date |
| Description | text |
| City | text |
| Country | text |
| Source | text |
List Groups of a ContactSearch
List Opt-OutsSearch
List PricesSearch
List RCS MessagesSearch
List RCS SendersSearch
List Sender NamesSearch
List Sending Volumes by CountrySearch
List Short URLsSearch
List SMS TemplatesSearch
List Sub-UsersSearch
Add a Contact Group PermissionAction
Add a Contact to a GroupAction
Add a Contact to Several GroupsAction
Add a Number to the BlacklistAction
Add Blacklisted Numbers From CSVAction
| Field | Type |
|---|---|
CSV TextRequired | text |
Add Contacts to a GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
| Search Text | text |
| Phone Numbers | array |
| Phone Number | text |
| Emails | array |
| text | |
| First Names | array |
| First Name | text |
| Last Names | array |
| Last Name | text |
| In Groups | choice |
| Gender | choice |
| Birthday Dates | array |
| Birthday Date | text |
Check a Verification CodeAction
| Field | Type |
|---|---|
Phone NumberRequired | text |
CodeRequired | text |
Create a ContactAction
| Field | Type |
|---|---|
Phone NumberRequired | text |
EmailRequired | text |
| First Name | text |
| Last Name | text |
| Gender | choice |
| Birthday Date | date |
| Description | text |
| City | text |
| Country | text |
| Source | text |
| Custom ID | text |
| Field | Type |
|---|---|
| ID | text |
| First Name | text |
| Last Name | text |
| Phone Number | text |
| text | |
| Gender | text |
| Birthday Date | date |
| Description | text |
| City | text |
| Country | text |
| Source | text |
Create a Contact FieldAction
Create a Contact GroupAction
Create a Sender NameAction
Create a Short URLAction
Create a Short URL From a FileAction
Create a Sub-UserAction
Create an SMS TemplateAction
Delete a Blacklist EntryAction
| Field | Type |
|---|---|
Blacklist EntryRequired | choice |
Delete a ContactAction
| Field | Type |
|---|---|
ContactRequired | choice |
Delete a Contact FieldAction
| Field | Type |
|---|---|
Contact FieldRequired | choice |
Delete a Contact GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
| Delete Its Contacts Too | choice |
Delete a Contact Group PermissionAction
| Field | Type |
|---|---|
GroupRequired | choice |
Delete a Scheduled MMSAction
Delete a Scheduled SMSAction
Delete a Scheduled Voice MessageAction
Delete a Sender NameAction
| Field | Type |
|---|---|
Sender NameRequired | choice |
Delete a Short URLAction
| Field | Type |
|---|---|
Short URLRequired | choice |
Delete a Sub-UserAction
| Field | Type |
|---|---|
Sub-UserRequired | choice |
Delete All Blacklisted NumbersAction
| Field | Type |
|---|---|
| This clears the whole blacklist | text |
Delete All Contact GroupsAction
| Field | Type |
|---|---|
| This deletes every contact group | text |
Delete All ContactsAction
| Field | Type |
|---|---|
| This deletes every contact in your account | text |
Delete an Opt-OutAction
| Field | Type |
|---|---|
Opt-OutRequired | choice |
Delete an SMS TemplateAction
| Field | Type |
|---|---|
TemplateRequired | choice |
Delete Trashed ContactsAction
| Field | Type |
|---|---|
| This empties the contacts trash for good | text |
Make an API Calluniversal
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
Move Contacts to a GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
| Search Text | text |
| Phone Numbers | array |
| Phone Number | text |
| Emails | array |
| text | |
| First Names | array |
| First Name | text |
| Last Names | array |
| Last Name | text |
| In Groups | choice |
| Gender | choice |
| Birthday Dates | array |
| Birthday Date | text |
Pin a Contact to a GroupAction
Remove a Contact From a GroupAction
| Field | Type |
|---|---|
ContactRequired | choice |
GroupRequired | choice |
Remove a Contact Pin From a GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
ContactRequired | choice |
Remove a Number From the BlacklistAction
| Field | Type |
|---|---|
Phone NumberRequired | text |
Remove Contacts From a GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
| Search Text | text |
| Phone Numbers | array |
| Phone Number | text |
| Emails | array |
| text | |
| First Names | array |
| First Name | text |
| Last Names | array |
| Last Name | text |
| In Groups | choice |
| Gender | choice |
| Birthday Dates | array |
| Birthday Date | text |
Restore Contacts From TrashAction
| Field | Type |
|---|---|
| This restores every trashed contact | text |
Send a Verification CodeAction
Send a Voice MessageAction
| Field | Type |
|---|---|
| Phone Numbers | array |
| Phone Number | text |
| Contact Group | choice |
| Text to Read | text |
| Recording URL | text |
| Voice | text |
| Caller Number | text |
| Send Date | date |
| Check the Date Format | choice |
| Call Attempts | number |
| Retry Interval (Seconds) | number |
| Skip Mobile Phones | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Messages | array |
Send a Voice Message From a FileAction
| Field | Type |
|---|---|
RecordingRequired | text |
| File Name | text |
| Phone Numbers | array |
| Phone Number | text |
| Contact Group | choice |
| Caller Number | text |
| Send Date | date |
| Check the Date Format | choice |
| Call Attempts | number |
| Retry Interval (Seconds) | number |
| Skip Mobile Phones | choice |
| Block Duplicate Custom ID | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Messages | array |
Send an HLR LookupAction
Send an RCS MessageAction
Send MMSAction
| Field | Type |
|---|---|
SubjectRequired | text |
Message Content (SMIL)Required | text |
| Phone Numbers | array |
| Phone Number | text |
| Contact Group | choice |
| Send Date | date |
| Check the Date Format | choice |
| Custom ID | text |
| Block Duplicate Custom ID | choice |
| Delivery Report URL | text |
| Test Mode | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Messages | array |
Send SMSAction
| Field | Type |
|---|---|
Phone NumbersRequired | array |
| Phone Number | text |
MessageRequired | text |
| Sender Name | choice |
| Send Date | date |
| Expiration Date | date |
| Custom ID | text |
| Block Duplicate Custom ID | choice |
| Flash Message | choice |
| Fast Delivery | choice |
| Replace Special Characters | choice |
| Refuse Special Characters | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Length of First Message | number |
| Text of First Message | text |
| Parts of First Message | number |
| Messages | array |
Send SMS From a TemplateAction
| Field | Type |
|---|---|
Phone NumbersRequired | array |
| Phone Number | text |
TemplateRequired | choice |
| Sender Name | choice |
| Send Date | date |
| Expiration Date | date |
| Custom ID | text |
| Block Duplicate Custom ID | choice |
| Flash Message | choice |
| Fast Delivery | choice |
| Replace Special Characters | choice |
| Refuse Special Characters | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Length of First Message | number |
| Text of First Message | text |
| Parts of First Message | number |
| Messages | array |
Send SMS to a Contact GroupAction
| Field | Type |
|---|---|
Contact GroupRequired | choice |
MessageRequired | text |
| Sender Name | choice |
| Send Date | date |
| Expiration Date | date |
| Custom ID | text |
| Block Duplicate Custom ID | choice |
| Flash Message | choice |
| Fast Delivery | choice |
| Replace Special Characters | choice |
| Refuse Special Characters | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Length of First Message | number |
| Text of First Message | text |
| Parts of First Message | number |
| Messages | array |
Send SMS With Voice FallbackAction
| Field | Type |
|---|---|
Phone NumbersRequired | array |
| Phone Number | text |
MessageRequired | text |
| Voice Fallback | choice |
| Announce Sender and Date | choice |
| Sender Name | choice |
| Send Date | date |
| Expiration Date | date |
| Custom ID | text |
| Block Duplicate Custom ID | choice |
| Flash Message | choice |
| Fast Delivery | choice |
| Field | Type |
|---|---|
| Message Count | number |
| Length of First Message | number |
| Text of First Message | text |
| Parts of First Message | number |
| Messages | array |
| Fallback Results | object |
| Voice Message | object |
Set the Default Sender NameAction
| Field | Type |
|---|---|
Sender NameRequired | choice |
Update a ContactAction
| Field | Type |
|---|---|
ContactRequired | choice |
| Phone Number | text |
| text | |
| First Name | text |
| Last Name | text |
| Gender | choice |
| Birthday Date | date |
| Description | text |
| City | text |
| Source | text |
| Field | Type |
|---|---|
| ID | text |
| First Name | text |
| Last Name | text |
| Phone Number | text |
| text | |
| Gender | text |
| Birthday Date | date |
| Description | text |
| City | text |
| Country | text |
| Source | text |
Update a Contact FieldAction
Update a Contact GroupAction
| Field | Type |
|---|---|
GroupRequired | choice |
NameRequired | text |
| Description | text |
| Custom ID | text |
| Contact Expire After (Days) | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Contacts Count | number |
| Date Created | date |
| Date Updated | date |
| Created By | text |
| Custom ID | text |
| Contact Expire After (Days) | number |
| Permissions | array |
Update a Contact Group PermissionAction
Update a Short URLAction
Update a Sub-UserAction
Update an SMS TemplateAction
Update Opt-Out SettingsAction
Update Sub-User Sender Name AccessAction
| Field | Type |
|---|---|
Sub-UserRequired | choice |
AccessRequired | choice |
| Sender Names | choice |
Update Sub-User Template AccessAction
| Field | Type |
|---|---|
Sub-UserRequired | choice |
AccessRequired | choice |
| Templates | array |
| Template | text |
Templates
Look for SMSAPI templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bandwidth[2]Enterprise communications APIs for voice, messaging, and phone number services.
- AcumbamailEmail marketing platform for campaigns, lists, and subscriber automation.
- ButtondownIndie newsletter platform for writing, sending, and managing email lists.
- ArpooneBusiness SMS messaging platform for sending and managing text campaigns.
- Autocalls AIAI phone agents for outbound and inbound calling, lead qualification, and follow-ups.
References
- WEXTL® SMSAPI Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for SMSAPI.
- WEXTL® visual workflow builder data.
Last updated: Oct 12, 2026 11:05