Textlocal¶
With the Textlocal modules in Ibexa Connect you can:
-
create, list, retrieve, and delete contacts
-
watch messages and make API calls
To get started with Textlocal, create an account at textlocal.com/.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Textlocal to Ibexa Connect¶
To connect your Textlocal account to Ibexa Connect you need to obtain the API Key from your Textlocal account and insert it in the Create a connection dialog in the Ibexa Connect module.
-
Log in to your Textlocal account.
-
Click the Settings > API Key.
-
Copy the API Key to a safe place.
-
Log in to your Ibexa Connect and add a module from the Textlocal into a Ibexa Connect scenario.
-
Click Add next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field enter the details copied in step 3 and click Save.
You have successfully connected the Textlocal app with Ibexa Connect and can now build scenarios.
Contacts¶
You can create, list, retrieve, and delete contacts using the following modules.
List Contacts¶
Lists all contacts for the selected group.
| Group ID | Select or map a Group ID whose contacts you want to list. |
| Limit | Set the maximum number of contacts Ibexa Connect will return during one execution cycle. The default value is 10. |
Get a Contact¶
Returns information about the selected contact.
| Group ID | Select or map a Group ID whose contact details you want to retrieve. |
| Number | Enter (map) the contact's mobile number in the international format. For example, 447123456789. |
Create a Contact¶
Creates a new contact.
| Numbers | Enter (map) the contact's mobile number in the international format. For example, 447123456789. |
| Group ID | Select or map a Group ID to which you want to add the contact. |
Delete a Contact¶
Deletes the selected contact.
| Group ID | Select or map a Group ID of a group whose contact you want to delete. |
| Number | Enter (map) the contact's mobile number you want to delete in the international format. For example, 447123456789. |
SMS¶
Watch Messages¶
Triggers when a message is received into an inbox.
| Inbox ID | Select or map an Inbox ID whose messages you want to watch. |
| Limit | Set the maximum number of messages Ibexa Connect will return during one execution cycle. The default value is 2. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API Call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Textlocal API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - Get Contacts¶
The following API call returns all the contacts of a particular group from your Textlocal account:
URL:
/get_contacts/
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body > contacts.
In our example, 5 contacts were returned:
