Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Defaults

Defaults determine your Assistant's behavior in three different situations:

  • assistant_initiation: the assistant is responsible for beginning a conversation, only used for an inbound phone call
  • fallback: the natural language router cannot map human input to an existing task
  • collect: the assistant needs to know which task to use if there is a failure when collecting data

All defaults should point to one of the following:

  • an existing task in the format "task://hello-world"
  • a publically accessible URL that contains the desired set of actions in the format "https://myapp.com/on_failure"

All Autopilot REST API resources use the following base URL:

https://autopilot.twilio.com/v1/

Example Defaults data

{
	"defaults": {
		"assistant_initiation": "task://hello_world",
		"fallback": "task://hello_world",
		"collect": {
			"validate_on_failure": "task://hello_world"
		}
	}
}

Defaults Actions

Names in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Defaults resource.

assistant_sid
sid<UA> Not PII

The SID of the Assistant that is the parent of the resource.

url
url Not PII

The absolute URL of the Defaults resource.

data
object Not PII

The JSON string that describes the default task links for the assistant_initiation, collect, and fallback situations.

Fetch a Defaults resource

get
https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Defaults
Parameters
Names in REST API format
assistant_sid
Path
get sid_like<UA> Not PII

The SID of the Assistant that is the parent of the resource to fetch.

Example
        
        
        
        

        Update a Defaults resource

        post
        https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Defaults
        Parameters
        Names in REST API format
        assistant_sid
        Path
        post sid_like<UA> Not PII

        The SID of the Assistant that is the parent of the resource to update.

        defaults
        Optional
        post object Not PII

        A JSON string that describes the default task links for the assistant_initiation, collect, and fallback situations.

        Example 1
              
              
              
              
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.