メニュー

Expand
ページを評価:

Assistant

An Assistant is a conversational application or bot that you can deploy across different channels with Twilio's Autopilot.

Each Assistant is independent of other Assistants – you can create multiple Assistants that serve different purposes. For example, you may wish to create an Assistant for a lead-qualification-bot and a different one for support-bot.

All Autopilot REST API resources use the following base URL:

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

Assistant properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Assistant resource.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

friendly_name
文字列 Not PII

The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.

latest_model_build_sid
sid<UG> Not PII

Reserved.

links
uri_map Not PII

A list of the URLs of the Assistant's related resources.

log_queries
boolean Not PII

Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

development_stage
文字列 Not PII

A string describing the state of the assistant.

needs_model_build
boolean Not PII

Whether model needs to be rebuilt.

sid
sid<UA> Not PII

The unique string that we created to identify the Assistant resource.

unique_name
文字列 Not PII

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. It can be up to 64 characters long.

url
url Not PII

The absolute URL of the Assistant resource.

callback_url
url Not PII

Reserved.

callback_events
文字列 Not PII

Reserved.

Create an Assistant resource

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

Creates a new Assistant resource.

パラメーター
Parameters in REST API format
friendly_name
オプション
post 文字列 Not PII

A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.

log_queries
オプション
post boolean Not PII

Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

unique_name
オプション
post 文字列 Not PII

An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the sid in the URL path to address the resource. The first 64 characters must be unique.

callback_url
オプション
post url Not PII

Reserved.

callback_events
オプション
post 文字列 Not PII

Reserved.

style_sheet
オプション
post オブジェクト Not PII

The JSON string that defines the Assistant's style sheet

defaults
オプション
post オブジェクト Not PII

A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks.

例 1
        
        
        
        
        例 2
              
              
              
              
              例 3
                    
                    
                    
                    

                    Fetch an Assistant resource

                    GET
                    https://autopilot.twilio.com/v1/Assistants/{Sid}

                    Returns the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.

                    パラメーター
                    Parameters in REST API format
                    sid
                    Path
                    GET sid_like<UA> Not PII

                    The Twilio-provided string that uniquely identifies the Assistant resource to fetch.

                    例 1
                          
                          
                          
                          

                          Read multiple Assistant resources

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

                          Returns a list of Assistants within an Account. The list includes paging information.

                          例 1
                                
                                
                                
                                

                                Update an Assistant resource

                                post
                                https://autopilot.twilio.com/v1/Assistants/{Sid}

                                Updates the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.

                                パラメーター
                                Parameters in REST API format
                                sid
                                Path
                                post sid_like<UA> Not PII

                                The Twilio-provided string that uniquely identifies the Assistant resource to update.

                                friendly_name
                                オプション
                                post 文字列 Not PII

                                A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

                                log_queries
                                オプション
                                post boolean Not PII

                                Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

                                unique_name
                                オプション
                                post 文字列 Not PII

                                An application-defined string that uniquely identifies the resource. It can be used as an alternative to the sid in the URL path to address the resource. The first 64 characters must be unique.

                                callback_url
                                オプション
                                post url Not PII

                                Reserved.

                                callback_events
                                オプション
                                post 文字列 Not PII

                                Reserved.

                                style_sheet
                                オプション
                                post オブジェクト Not PII

                                The JSON string that defines the Assistant's style sheet

                                defaults
                                オプション
                                post オブジェクト Not PII

                                A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks.

                                development_stage
                                オプション
                                post 文字列 Not PII

                                A string describing the state of the assistant.

                                例 1
                                      
                                      
                                      
                                      
                                      例 2
                                            
                                            
                                            
                                            

                                            Delete an Assistant resource

                                            削除する
                                            https://autopilot.twilio.com/v1/Assistants/{Sid}

                                            Deletes an Assistant.

                                            Deleting an Assistant is potentially a very destructive action. Before it can be deleted, an Assistant cannot have any Intents, Fields, Samples, Field Types, Queries, or Model Builds associated with it. You must delete those first, then delete the Assistant.

                                            パラメーター
                                            Parameters in REST API format
                                            sid
                                            Path
                                            削除する sid_like<UA> Not PII

                                            The Twilio-provided string that uniquely identifies the Assistant resource to delete.

                                            例 1
                                                  
                                                  
                                                  
                                                  
                                                  ページを評価:

                                                  ヘルプが必要ですか?

                                                  誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。

                                                        
                                                        
                                                        

                                                        フィードバックくださりありがとうございます!

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

                                                        Sending your feedback...
                                                        🎉 Thank you for your feedback!
                                                        Something went wrong. Please try again.

                                                        Thanks for your feedback!

                                                        Refer us and get $10 in 3 simple steps!

                                                        ステップ1

                                                        Get link

                                                        Get a free personal referral link here

                                                        ステップ2:

                                                        Give $10

                                                        Your user signs up and upgrade using link

                                                        ステップ3

                                                        Get $10

                                                        1,250 free SMSes
                                                        OR 1,000 free voice mins
                                                        OR 12,000 chats
                                                        OR more