メニュー

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?

サービスリソース

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

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

accountSid
sid<AC> Not PII

The SID of the Account that created the Service resource.

friendlyName
文字列 PII MTL: 120 DAYS

The string that you assigned to describe the resource.

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

defaultServiceRoleSid
sid<RL> Not PII

The service role assigned to users when they are added to the service. See the Role resource for more info about roles.

defaultChannelRoleSid
sid<RL> Not PII

The channel role assigned to users when they are added to a channel. See the Role resource for more info about roles.

defaultChannelCreatorRoleSid
sid<RL> Not PII

The channel role assigned to a channel creator when they join a new channel. See the Role resource for more info about roles.

readStatusEnabled
boolean Not PII

Whether the Message Consumption Horizon feature is enabled. The default is true.

reachabilityEnabled
boolean Not PII

Whether the Reachability Indicator is enabled for this Service instance. The default is false.

typingIndicatorTimeout
integer Not PII

How long in seconds after a started typing event until clients should assume that user is no longer typing, even if no ended typing message was received. The default is 5 seconds.

consumptionReportInterval
integer Not PII

DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.

limits
オブジェクト Not PII

An object that describes the limits of the service instance. The limits object contains channel_members to describe the members/channel limit and user_channels to describe the channels/user limit. channel_members can be 1,000 or less, with a default of 250. user_channels can be 1,000 or less, with a default value of 100.

preWebhookUrl
文字列 Not PII

The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

postWebhookUrl
文字列 Not PII

The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

webhookMethod
文字列 Not PII

The HTTP method to use for calls to the pre_webhook_url and post_webhook_url webhooks. Can be: POST or GET and the default is POST. See Webhook Events for more details.

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

The number of times to retry a call to the pre_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.

postWebhookRetryCount
integer Not PII

The number of times to retry a call to the post_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.

notifications
オブジェクト Not PII

The notification configuration for the Service instance. See Push Notification Configuration for more info.

media
オブジェクト Not PII

An object that describes the properties of media that the service supports. The object contains the size_limit_mb property, which describes the size of the largest media file in MB; and the compatibility_message property, which contains the message text to send when a media message does not have any text.

url
url Not PII

The absolute URL of the Service resource.

links
uri_map Not PII

The absolute URLs of the Service's Channels, Roles, Bindings, and Users.

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

        A descriptive string that you create to describe the new resource.

              
              
              
              

              Serviceを取得する

              GET /Services/{Service SID}
              
                    
                    
                    
                    

                    Serviceを更新する

                    POST /Services/{Service SID}
                    

                    パラメーター

                    Names in PHP format
                    sid
                    必須
                    post sid<IS> Not PII

                    The SID of the Service resource to update.

                    friendlyName
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    A descriptive string that you create to describe the resource.

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

                    The service role assigned to users when they are added to the service. See the Role resource for more info about roles.

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

                    The channel role assigned to users when they are added to a channel. See the Role resource for more info about roles.

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

                    The channel role assigned to a channel creator when they join a new channel. See the Role resource for more info about roles.

                    readStatusEnabled
                    オプション
                    post boolean Not PII

                    Whether to enable the Message Consumption Horizon feature. The default is true.

                    reachabilityEnabled
                    オプション
                    post boolean Not PII

                    Whether to enable the Reachability Indicator for this Service instance. The default is false.

                    typingIndicatorTimeout
                    オプション
                    post integer Not PII

                    How long in seconds after a started typing event until clients should assume that user is no longer typing, even if no ended typing message was received. The default is 5 seconds.

                    consumptionReportInterval
                    オプション
                    post integer Not PII

                    DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.

                    notificationsNewMessageEnabled
                    オプション
                    post boolean Not PII

                    Whether to send a notification when a new message is added to a channel. The default is false.

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

                    The template to use to create the notification text displayed when a new message is added to a channel and notifications.new_message.enabled is true.

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

                    The name of the sound to play when a new message is added to a channel and notifications.new_message.enabled is true.

                    notificationsNewMessageBadgeCountEnabled
                    オプション
                    post boolean Not PII

                    Whether the new message badge is enabled. The default is false.

                    notificationsAddedToChannelEnabled
                    オプション
                    post boolean Not PII

                    Whether to send a notification when a member is added to a channel. The default is false.

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

                    The template to use to create the notification text displayed when a member is added to a channel and notifications.added_to_channel.enabled is true.

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

                    The name of the sound to play when a member is added to a channel and notifications.added_to_channel.enabled is true.

                    notificationsRemovedFromChannelEnabled
                    オプション
                    post boolean Not PII

                    Whether to send a notification to a user when they are removed from a channel. The default is false.

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

                    The template to use to create the notification text displayed to a user when they are removed from a channel and notifications.removed_from_channel.enabled is true.

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

                    The name of the sound to play to a user when they are removed from a channel and notifications.removed_from_channel.enabled is true.

                    notificationsInvitedToChannelEnabled
                    オプション
                    post boolean Not PII

                    Whether to send a notification when a user is invited to a channel. The default is false.

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

                    The template to use to create the notification text displayed when a user is invited to a channel and notifications.invited_to_channel.enabled is true.

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

                    The name of the sound to play when a user is invited to a channel and notifications.invited_to_channel.enabled is true.

                    preWebhookUrl
                    オプション
                    post url Not PII

                    The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

                    postWebhookUrl
                    オプション
                    post url Not PII

                    The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.

                    webhookMethod
                    オプション
                    post http_method Not PII

                    The HTTP method to use for calls to the pre_webhook_url and post_webhook_url webhooks. Can be: POST or GET and the default is POST. 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

                    The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.

                    limitsUserChannels
                    オプション
                    post integer Not PII

                    The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.

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

                    The message to send when a media message has no text. Can be used as placeholder message.

                    preWebhookRetryCount
                    オプション
                    post integer Not PII

                    The number of times to retry a call to the pre_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.

                    postWebhookRetryCount
                    オプション
                    post integer Not PII

                    The number of times to retry a call to the post_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.

                    notificationsLogEnabled
                    オプション
                    post boolean Not PII

                    Whether to log notifications. The default is false.

                          
                          
                          
                          

                          サービスを削除する

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

                                ヘルプが必要ですか?

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