メニュー

Expand
ページを評価:

Service-Scoped Conversation Resource

A Service-scoped Conversation is a unique thread of a conversation that is scoped or limited to a specific, non-default Conversation Service.

Please see the Conversation Resource for Conversations within the default Conversation Service instance.

APIのベースURL

リファレンスドキュメントの URL はすべて、次のベース URL を使用しています。

https://conversations.twilio.com/v1

For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:

GET /v1/Services/ISxx/Conversations/CHxx/Messages

Service-Scoped Conversation Properties

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

The unique ID of the Account responsible for this conversation.

chat_service_sid
sid<IS> Not PII

The unique ID of the Conversation Service this conversation belongs to.

messaging_service_sid
sid<MG> Not PII

The unique ID of the Messaging Service this conversation belongs to.

sid
sid<CH> Not PII

このリソースを一意に識別する 34 文字の文字列です。

friendly_name
文字列 PII MTL: 30 DAYS

The human-readable name of this conversation, limited to 256 characters. Optional.

unique_name
文字列 PII MTL: 30 DAYS

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

attributes
文字列 PII MTL: 30 DAYS

An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

state
enum:state Not PII

Current state of this conversation. Can be either active, inactive or closed and defaults to active

date_created
date_time<iso8601> Not PII

このリソースの作成された日付です。

date_updated
date_time<iso8601> Not PII

このリソースが最後に更新された日付です。

timers
オブジェクト Not PII

Timer date values representing state update for this conversation.

url
url Not PII

An absolute API resource URL for this conversation.

links
uri_map Not PII

Contains absolute URLs to access the participants, messages and webhooks of this conversation.

Create a Service-Scoped Conversation

post
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
パラメーター
Parameters in REST API format
chat_service_sid
Path
post sid<IS> Not PII

The SID of the Conversation Service the Conversation resource is associated with.

friendly_name
オプション
post 文字列 PII MTL: 30 DAYS

The human-readable name of this conversation, limited to 256 characters. Optional.

unique_name
オプション
post 文字列 PII MTL: 30 DAYS

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

attributes
オプション
post 文字列 PII MTL: 30 DAYS

An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

messaging_service_sid
オプション
post sid<MG> Not PII

The unique ID of the Messaging Service this conversation belongs to.

date_created
オプション
post date_time<iso8601> Not PII

このリソースの作成された日付です。

date_updated
オプション
post date_time<iso8601> Not PII

このリソースが最後に更新された日付です。

state
オプション
post ienum:state Not PII

Current state of this conversation. Can be either active, inactive or closed and defaults to active

timers.inactive
オプション
post 文字列 Not PII

ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.

timers.closed
オプション
post 文字列 Not PII

ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.

x_twilio_webhook_enabled
ヘッダー
post ienum:webhook_enabled_type Not PII

The X-Twilio-Webhook-Enabled HTTP request header

例 1
        
        
        
        

        Fetch a Service-Scoped Conversation

        GET
        https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
        パラメーター
        Parameters in REST API format
        chat_service_sid
        Path
        GET sid<IS> Not PII

        The SID of the Conversation Service the Conversation resource is associated with.

        sid
        Path
        GET sid_like<CH> Not PII

        A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

        例 1
              
              
              
              

              Read multiple Service-Scoped Conversation resources

              GET
              https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations
              パラメーター
              Parameters in REST API format
              chat_service_sid
              Path
              GET sid<IS> Not PII

              The SID of the Conversation Service the Conversation resource is associated with.

              例 1
                    
                    
                    
                    

                    Update a Service-Scoped Conversation resource

                    post
                    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
                    パラメーター
                    Parameters in REST API format
                    chat_service_sid
                    Path
                    post sid<IS> Not PII

                    The SID of the Conversation Service the Conversation resource is associated with.

                    sid
                    Path
                    post sid_like<CH> Not PII

                    A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

                    friendly_name
                    オプション
                    post 文字列 PII MTL: 30 DAYS

                    The human-readable name of this conversation, limited to 256 characters. Optional.

                    date_created
                    オプション
                    post date_time<iso8601> Not PII

                    このリソースの作成された日付です。

                    date_updated
                    オプション
                    post date_time<iso8601> Not PII

                    このリソースが最後に更新された日付です。

                    attributes
                    オプション
                    post 文字列 PII MTL: 30 DAYS

                    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

                    messaging_service_sid
                    オプション
                    post sid<MG> Not PII

                    The unique ID of the Messaging Service this conversation belongs to.

                    state
                    オプション
                    post ienum:state Not PII

                    Current state of this conversation. Can be either active, inactive or closed and defaults to active

                    timers.inactive
                    オプション
                    post 文字列 Not PII

                    ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.

                    timers.closed
                    オプション
                    post 文字列 Not PII

                    ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.

                    unique_name
                    オプション
                    post 文字列 PII MTL: 30 DAYS

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

                    x_twilio_webhook_enabled
                    ヘッダー
                    post ienum:webhook_enabled_type Not PII

                    The X-Twilio-Webhook-Enabled HTTP request header

                    例 1
                          
                          
                          
                          

                          Delete a Service-Scoped Conversation

                          削除する
                          https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{Sid}
                          パラメーター
                          Parameters in REST API format
                          chat_service_sid
                          Path
                          削除する sid<IS> Not PII

                          The SID of the Conversation Service the Conversation resource is associated with.

                          sid
                          Path
                          削除する sid_like<CH> Not PII

                          A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

                          x_twilio_webhook_enabled
                          ヘッダー
                          削除する ienum:webhook_enabled_type Not PII

                          The X-Twilio-Webhook-Enabled HTTP request header

                          例 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