TextMagic

The TextMagic modules allow you to monitor, add, update, list. and delete the calls, contacts, custom fields, lists, and messages from your TextMagic account.

Getting Started with TextMagic

Prerequisites

  • A TextMagic account

In order to use TextMagic with Make, it is necessary to have a TextMagic account. If you do not have one, you can create a TextMagic account at textmagic.com.

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

To connect your TextMagic account to Make you need to obtain the API Key from your TextMagic account and insert it in the Create a connection dialog in the Make module.

1. Log in to your TextMagic account.

2. Click Accounts > API > Add new API key.

61f27c83b8938.gif

3. Enter your app name and click Generate new key.

61f27c87d2743.png

4. Copy the API Key to your clipboard.

61f27c88dcae8.png

5. Go to Make and open the TextMagic module's Create a connection dialog.

61f27c8a212b1.gif

6. In the Connection name field, enter a name for the connection.

7. In the Username field, enter your TextMagic account's username, You can find the username at Account > Account Settings.

61f27c8cd0e57.gif

8. In the API Key field, enter the API key copied in step 4, and click Continue.

The connection has been established.

Search Lists

Searches lists by given criteria.

Connection

Establish a connection to your TextMagic account.

Limit

Set the maximum number of lists Make should return during one execution cycle.

List IDs

Add the List IDs you want to search.

Query

Enter a keyword or phrase to search the lists that match the specified query.

Only Mine

Select whether you want to search only the lists related to the current user.

Only Default

Select whether you want to search only the default lists related to the current user.

Order By

Select or map the option in which you want to order the lists:

  • List ID

  • Name

  • Members Count

Direction

Select or map the direction in which you want to list the results:

  • Asc

  • Desc

Get a List

Gets the details of a specific list.

Connection

Establish a connection to your TextMagic account.

List ID

Select or map the List ID whose details you want to retrieve.

Create a List

Creates a new list.

Connection

Establish a connection to your TextMagic account.

List Name

Enter the name for the list.

Shared

Select whether the list is shared.

Favorited

Select whether the list is marked as favorite.

Is Default

Select whether this is the default list for new contacts.

Assign Contact to a List

Assigns contacts to a list.

Connection

Establish a connection to your TextMagic account.

List ID

Select or map the List ID to which you want to assign the contact.

Contact ID

Select or map the Contact ID which you want to assign to the list.

Unassign Contact from a List

Unassigns contact from a list.

Connection

Establish a connection to your TextMagic account.

List ID

Select or map the List ID from which you want to unassign the contact.

Contact ID

Select or map the Contact ID which you want to unassign from the list.

Update a List

Updates a list.

Connection

Establish a connection to your TextMagic account.

List ID

Select or map the List ID whose details you want to update.

Name

Enter a new name for the list.

Shared

Select whether the list is shared.

Favorited

Select whether the list is marked as favorite.

Is Default

Select whether this is the default list for new contacts.

Delete a List

Deletes a list.

Connection

Establish a connection to your TextMagic account.

List ID

Select or map the List ID you want to delete.

Search Contacts

Searches contacts by given criteria.

Connection

Establish a connection to your TextMagic account.

Limit

Set the maximum number of contacts Make should return during one execution cycle.

Contact IDs

Add the Contact IDs you want to search.

Shared

Select whether you want to search the shared contacts.

List ID

Select or map the List ID whose contacts you want to search.

Include Blocked

Select whether you want to include the blocked contacts in the results.

Query

Enter a keyword or phrase to search the contacts that match the specified query.

Local

Select whether you want to include the local phone numbers of the contacts in the results.

Exact Match

Select whether you want to search only the contacts that exactly match the search criteria.

Order By

Select or map the option in which you want to order the contacts:

  • Contact ID

  • First Name

  • Last Name

Direction

Select or map the direction in which you want to list the results:

  • Asc

  • Desc

Get a Contact

Gets contact.

Connection

Establish a connection to your TextMagic account.

Contact ID

Select or map the Contact ID whose details you want to retrieve.

Create a Contact

Creates contact.

Connection

Establish a connection to your TextMagic account.

Phone

Enter the contact's phone number. For example, 12125369215.

List ID

Select or map the List ID to which you want to assign the contact.

First Name

Enter (map) the contact's first name.

Last Name

Enter (map) the contact's last name.

Email

Enter (map) the contact's email address.

Company Name

Enter (map) the contact's company name.

Favorited

Select whether you want to mark the contact as favorite.

Blocked

Select whether you want to block the contact.

Type of Phone

Select or map the contact's phone number type:

  • Landline

  • Mobile

Custom Field Values

Add the custom fields and their values for the contact.

Local

Select whether the contact's phone number is local.

Country

Enter the contact's phone number's two-character country code. For example, US for the United States.

Update the Custom Field Value

Updates the custom field value of a specified contact.

Connection

Establish a connection to your TextMagic account.

Custom Field ID

Select or map the Custom Field ID which you want to update for the contact.

Contact ID

Select or map the Contact ID whose values you want to update.

Value

Enter the new value for the custom field.

Update a Contact

Updates contact.

Connection

Establish a connection to your TextMagic account.

Contact ID

Select or map the Contact ID whose value you want o update.

Phone

Enter the contact's phone number. For example, 12125369215.

List ID

Select or map the List ID to which you want to assign the contact.

First Name

