All URIs are relative to https://chat.twilio.com
| Method | HTTP request | Description |
|---|---|---|
| CreateService | Post /v2/Services | |
| DeleteService | Delete /v2/Services/{Sid} | |
| FetchService | Get /v2/Services/{Sid} | |
| ListService | Get /v2/Services | |
| UpdateService | Post /v2/Services/{Sid} |
ChatV2Service CreateService(ctx, optional)
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a CreateServiceParams struct
| Name | Type | Description |
|---|---|---|
| FriendlyName | string | A descriptive string that you create to describe the new resource. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteService(ctx, Sid)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the Service resource to delete. |
Other parameters are passed through a pointer to a DeleteServiceParams struct
| Name | Type | Description |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChatV2Service FetchService(ctx, Sid)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the Service resource to fetch. |
Other parameters are passed through a pointer to a FetchServiceParams struct
| Name | Type | Description |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]ChatV2Service ListService(ctx, optional)
This endpoint does not need any path parameter.
Other parameters are passed through a pointer to a ListServiceParams struct
| Name | Type | Description |
|---|---|---|
| PageSize | int | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Limit | int | Max number of records to return. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChatV2Service UpdateService(ctx, Sidoptional)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| Sid | string | The SID of the Service resource to update. |
Other parameters are passed through a pointer to a UpdateServiceParams struct
| Name | Type | Description |
|---|---|---|
| FriendlyName | string | A descriptive string that you create to describe the resource. |
| DefaultServiceRoleSid | string | The service role assigned to users when they are added to the service. See the Role resource for more info about roles. |
| DefaultChannelRoleSid | string | The channel role assigned to users when they are added to a channel. See the Role resource for more info about roles. |
| DefaultChannelCreatorRoleSid | string | The channel role assigned to a channel creator when they join a new channel. See the Role resource for more info about roles. |
| ReadStatusEnabled | bool | Whether to enable the Message Consumption Horizon feature. The default is true. |
| ReachabilityEnabled | bool | Whether to enable the Reachability Indicator for this Service instance. The default is false. |
| TypingIndicatorTimeout | int | 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 | int | DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints. |
| NotificationsNewMessageEnabled | bool | Whether to send a notification when a new message is added to a channel. The default is false. |
| NotificationsNewMessageTemplate | string | 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 | string | The name of the sound to play when a new message is added to a channel and notifications.new_message.enabled is true. |
| NotificationsNewMessageBadgeCountEnabled | bool | Whether the new message badge is enabled. The default is false. |
| NotificationsAddedToChannelEnabled | bool | Whether to send a notification when a member is added to a channel. The default is false. |
| NotificationsAddedToChannelTemplate | string | 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 | string | The name of the sound to play when a member is added to a channel and notifications.added_to_channel.enabled is true. |
| NotificationsRemovedFromChannelEnabled | bool | Whether to send a notification to a user when they are removed from a channel. The default is false. |
| NotificationsRemovedFromChannelTemplate | string | 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 | string | 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 | bool | Whether to send a notification when a user is invited to a channel. The default is false. |
| NotificationsInvitedToChannelTemplate | string | 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 | string | The name of the sound to play when a user is invited to a channel and notifications.invited_to_channel.enabled is true. |
| PreWebhookUrl | string | The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details. |
| PostWebhookUrl | string | The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details. |
| WebhookMethod | string | 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 | The list of webhook events that are enabled for this Service instance. See Webhook Events for more details. |
| LimitsChannelMembers | int | The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000. |
| LimitsUserChannels | int | The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000. |
| MediaCompatibilityMessage | string | The message to send when a media message has no text. Can be used as placeholder message. |
| PreWebhookRetryCount | int | 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 | int | 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 | bool | Whether to log notifications. The default is false. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]