SMSAPI Integration

Business messaging platform for SMS, RCS, and voice. Connect SMSAPI conversations to the systems your team already uses every day. When Watch Bulk Sends lands, react with Get a Contact or Get a Contact Group.

Explore Documentation

3-day trialCancel anytimeUp to 10 minutes quick set up

GDPR
Data Encryption
2FA
Local Data Region

Supported triggers and actions for SMSAPI integration

Triggers can detect changes in SMSAPI and run actions that can create, search or modify data inside SMSAPI automatically [3] — exactly how you set them.

Watch Bulk SendsTriggers when a bulk send starts.
Watch HLR ResultsTriggers when an HLR lookup result arrives.
Watch Incoming MMSTriggers when a multimedia message is received.
Watch Incoming SMSTriggers when a text message is received.
Watch MMS Delivery ReportsTriggers when a multimedia message gets a delivery report.
Watch Short Link ClicksTriggers when someone clicks a short link.
Watch SMS Delivery ReportsTriggers when a text message gets a delivery report.
Watch Voice Message ReportsTriggers when a voice message gets a delivery report.
Get a ContactReturns a single contact.
Get a Contact GroupReturns a single contact group.
Get a Contact Group MemberReturns a contact if it is in the group.
Get a Contact Group PermissionReturns one user's access to a group.
Get a Group of a ContactReturns a group if the contact belongs to it.
Get a Sender NameReturns a single sender name.
Get a Short URLReturns a single short link.
Get a Sub-UserReturns a single sub-user.
Get Account ProfileReturns the account name, contact details and credit balance.
Get an SMS TemplateReturns a single SMS template.
Get API StatusReturns whether the token is accepted and which services are down.
Get Opt-Out SettingsReturns the brand name shown on the opt-out page.
Get Short URL ClicksRetrieves click statistics for your short links.
Get Short URL Clicks by DeviceRetrieves click statistics for your short links grouped by device.
Get Sub-User Sender Name AccessReturns which of your sender names a sub-user can use.
Get Sub-User Template AccessReturns which of your templates a sub-user can use.
Get the Sender Name StatementReturns the statement text a new sender name must accept.
Get the Trashed Contacts CountReturns how many contacts are in the trash.
List Available Contact FieldsRetrieves the built-in and custom contact fields.
List Available SMS TemplatesRetrieves your templates and the ones shared with your account.
List Blacklisted NumbersRetrieves the numbers that cannot receive your messages.
List Contact Field OptionsRetrieves the choices of a contact field.
List Contact FieldsRetrieves your custom contact fields.
List Contact Group PermissionsRetrieves who can read, write and send to a group.
List Contact GroupsRetrieves a list of contact groups.
List ContactsRetrieves a list of contacts.
List Groups of a ContactRetrieves the groups a contact belongs to.
List Opt-OutsRetrieves the numbers that opted out.
List PricesRetrieves a list of message prices by country and network.
List RCS MessagesRetrieves a list of RCS messages.
List RCS SendersRetrieves a list of RCS senders.
List Sender NamesRetrieves a list of sender names.
List Sending Volumes by CountryRetrieves how many messages were sent to each country.
List Short URLsRetrieves a list of short links.
List SMS TemplatesRetrieves a list of your SMS templates.
List Sub-UsersRetrieves a list of sub-user accounts.
Add a Contact Group PermissionGives a user access to a group.
Add a Contact to a GroupAdds a contact to a group.
Add a Contact to Several GroupsAdds a contact to many groups at once.
Add a Number to the BlacklistBlocks a phone number from receiving your messages.
Add Blacklisted Numbers From CSVBlocks every number in a CSV list.
Add Contacts to a GroupAdds the contacts that match a search to a group.
Check a Verification CodeChecks a code the person typed in.
Create a ContactCreates a contact.
Create a Contact FieldCreates a custom contact field.
Create a Contact GroupCreates a contact group.
Create a Sender NameAdds a sender name for verification.
Create a Short URLCreates a short link.
Create a Short URL From a FileUploads a file and creates a short link to it.
Create a Sub-UserCreates a sub-user account.
Create an SMS TemplateCreates a new SMS template.
Delete a Blacklist EntryDeletes one blacklist entry by its id.
Delete a ContactDeletes a contact.
Delete a Contact FieldDeletes a custom contact field.
Delete a Contact GroupDeletes a contact group, and its contacts if you choose.
Delete a Contact Group PermissionRemoves one user's access to a group.
Delete a Scheduled MMSCancels a multimedia message that has not been sent yet.
Delete a Scheduled SMSCancels a text message that has not been sent yet.
Delete a Scheduled Voice MessageCancels a voice message that has not been sent yet.
Delete a Sender NameDeletes a sender name.
Delete a Short URLDeletes a short link.
Delete a Sub-UserDeletes a sub-user account.
Delete All Blacklisted NumbersClears the whole blacklist.
Delete All Contact GroupsDeletes every contact group.
Delete All ContactsDeletes every contact.
Delete an Opt-OutRemoves a number from the opt-out list.
Delete an SMS TemplateDeletes an SMS template.
Delete Trashed ContactsEmpties the contacts trash for good.
Make an API CallPerforms an arbitrary authorized API call.
Move Contacts to a GroupMoves the contacts that match a search into a group.
Pin a Contact to a GroupAdds a contact to a group and returns the contact.
Remove a Contact From a GroupRemoves a contact from a group.
Remove a Contact Pin From a GroupRemoves a contact from a group by membership.
Remove a Number From the BlacklistRemoves one number from the blacklist by phone number.
Remove Contacts From a GroupRemoves the contacts that match a search from a group.
Restore Contacts From TrashBrings every trashed contact back.
Send a Verification CodeTexts a one-time verification code to a phone number.
Send a Voice MessagePlaces a voice call that reads a text or plays a recording.
Send a Voice Message From a FilePlaces a voice call that plays an uploaded recording.
Send an HLR LookupChecks whether phone numbers are active and which network they use.
Send an RCS MessageSends a single RCS message.
Send MMSSends a multimedia message.
Send SMSSends a text message to one or more phone numbers.
Send SMS From a TemplateSends a text message built from a saved template.
Send SMS to a Contact GroupSends a text message to every contact in a group.
Send SMS With Voice FallbackSends a text message and places a voice call if the text fails.
Set the Default Sender NameMakes a sender name the default for new messages.
Update a ContactUpdates a contact.
Update a Contact FieldRenames a custom contact field.
Update a Contact GroupUpdates a contact group.
Update a Contact Group PermissionChanges one user's access to a group.
Update a Short URLUpdates a short link.
Update a Sub-UserUpdates a sub-user account.
Update an SMS TemplateUpdates an SMS template.
Update Opt-Out SettingsChanges the brand name shown on the opt-out page.
Update Sub-User Sender Name AccessChanges which sender names a sub-user can use.
Update Sub-User Template AccessChanges which templates a sub-user can use.

