メニュー

Expand
ページを評価:

Flow

Flows are individual workflows that you create. Flow definitions are expressed as instances of a JSON schema.

Note: Flow definitions are null in the Flows List Resource. To retrieve the Flow definition, use the Fetch method.

Flow properties

Resource Properties in REST API format
sid
sid<FW> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the Flow resource.

friendly_name
文字列 Not PII

The string that you assigned to describe the Flow.

definition
オブジェクト Not PII

JSON representation of flow definition.

status
enum:status Not PII

The status of the Flow. Can be: draft or published.

revision
integer Not PII

The latest revision number of the Flow's definition.

commit_message
文字列 Not PII

Description of change made in the revision.

valid
boolean Not PII

Boolean if the flow definition is valid.

errors
object[] Not PII

List of error in the flow definition.

warnings
object[] Not PII

List of warnings in the flow definition.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

webhook_url
url Not PII

url
url Not PII

The absolute URL of the resource.

links
uri_map Not PII

The URLs of the Flow's nested resources.

Create a Flow resource

post
https://studio.twilio.com/v2/Flows
パラメーター
Parameters in REST API format
friendly_name
必須
post 文字列 Not PII

The string that you assigned to describe the Flow.

status
必須
post ienum:status Not PII

The status of the Flow. Can be: draft or published.

definition
必須
post オブジェクト Not PII

JSON representation of flow definition.

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

Description of change made in the revision.

例 1
        
        
        

        Fetch a Flow resource

        GET
        https://studio.twilio.com/v2/Flows/{Sid}
        パラメーター
        Parameters in REST API format
        sid
        Path
        GET sid<FW> Not PII

        The SID of the Flow resource to fetch.

        例 1
              
              
              

              Read multiple Flow resources

              GET
              https://studio.twilio.com/v2/Flows

              Note: Flow definitions are null in the Flows List Resource. To retrieve the Flow definition, use the Fetch method.

              例 1
                    
                    
                    

                    Update a Flow resource

                    post
                    https://studio.twilio.com/v2/Flows/{Sid}
                    パラメーター
                    Parameters in REST API format
                    sid
                    Path
                    post sid<FW> Not PII

                    The SID of the Flow resource to fetch.

                    status
                    必須
                    post ienum:status Not PII

                    The status of the Flow. Can be: draft or published.

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

                    The string that you assigned to describe the Flow.

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

                    JSON representation of flow definition.

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

                    Description of change made in the revision.

                    例 1
                          
                          
                          

                          Delete a Flow resource

                          削除する
                          https://studio.twilio.com/v2/Flows/{Sid}
                          パラメーター
                          Parameters in REST API format
                          sid
                          Path
                          削除する sid<FW> Not PII

                          The SID of the Flow resource to delete.

                          例 1
                                
                                
                                
                                ページを評価:

                                ヘルプが必要ですか?

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

                                      
                                      
                                      

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

                                      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