Enter (map) the contact's first name.

Last Name

Enter (map) the contact's last name.

Email

Enter (map) the contact's email address.

Company Name

Enter (map) the contact's company name.

Favorited

Select whether you want to mark the contact as favorite.

Blocked

Select whether you want to block the contact.

Type of Phone

Select or map the contact's phone number type:

  • Landline

  • Mobile

Custom Field Values

Add the custom fields and their values for the contact.

Local

Select whether the contact's phone number is local.

Country

Enter the contact's phone number's two-character country code. For example, US for the United States.

Delete a Contact

Deletes contact.

Connection

Establish a connection to your TextMagic account.

Contact ID

Select or map the Contact ID you want to delete.

List Custom Fields

Gets all custom fields.

Connection

Establish a connection to your TextMagic account.

Limit

Set the maximum number of custom fields Make should return during one execution cycle.

Get a Custom Field

Gets a custom field.

Connection

Establish a connection to your TextMagic account.

Custom Field ID

Select or map the Custom Field ID whose details you want to retrieve.

Create a Custom Field

Creates a new custom field.

Connection

Establish a connection to your TextMagic account.

Name

Enter the custom field name.

Update a Custom Field

Updates a custom field.

Connection

Establish a connection to your TextMagic account.

Custom Field ID

Select or map the Custom Field ID whose details you want to update.

Name

Enter the custom field name.

Delete a Custom Field

Deletes a custom field.

Connection

Establish a connection to your TextMagic account.

Custom Field ID

Select or map the Custom Field ID you want to delete.

Note

You do not have to add the webhooks in the TextMagic as it is automatically done for you once you add and save an instant trigger module to your scenario.

Watch Incoming Message

Triggers when a new incoming message is received.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your TextMagic account.

List Outgoing Messages

Gets all messages.

Connection

Establish a connection to your TextMagic account.

Limit

Set the maximum number of outgoing messages Make should return during one execution cycle.

Get an Outgoing Message

Gets a message.

Connection

Establish a connection to your TextMagic account.

Message ID

Select or map the Message ID whose details you want to retrieve.

Send a Message

Sends a message.

Connection

Establish a connection to your TextMagic account.

Text

Enter the message text.

Template ID

Select or map the Template ID for the message.

Contacts

Select or map the contacts to whom you want to send the message. You should specify at least one of the Phones, Contacts, Lists fields.

Lists

Add the lists to which you want to send the message.

Phones

Add the phone numbers to which you want to send the message.

Sending Date Time

Enter the date and time when you want to send the message.

Cut Extra

Select whether you want the sending method to cut extra characters which do not fit supplied partsCount or return 400 Bad request response instead.

Parts Count

Enter the maximum number of parts you can divide the message into. You can divide the message into a maximum of six parts.

Reference ID

Enter the custom message Reference ID.

From

Enter (map) the Sender ID from which you want to send the message. The value should be either a phone number or an alphanumeric sender ID. If specified Sender ID is not allowed for some destinations, a fallback default Sender ID will be used to ensure delivery.

Rrule

Enter the iCal RRULE parameter to create recurrent scheduled messages. Send time is mandatory as the start point of sending. See the Rrule generator for format details.

Create Chat

Select whether you want to create a new chat with recipients.

TTS

Select whether you want to send a text-to-speech message.

Local

Select whether you want to consider the phone numbers as local.

Country

Enter the contact's phone number's two-character country code. For example, US for the United States.

Destination

Select or map the message destination:

  • MMS

  • TTS

Resources

Enter the file name from the MMS attachment response if you are sending the MMS message.

Delete an Outgoing Message

Deletes a message.

Connection

Establish a connection to your TextMagic account.

Message ID

Select or map the Message ID you want to delete.

Note

You do not have to add the webhooks in the TextMagic as it is automatically done for you once you add and save an instant trigger module to your scenario.

Watch Incling Call

Triggers when someone calls your TextMagic number.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your TextMagic account.

Watch Missed Call

Triggers when you miss an incoming call to your Textmagic number.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your TextMagic account.

Change the Forwarding Numbers

Changes the forwarding number.

Connection

Establish a connection to your TextMagic account.

Number ID

Select or map the Number ID which you want to change.

Forwarding Number

Enter the new number you want to change.

Note

You do not have to add the webhooks in the TextMagic as it is automatically done for you once you add and save an instant trigger module to your scenario.

Watch Unsubscriber

Triggers when someone unsubscribed from your communication.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your TextMagic account.

Carrier Lookup

Allows retrieving additional information about a phone number.

Connection

Establish a connection to your TextMagic account.

Phone

Enter the phone number of whose carrier you want to lookup.

Country

Enter the two-character country code to which the phone number belongs. For example, US for the United States.

Email Lookup

Allows retrieving additional information about a phone number.

Connection

Establish a connection to your TextMagic account.

Email Address

Enter (map) the email address you want to lookup.

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your TextMagic account.

URL

Enter a path relative to https://rest.textmagic.com. For example: /api/v2/lists

Note

For the list of available endpoints, refer to the TextMagic 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 - List Contacts

The following API call returns all the contacts from your TextMagic account:

URL: /api/v2/contacts

Method: GET

61f27c8f82766.png

Matches of the search can be found in the module's Output under Bundle > Body > resources. In our example, 2 contacts were returned:

61f27c90add48.png