メニュー

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?

サービスリソース

A Service is the top-level scope of all other resources in the Programmable Chat REST API. It owns Channels, Users, Messages, Credentials, and all other data for a Chat implementation. Services allow the developer to:

  • 同じ Twilio アカウントの下で、データを分離して複数の環境(dev、stage、prod)を作成する。
  • REST API とクライアント API の両方を通じてリソースへのアクセスのスコープを設定する
  • インスタンスごとのサービスの様々な振る舞いを構成する

またServiceは、関連のあるイベントが発生したときに、開発者によって構成されたURLにHTTP リクエストを送信します。 サービス内で購読できるイベントについては、webhook リファレンスをご覧ください。

Twilio コンソール

You can manage your Programmable Chat Services using your Twilio console when logged in to the console.

プロパティ

各サービスに次のプロパティがあります。

Names in PHP format
sid
sid<IS> Not PII

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

accountSid
sid<AC> Not PII

このサービスに関連するアカウントのユニーク ID です。

friendlyName
文字列 PII MTL: 120 DAYS

このサービスの、人間が読みやすい形式の名前です。

dateCreated
date_time<iso8601> Not PII

The date that this resource was created

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated

defaultServiceRoleSid
sid<RL> Not PII

ユーザーがサービスに追加されたときに割り当てられるサービスロールです。詳細については、ロールエンドポイントをご覧ください。

defaultChannelRoleSid
sid<RL> Not PII

ユーザーがチャンネルに追加されたときに割り当てられるチャンネルロールです。詳細については、ロールエンドポイントをご覧ください。

defaultChannelCreatorRoleSid
sid<RL> Not PII

チャンネルクリエーターが新しいチャンネルに参加するときに割り当てられるチャンネルロールです。詳細については、ロールエンドポイントをご覧ください。

readStatusEnabled
boolean Not PII

Enable the Message Consumption Horizon feature (true if enabled, false if not). Defaults to true.

reachabilityEnabled
boolean Not PII

Indicates whether the the Reachability feature is enabled for this Service instance. Defaults to false.

typingIndicatorTimeout
integer Not PII

[入力終了」メッセージを受け取っておらずとも、「入力開始」イベント後にユーザーがもう入力をしていないとみなすまでの時間を秒数で指定します。 既定は5秒です。

consumptionReportInterval
integer Not PII

DEPRECATED. Value will default to 1 second. The interval in seconds between consumption reports submission batches from client endpoints. Default is 10 seconds.

limits
オブジェクト Not PII

サービスインスタンスレベルでの制限を構成します。 構成できる限界はユーザーごとのチャネル数(既定では250、最大は1,000)、およびチャネルごとの最大メンバー数(既定では100、最大は1,000)です。

preWebhookUrl
文字列 Not PII

The webhook URL for PRE-Event webhooks. See Webhook Events for more details.

postWebhookUrl
文字列 Not PII

The webhook URL for POST-Event webhooks. See Webhook Events for more details.

webhookMethod
文字列 Not PII

PREおよびPOSTのWebhookに対して使用されるWebhookリクエスト形式です。 POSTあるいはGETであることが必要です。 詳細については、Webhook Eventsを参照してください。 既定ではPOSTです。

webhookFilters
string[] Not PII

The list of WebHook events that are enabled for this Service instance. See Webhook Events for more details.

preWebhookRetryCount
integer Not PII

Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

postWebhookRetryCount
integer Not PII

Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

notifications
オブジェクト Not PII

Notification configuration for the Service instance. See Push Notification Configuration for more information.

media
オブジェクト Not PII

url
url Not PII

このサービスの絶対 URL です。

links
uri_map Not PII

このサービスのチャンネルロール、およびユーザーにアクセスするための URL です。

        
        
        
        
        Names in PHP format
        friendlyName
        必須
        post 文字列 PII MTL: 120 DAYS

        このサービスインスタンスの、人間が読みやすい形式の名前です。

              
              
              
              

              Serviceを取得する

              GET /Services/{Service SID}
              
                    
                    
                    
                    

                    Serviceを更新する

                    POST /Services/{Service SID}
                    

                    パラメーター

                    Names in PHP format
                    friendlyName
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    このサービスインスタンスの、人間が読みやすい形式の名前です。

                    defaultChannelRoleSid
                    オプション
                    post sid<RL> Not PII

                    Channel role assigned on channel join (see Roles data model for the details)

                    defaultChannelCreatorRoleSid
                    オプション
                    post sid<RL> Not PII

                    Channel role assigned to creator of channel when joining for first time

                    readStatusEnabled
                    オプション
                    post boolean Not PII

                    true if the member read status feature is enabled, false if not. Defaults to true.

                    reachabilityEnabled
                    オプション
                    post boolean Not PII

                    true if the reachability feature should be enabled. Defaults to false

                    typingIndicatorTimeout
                    オプション
                    post integer Not PII

                    The duration in seconds indicating the timeout after "started typing" event when client should assume that user is not typing anymore even if no "ended typing" message received

                    preWebhookUrl
                    オプション
                    post url Not PII

                    The webhook URL for PRE-Event webhooks. See Webhook Events for more details.

                    postWebhookUrl
                    オプション
                    post url Not PII

                    The webhook URL for POST-Event webhooks. See Webhook Events for more details.

                    webhookMethod
                    オプション
                    post http_method Not PII

                    The webhook request format to use. Must be POST or GET. See Webhook Events for more details.

                    webhookFilters
                    オプション
                    post string[] Not PII

                    The list of WebHook events that are enabled for this Service instance. See Webhook Events for more details.

                    limitsChannelMembers
                    オプション
                    post integer Not PII

                    サービス内のチャネルに追加できるメンバーの最大値です。 最大値は1,000です。

                    limitsUserChannels
                    オプション
                    post integer Not PII

                    ユーザーがこのサービス内でメンバーになれるチャネルの最大数です。 最大は1,000です。

                    preWebhookRetryCount
                    オプション
                    post integer Not PII

                    Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

                    postWebhookRetryCount
                    オプション
                    post integer Not PII

                    Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

                          
                          
                          
                          

                          サービスを削除する

                          DELETE /Services/{Service SID}
                          
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                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.