How to integrate SMSAPI in automation workflow?

3 simple steps to make your SMSAPI connected with other apps in automation workflows on WEXTL. Up to 10 minutes integration set up.

STEP 1

Select SMSAPI in workflow

Pick SMSAPI app in the workflow builder [4] - just one click to select the app.

STEP 2

Connect SMSAPI

When prompted, authorize access to SMSAPI in WEXTL once. SMSAPI credentials are encrypted and never shared with WEXTL. Authorization will be reused in any future API calls [3].

WEXTL wants to integrate with your SMSAPI account. Approve?

STEP 3

Build a workflow

Build your workflow with SMSAPI yourself or with WEXTL® AI Builder. Connect SMSAPI to any available integrations [5], or use HTTP node to go beyond them.

SMSAPI

How SMSAPI connects and integrates with WEXTL

Save and approve your credentials once — WEXTL® stores authorization information encrypted and reuses the authentication whenever SMSAPI app is called in workflows. That allows your communication automations to run without your attention, per defined schedule [7]. Explore documentation [6] for a detailed list of fields that SMSAPI supports.

Full SMSAPI API documentation

The following table illustrates what fields SMSAPI integration require during authorization flow inside our workflow builder [4].

Demonstration of SMSAPI connection step inside WEXTL Workflow Builder [4].

