CloudTalk

The CloudTalk modules allow you to monitor, add, update, list, and delete the contacts and activities from your CloudTalk account.

Getting Started with CloudTalk

Prerequisites

  • A CloudTalk account

In order to use CloudTalk with Make, it is necessary to have a CloudTalk account. If you do not have one, you can create a CloudTalk account at my.cloudtalk.io/registration.

Note

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

Connecting CloudTalk to Make

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

  1. Log in to your CloudTalk account.

  2. Click Account >Settings > API Keys.

    61d5adf1b3e7a.gif
  3. Click Show. Copy the Access Key ID and Access Key Secret to a safe place.

    61d5adf42bdae.png
  4. Go to Make and open the CloudTalk module's Create a connection dialog.

    61d5adf5736b2.gif
  5. In the Connection name field, enter a name for the connection.

  6. In the Access Key ID and Access Key Secret fields, enter the key copied in step 3 and click Continue.

The connection has been established.

Contacts

Returns a list of contacts.

Connection

Establish a connection to your CloudTalk account.

Country

Select or map the country to search for the contacts that match the specified country name.

Tag

Enter the tags separated by a comma to search the contacts with the specified tags.

Industry

Enter the industry names separated by a comma to search the contacts that match the specified industries.

Keyword

Enter a keyword to search the contacts that match the specified keyword.

Limit

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

Gets a contact.

Connection

Establish a connection to your CloudTalk account.

Contact ID

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

Creates a contact.

Connection

Establish a connection to your CloudTalk account.

Name

Enter the contact's name.

Title

Enter the contact's position in the company.

Company

Enter the contact's company name.

Industry

Enter the industry name in which the contact's company does business.

Website

Enter the contact's company website URL address.

Address

Enter the contact's or contact's company address. Enter the street name.

City

Enter the city name.

ZIP Code

Enter the area ZIP code.

State

Enter the state name.

Country

Enter the country name.

Favorite Agent

Select or map the favorite agent of the contact.

External URL

Add the List of all URLs which point to a detailed page of contact in an external service. For example, CRMs, Helpdesk, or any other customer service you use. You may list up to three URL addresses.

Contact Number

Enter the contact's mobile or phone number. You can add multiple numbers.

Contact Email

Enter the contact's email address. You can add multiple email addresses.

Contact Tags

Enter the tags separated by a comma to add to the contact.

Contact Attributes

Add the attributes for the contact:

Attribute ID

Select or map the Attribute ID of the contact.

Value

Enter the value for the attribute.

Modifies a contact.

Connection

Establish a connection to your CloudTalk account.

Contact ID

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

Name

Enter the contact's name.

Title

Enter the contact's position in the company.

Company

Enter the contact's company name.

Industry

Enter the industry name in which the contact's company does business.

Website

Enter the contact's company website URL address.

Address

Enter the contact's or contact's company address. Enter the street name.

City

Enter the city name.

ZIP Code

Enter the area ZIP code.

State

Enter the state name.

Country

Enter the country name.

Favorite Agent

Select or map the favorite agent of the contact.

External URL

Add the List of all URLs which point to a detailed page of contact in an external service. For example, CRMs, Helpdesk, or any other customer service you use. You may list up to three URL addresses.

Contact Number

Enter the contact's mobile or phone number. You can add multiple numbers.

Contact Email

Enter the contact's email address. You can add multiple email addresses.

Contact Tags

Enter the tags separated by a comma to add to the contact.

Contact Attributes

Add the attributes for the contact:

Attribute ID

Select or map the Attribute ID of the contact.

Value

Enter the value for the attribute.

Removes a contact.

Connection

Establish a connection to your CloudTalk account.

Contact ID

Select or map the Contact ID you want to delete.

Triggers when a contact has been created.

Connection

Establish a connection to your CloudTalk account.

Limit

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

Activities

Return a list of activities.

Connection

Establish a connection to your CloudTalk account.

Contact ID

Select or map the Contact ID whose activities you want to search.

Activity Type

Select or map the Activity ID whose details you want to search.

Limit

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

Creates an activity.

Connection

Establish a connection to your CloudTalk account.

Contact ID

Select or map the Contact ID whose activity you want to create.

Activity Type

Select or map the activity type:

  • Order

  • Task

  • Chat

  • Ticket

  • Invoice

  • Performa

  • Estimate

  • Cancel

  • Other

Name/Title

Enter the activity name.

Activity Date

Enter the date on which the activity is performed.

Description

Enter the details of the activity.

Activity Author

Enter the user name you want to display on the activity.

External ID

Enter the activity's external ID to identify from an external system. For example, your Order ID.

External URL

Enter the activity's external URL address which can be opened from activity details.

Modifies an activity.

Connection

Establish a connection to your CloudTalk account.

Activity ID

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

Contact ID

Select or map the Contact ID whose activity you want to create.

Activity Type

Select or map the activity type:

  • Order

  • Task

  • Chat

  • Ticket

  • Invoice

  • Performa

  • Estimate

  • Cancel

  • Other

Name/Title

Enter the activity name.

Activity Date

Enter the date on which the activity is performed.

Description

Enter the details of the activity.

Activity Author

Enter the user name you want to display on the activity.

External ID

Enter the activity's external ID to identify from an external system. For example, your Order ID.

External URL

Enter the activity's external URL address which can be opened from activity details.

Removes an activity.

Connection

Establish a connection to your CloudTalk account.

Activity ID

Select or map the Activity ID you want to delete.

Other

Send an SMS.

Connection

Establish a connection to your CloudTalk account.

Recipient

Enter or map the recipient's contact number.

Message

Enter the message text.

Sender

Enter or map the recipient's contact number.

Country Code

Select or map the country code to which you are sending the SMS.

Triggers when a new call has been created.

Connection

Establish a connection to your CloudTalk account.

Limit

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

Performs an arbitrary authorized API call.

Connection

Establish a connection to your CloudTalk account.

URL

Enter a path relative to https://my.cloudtalk.io/api. For example: /contacts/add.json

For the list of available endpoints, refer to the CloudTalk 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.

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

URL:

/contacts/index.json

Method:

GET

61d5adf79e292.png

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example, 2 contacts were returned:

61d5adf8d8a06.png