Twilio Autopilot

Documentation >
Apps >
Communication >
Twilio Autopilot

Twilio Autopilot¶

With Twilio Autopilot modules in Ibexa Connect, you can create, update, retrieve, list, and delete:

assistants
tasks
samples
fields

To get started with Twilio Autopilot, create an account at twilio.com.

Connect Twilio Autopilot to Ibexa Connect¶

To connect Twilio Autopilot app, you need to obtain the Account SID and Auth Token values from your Twilio Autopilot account and insert them in the Twilio Autopilot module scenario.

Log in to your Twilio Autopilot account.
Copy the Account Token and Auth Token to a safe.
Log in to your Ibexa Connect account, insert a Twilio Autopilot module scenario, and click the Add button next to the Connection field.
In the Connection name field, enter a name for the connection.
In the Account Token and Auth Token fields, enter the details copied in step 2 and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more Twilio Autopilot modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Assistants¶

You can create, update, retrieve, list, and delete assistants using the following modules.

Create an Assistant¶

Creates a new assistant.

For field descriptions, see the Twilio Autopilot Assistants API reference.

Update an Assistant¶

Updates an assistant.


Assistant SID	Select or map the Assistant SID whose details you want to update.

For field descriptions, see the Twilio Autopilot Assistants API reference.

Get an Assistant¶

Retrieves an assistant.


Assistant SID	Select or map the Assistant SID whose details you want to retrieve.

List Assistant¶

Retrieves a list of assistants.


Limit	Set the maximum number of assistant Ibexa Connect will return during one execution cycle. The default value is 10.

Delete an Assistant¶

Deletes an assistant.


Assistant SID	Select or map the Assistant SID you want to delete.

Tasks¶

You can create, update, retrieve, list, and delete tasks using the following modules.

Create a Task¶

Creates a new task.

For field descriptions, see the Twilio Autopilot Tasks API reference.

Update a Task¶

Updates a task.


Assistant SID	Select or map the Assistant SID whose Task SID you want to update.
Task SID	Select or map the Task SID whose details you want to update.

For field descriptions, see the Twilio Autopilot Tasks API reference.

Get a Task¶

Retrieves a specific task.


Assistant SID	Select or map the Assistant SID whose Task SID you want to retrieve.
Task SID	Select or map the Task SID whose details you want to retrieve.

List Tasks¶

Retrieves a list of tasks.


Assistant SID	Select or map the Assistant SID whose tasks you want to list.
Limit	Set the maximum number of tasks Ibexa Connect will return during one execution cycle. The default value is 10.

Delete a Task¶

Deletes a task.


Assistant SID	Select or map the Assistant SID whose tasks you want to delete.
Task SID	Select or map the Task SID you want to delete.

Samples¶

You can create, update, retrieve, list, and delete samples using the following modules.

Create a Sample¶

Creates a new sample.

For field descriptions, see the Twilio Autopilot Samples API reference.

Update a Sample¶

Updates a sample.

For field descriptions, see the Twilio Autopilot Samples API reference.

Get a Sample¶

Retrieves a specific sample.


Assistant SID	Select or map the Assistant SID whose samples you want to retrieve.
Task SID	Select or map the Task SID whose samples you want to retrieve.
Sample SID	Select or map the Sample SID whose details you want to retrieve.
Language	Select or map the language in which you want to retrieve.

List Samples¶

Retrieves a list of samples.


Limit	Set the maximum number of samples Ibexa Connect will return during one execution cycle. The default value is 10.

For field descriptions, see the Twilio Autopilot Samples API reference.

Delete a Sample¶

Deletes a sample.


Assistant SID	Select or map the Assistant SID whose samples you want to delete.
Task SID	Select or map the Task SID whose samples you want to delete.
Sample SID	Select or map the Sample SID you want to delete.

Fields¶

You can create, update, retrieve, list, and delete fields using the following modules.

Create a Field¶

Creates a new field.

For field descriptions, see the Twilio Autopilot Fields API reference.

Get a Field¶

Retrieves a specific field.


Assistant SID	Select or map the Assistant SID whose fields you want to retrieve.
Task SID	Select or map the Task SID whose fields you want to retrieve.
Filed SID	Select or map the Field SID whose details you want to retrieve.

List Fields¶

Retrieves a list of fields.


Assistant SID	Select or map the Assistant SID whose fields you want to list.
Task SID	Select or map the Task SID whose fields you want to list.
Limit	Set the maximum number of fields Ibexa Connect will return during one execution cycle. The default value is 10.

Delete a Field¶

Deletes a field.


Assistant SID	Select or map the Assistant SID whose fields you want to delete.
Task SID	Select or map the Task SID whose fields you want to delete.
Filed SID	Select or map the Field SID you want to delete.

Other¶

You can call APIs using the following module.

Make an API Call¶

Performs an arbitrary authorized API call.

URL	Enter a path relative to `https://autopilot.twilio.com.` For example, `/v1/Assistants`
Method	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 Tasks¶

The following API call returns all tasks from your account.

URL: /v1/Assistants/{AssistantSid}/Tasks

Method: GET

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

In our example 5 tasks were returned: