# `Twilio.Chat.V1.ServiceService`
[🔗](https://github.com/jeffhuen/twilio_elixir/blob/main/lib/twilio/chat/v1/service_service.ex#L2)

Top level scope for all chat resources

Operations: `list`, `create`, `fetch`, `update`, `delete`

# `create`

```elixir
@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Operation: `CreateService` | Tags: ChatV1Service

## Required Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `FriendlyName` | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

# `delete`

```elixir
@spec delete(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}
```

Operation: `DeleteService` | Tags: ChatV1Service

# `fetch`

```elixir
@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Operation: `FetchService` | Tags: ChatV1Service

# `list`

```elixir
@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Operation: `ListService` | Tags: ChatV1Service

# `stream`

```elixir
@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()
```

Stream:  (lazy auto-pagination).

# `update`

```elixir
@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Chat.V1.Service.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}
```

Operation: `UpdateService` | Tags: ChatV1Service

## Optional Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ConsumptionReportInterval` | integer | DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `DefaultChannelCreatorRoleSid` | string | The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `DefaultChannelRoleSid` | string | The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `DefaultServiceRoleSid` | string | The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `FriendlyName` | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Limits.ChannelMembers` | integer | The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Limits.UserChannels` | integer | The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.AddedToChannel.Enabled` | boolean | Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.AddedToChannel.Template` | 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`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.InvitedToChannel.Enabled` | boolean | Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.InvitedToChannel.Template` | 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`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.NewMessage.Enabled` | boolean | Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.NewMessage.Template` | 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`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.RemovedFromChannel.Enabled` | boolean | Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Notifications.RemovedFromChannel.Template` | 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`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `PostWebhookUrl` | string (uri) | The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `PreWebhookUrl` | string (uri) | The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ReachabilityEnabled` | boolean | Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `ReadStatusEnabled` | boolean | Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `TypingIndicatorTimeout` | integer | 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. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `WebhookFilters` | array | The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `WebhookMethod` | string (http-method) | 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](https://www.twilio.com/docs/chat/webhook-events) for more details. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelAdd.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_add.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelAdd.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelAdded.Method` | string (http-method) | The URL of the webhook to call in response to the `on_channel_added` event`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelAdded.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelDestroy.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_destroy.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelDestroy.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelDestroyed.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelDestroyed.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelUpdate.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_update.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelUpdate.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelUpdated.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_updated.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnChannelUpdated.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberAdd.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_member_add.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberAdd.Url` | string (uri) | The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberAdded.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_channel_updated.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberAdded.Url` | string (uri) | The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberRemove.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_member_remove.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberRemove.Url` | string (uri) | The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberRemoved.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_member_removed.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMemberRemoved.Url` | string (uri) | The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageRemove.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_message_remove.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageRemove.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageRemoved.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_message_removed.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageRemoved.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageSend.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_message_send.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageSend.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageSent.Method` | string (http-method) | The URL of the webhook to call in response to the `on_message_sent` event`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageSent.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageUpdate.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_message_update.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageUpdate.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method. |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageUpdated.Method` | string (http-method) | The HTTP method to use when calling the `webhooks.on_message_updated.url`. Values: `GET`, `POST` |
# credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
| `Webhooks.OnMessageUpdated.Url` | string (uri) | The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method. |

---

*Consult [api-reference.md](api-reference.md) for complete listing*