Field	Type	Help
API TokenRequired	password	In your customer portal, open API Tokens, create a token, and tick the permissions the workflow needs. Paste it here.
RegionRequired	select	Pick the site where you log in and made the token.

Connect SMSAPI to popular apps on WEXTL

Enter a name of the other app you want to sync with SMSAPI below. Click on selected app to explore integration options with SMSAPI. If the app you search for is not available in WEXTL yet, you can use HTTP node [10] instead to integrate it directly.

Example automation with SMSAPI integration

Select Watch Incoming SMS trigger from SMSAPI - this will be a starting point in your automation. Whenever event happens in SMSAPI, workflow will start [7] from Watch Incoming SMS node.

Search for Create an SMS Template, connect it as the next step of integration sequence. You can use filters between Watch Incoming SMS and Create an SMS Template, so only important data pass from Watch Incoming SMS to the next step. WEXTL gives you full control over the process of SMSAPI automation. All parts of workflow are visible on the canvas [4].

SMSAPI on WEXTL has 105 modules for combining communication automations. Explore SMSAPI documentation for more.

SMSAPI

Watch Incoming SMS

Bandwidth

Performs action

Bandwidth

Triggers

SMSAPI

Create an SMS Template

Demonstration of how visual SMSAPI automation [6] looks in WEXTL.

Frequently asked questions

Common questions about automating SMSAPI in your workflows.

SMSAPI has 8 triggers, including "Watch Bulk Sends", "Watch HLR Results", and "Watch Incoming MMS", and more. Triggers are start points of the workflow, and automations may start from them.

Integration has 97 actions, including "Get a Contact", "Get a Contact Group", and "Get a Contact Group Member", and more. Refer to our SMSAPI Documentation for detailed inputs and outputs.

No. Most automations are built visually on the canvas by picking triggers, actions, and mapping fields. You can add custom JavaScript with Functions when advanced logic is needed — but our customers do that in rare cases [4].

Yes. Connections are authenticated per account, credentials are encrypted at rest, and you can enforce approvals and team-level access controls on any automation.

The SMSAPI integration on WEXTL runs directly on its vendor public API — every field name, authentication method, and rate limit is controlled by SMSAPI official API and covered in documentation [3]. WEXTL handles the request signing and pagination for you.

Absolutely. Where SMSAPI provides native webhooks, you can use instant triggers to eliminate polling delay. For custom webhooks, WEXTL offers Custom Webhook node, so you can start automation whenever SMSAPI or any other service sends event to webhook URL.

WEXTL is an AI-first visual canvas. The platform allows you to describe automation in plain text — and AI will wire nodes for SMSAPI inside the workflow builder [4]. You can also use built-in workflow nodes (AI Agent, Human in the Loop, Condition, Aggregate Results) in pair with SMSAPI modules to craft complex integration flows with branches, filtering, and conditional logic. There are absolutely no limits of what you can build.

References

List of sources used to gather information about the SMSAPI integration.

SMSAPI integration source code, module specs and credentials implementation.
Internal SMSAPI integration documentation, structured input and output parameters, scopes, and authentication methods.
Official SMSAPI vendor API documentation — used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
WEXTL® Apps Library
WEXTL® SMSAPI App Documentation
WEXTL® Workflow Scheduler
WEXTL® HTTP node documentation

SMSAPI Integration

Supported triggers and actions for SMSAPI integration