Body

• FriendlyName string

  A descriptive string that you create to describe the resource. It can be up to 64 characters long.

• DefaultServiceRoleSid string

  The service role assigned to users when they are added to the service. See the Roles endpoint for more details.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

• DefaultChannelRoleSid string

  The channel role assigned to users when they are added to a channel. See the Roles endpoint for more details.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

• DefaultChannelCreatorRoleSid string

  The channel role assigned to a channel creator when they join a new channel. See the Roles endpoint for more details.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

• ReadStatusEnabled boolean

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

• ReachabilityEnabled boolean

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

• 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.

• ConsumptionReportInterval integer

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

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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.

• PreWebhookUrl string(uri)

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

• PostWebhookUrl string(uri)

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

• 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 for more details.

  Values are GET or POST.

• WebhookFilters array[string]

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

• 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.

• Webhooks.OnMessageSend.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_message_send.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMessageUpdate.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_message_update.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMessageRemove.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_message_remove.url.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelAdd.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_add.url.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelDestroy.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_destroy.url.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelUpdate.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_update.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMemberAdd.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_member_add.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMemberRemove.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_member_remove.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMessageSent.Method string(http-method)

  The URL of the webhook to call in response to the on_message_sent event`.

  Values are GET or POST.

• 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.

• Webhooks.OnMessageUpdated.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_message_updated.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMessageRemoved.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_message_removed.url.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelAdded.Method string(http-method)

  The URL of the webhook to call in response to the on_channel_added event`.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelDestroyed.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_destroyed.url.

  Values are GET or POST.

• 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.

• Webhooks.OnChannelUpdated.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_updated.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMemberAdded.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_channel_updated.url.

  Values are GET or POST.

• 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.

• Webhooks.OnMemberRemoved.Method string(http-method)

  The HTTP method to use when calling the webhooks.on_member_removed.url.

  Values are GET or POST.

• Limits.ChannelMembers integer

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

• Limits.UserChannels integer

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