components: schemas: chat.v2.credential: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string sandbox: description: '[APN only] Whether to send the credential to sandbox APNs' nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^CR[0-9a-fA-F]{32}$ type: string type: description: The type of push-notification service the credential is for enum: - gcm - apn - fcm nullable: true type: string url: description: The absolute URL of the Credential resource format: uri nullable: true type: string type: object chat.v2.service: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string consumption_report_interval: description: DEPRECATED nullable: true type: integer date_created: description: The RFC 2822 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT when the resource was last updated format: date-time nullable: true type: string default_channel_creator_role_sid: description: The channel role assigned to a channel creator when they join a new channel maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string default_channel_role_sid: description: The channel role assigned to users when they are added to a channel maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string default_service_role_sid: description: The service role assigned to users when they are added to the service maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string limits: description: An object that describes the limits of the service instance nullable: true type: object links: description: The absolute URLs of the Service's Channels, Roles, and Users nullable: true type: object media: description: The properties of the media that the service supports nullable: true type: object notifications: description: The notification configuration for the Service instance nullable: true type: object post_webhook_retry_count: description: The number of times calls to the `post_webhook_url` will be retried nullable: true type: integer post_webhook_url: description: The URL for post-event webhooks nullable: true type: string pre_webhook_retry_count: description: Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses nullable: true type: integer pre_webhook_url: description: The webhook URL for pre-event webhooks nullable: true type: string reachability_enabled: description: Whether the Reachability Indicator feature is enabled for this Service instance nullable: true type: boolean read_status_enabled: description: Whether the Message Consumption Horizon feature is enabled nullable: true type: boolean sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string typing_indicator_timeout: description: How long in seconds to wait before assuming the user is no longer typing nullable: true type: integer url: description: The absolute URL of the Service resource format: uri nullable: true type: string webhook_filters: description: The list of webhook events that are enabled for this Service instance items: type: string nullable: true type: array webhook_method: description: The HTTP method to use for both PRE and POST webhooks nullable: true type: string type: object chat.v2.service.binding: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string binding_type: description: The push technology to use for the binding enum: - gcm - apn - fcm nullable: true type: string credential_sid: description: The SID of the Credential for the binding maxLength: 34 minLength: 34 nullable: true pattern: ^CR[0-9a-fA-F]{32}$ type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string endpoint: description: The unique endpoint identifier for the Binding nullable: true type: string identity: description: The string that identifies the resource's User nullable: true type: string links: description: The absolute URLs of the Binding's User nullable: true type: object message_types: description: The Programmable Chat message types the binding is subscribed to items: type: string nullable: true type: array service_sid: description: The SID of the Service that the Binding resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^BS[0-9a-fA-F]{32}$ type: string url: description: The absolute URL of the Binding resource format: uri nullable: true type: string type: object chat.v2.service.channel: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string attributes: description: The JSON string that stores application-specific data nullable: true type: string created_by: description: The identity of the User that created the channel nullable: true type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string links: description: Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel nullable: true type: object members_count: description: The number of Members in the Channel nullable: true type: integer messages_count: description: The number of Messages that have been passed in the Channel nullable: true type: integer service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string type: description: 'The visibility of the channel. Can be: `public` or `private`' enum: - public - private nullable: true type: string unique_name: description: An application-defined string that uniquely identifies the resource nullable: true type: string url: description: The absolute URL of the Channel resource format: uri nullable: true type: string type: object chat.v2.service.channel.channel_webhook: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string channel_sid: description: The SID of the Channel the Channel Webhook resource belongs to maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string configuration: description: The JSON string that describes the configuration object for the channel webhook nullable: true type: object date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string service_sid: description: The SID of the Service that the Channel Webhook resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^WH[0-9a-fA-F]{32}$ type: string type: description: The type of webhook nullable: true type: string url: description: The absolute URL of the Channel Webhook resource format: uri nullable: true type: string type: object chat.v2.service.channel.invite: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string channel_sid: description: The SID of the Channel the new resource belongs to maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string created_by: description: The identity of the User that created the invite nullable: true type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string identity: description: The string that identifies the resource's User nullable: true type: string role_sid: description: The SID of the Role assigned to the member maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^IN[0-9a-fA-F]{32}$ type: string url: description: The absolute URL of the Invite resource format: uri nullable: true type: string type: object chat.v2.service.channel.member: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string attributes: description: The JSON string that stores application-specific data nullable: true type: string channel_sid: description: The SID of the Channel for the member maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string identity: description: The string that identifies the resource's User nullable: true type: string last_consumed_message_index: description: The index of the last Message that the Member has read within the Channel nullable: true type: integer last_consumption_timestamp: description: The ISO 8601 based timestamp string that represents the datetime of the last Message read event for the Member within the Channel format: date-time nullable: true type: string role_sid: description: The SID of the Role assigned to the member maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^MB[0-9a-fA-F]{32}$ type: string url: description: The absolute URL of the Member resource format: uri nullable: true type: string type: object chat.v2.service.channel.message: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string attributes: description: The JSON string that stores application-specific data nullable: true type: string body: description: The content of the message nullable: true type: string channel_sid: description: The SID of the Channel the Message resource belongs to maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT when the resource was last updated format: date-time nullable: true type: string from: description: The Identity of the message's author nullable: true type: string index: description: The index of the message within the Channel nullable: true type: integer last_updated_by: description: The Identity of the User who last updated the Message nullable: true type: string media: description: A Media object that describes the Message's media if attached; otherwise, null nullable: true type: object service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^IM[0-9a-fA-F]{32}$ type: string to: description: The SID of the Channel that the message was sent to maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string type: description: The Message type nullable: true type: string url: description: The absolute URL of the Message resource format: uri nullable: true type: string was_edited: description: Whether the message has been edited since it was created nullable: true type: boolean type: object chat.v2.service.role: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string permissions: description: An array of the permissions the role has been granted items: type: string nullable: true type: array service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string type: description: The type of role enum: - channel - deployment nullable: true type: string url: description: The absolute URL of the Role resource format: uri nullable: true type: string type: object chat.v2.service.user: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string attributes: description: The JSON string that stores application-specific data nullable: true type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string identity: description: The string that identifies the resource's User nullable: true type: string is_notifiable: description: Whether the User has a potentially valid Push Notification registration for the Service instance nullable: true type: boolean is_online: description: Whether the User is actively connected to the Service instance and online nullable: true type: boolean joined_channels_count: description: The number of Channels the User is a Member of nullable: true type: integer links: description: The absolute URLs of the Channel and Binding resources related to the user nullable: true type: object role_sid: description: The SID of the Role assigned to the user maxLength: 34 minLength: 34 nullable: true pattern: ^RL[0-9a-fA-F]{32}$ type: string service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^US[0-9a-fA-F]{32}$ type: string url: description: The absolute URL of the User resource format: uri nullable: true type: string type: object chat.v2.service.user.user_binding: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string binding_type: description: The push technology to use for the binding enum: - gcm - apn - fcm nullable: true type: string credential_sid: description: The SID of the Credential for the binding maxLength: 34 minLength: 34 nullable: true pattern: ^CR[0-9a-fA-F]{32}$ type: string date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time nullable: true type: string date_updated: description: The ISO 8601 date and time in GMT when the resource was last updated format: date-time nullable: true type: string endpoint: description: The unique endpoint identifier for the User Binding nullable: true type: string identity: description: The string that identifies the resource's User nullable: true type: string message_types: description: The Programmable Chat message types the binding is subscribed to items: type: string nullable: true type: array service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^BS[0-9a-fA-F]{32}$ type: string url: description: The absolute URL of the User Binding resource format: uri nullable: true type: string user_sid: description: The SID of the User with the binding maxLength: 34 minLength: 34 nullable: true pattern: ^US[0-9a-fA-F]{32}$ type: string type: object chat.v2.service.user.user_channel: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string channel_sid: description: The SID of the Channel the resource belongs to maxLength: 34 minLength: 34 nullable: true pattern: ^CH[0-9a-fA-F]{32}$ type: string last_consumed_message_index: description: The index of the last Message in the Channel the Member has read nullable: true type: integer links: description: Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel nullable: true type: object member_sid: description: The SID of the User as a Member in the Channel maxLength: 34 minLength: 34 nullable: true pattern: ^MB[0-9a-fA-F]{32}$ type: string notification_level: description: The push notification level of the User for the Channel enum: - default - muted nullable: true type: string service_sid: description: The SID of the Service that the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^IS[0-9a-fA-F]{32}$ type: string status: description: The status of the User on the Channel enum: - joined - invited - not_participating nullable: true type: string unread_messages_count: description: The number of unread Messages in the Channel for the User nullable: true type: integer url: description: The absolute URL of the resource format: uri nullable: true type: string user_sid: description: The SID of the User the User Channel belongs to maxLength: 34 minLength: 34 nullable: true pattern: ^US[0-9a-fA-F]{32}$ type: string type: object securitySchemes: accountSid_authToken: scheme: basic type: http info: contact: email: support@twilio.com name: Twilio Support url: https://support.twilio.com description: This is the public Twilio REST API. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Chat version: 1.27.0 openapi: 3.0.1 paths: /v2/Credentials: description: Credentials for push notifications channels get: description: '' operationId: ListCredential parameters: - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: credentials: items: $ref: '#/components/schemas/chat.v2.credential' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListCredentialResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateCredential requestBody: content: application/x-www-form-urlencoded: schema: properties: ApiKey: description: '[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.' type: string Certificate: description: "[APN only] The URL encoded representation of the certificate.\ \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n\ -----END CERTIFICATE-----`" type: string FriendlyName: description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. type: string PrivateKey: description: '[APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----`' type: string Sandbox: description: '[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.' type: boolean Secret: description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' type: string Type: description: 'The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.' enum: - gcm - apn - fcm type: string required: - Type title: CreateCredentialRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list /v2/Credentials/{Sid}: delete: description: '' operationId: DeleteCredential parameters: - description: The SID of the Credential resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Credentials for push notifications channels get: description: '' operationId: FetchCredential parameters: - description: The SID of the Credential resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateCredential parameters: - description: The SID of the Credential resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ApiKey: description: '[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.' type: string Certificate: description: "[APN only] The URL encoded representation of the certificate.\ \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n\ -----END CERTIFICATE-----`" type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string PrivateKey: description: '[APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----`' type: string Sandbox: description: '[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.' type: boolean Secret: description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' type: string title: UpdateCredentialRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.credential' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance /v2/Services: description: Top level scope for all chat resources get: description: '' operationId: ListService parameters: - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object services: items: $ref: '#/components/schemas/chat.v2.service' type: array title: ListServiceResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateService requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the new resource. type: string required: - FriendlyName title: CreateServiceRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: list /v2/Services/{ServiceSid}/Bindings: description: Push notification subscription for users get: description: '' operationId: ListBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Binding resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: 'The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.' in: query name: BindingType schema: items: enum: - gcm - apn - fcm type: string type: array - description: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. in: query name: Identity schema: items: type: string type: array - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: bindings: items: $ref: '#/components/schemas/chat.v2.service.binding' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListBindingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: list /v2/Services/{ServiceSid}/Bindings/{Sid}: delete: description: '' operationId: DeleteBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Binding resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Binding resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Push notification subscription for users get: description: '' operationId: FetchBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Binding resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Binding resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.binding' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: instance /v2/Services/{ServiceSid}/Channels: description: Channels represent chat rooms get: description: '' operationId: ListChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Channel resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: 'The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.' in: query name: Type schema: items: enum: - public - private type: string type: array - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: channels: items: $ref: '#/components/schemas/chat.v2.service.channel' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListChannelResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Channel resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string CreatedBy: description: 'The `identity` of the User that created the channel. Default is: `system`.' type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated. format: date-time type: string FriendlyName: description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. type: string Type: description: 'The visibility of the channel. Can be: `public` or `private` and defaults to `public`.' enum: - public - private type: string UniqueName: description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service. type: string title: CreateChannelRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: description: Pending invitations to users to become channel members get: description: '' operationId: ListInvite parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Invite resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. in: query name: Identity schema: items: type: string type: array - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: invites: items: $ref: '#/components/schemas/chat.v2.service.channel.invite' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListInviteResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateInvite parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Invite resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Invite resource belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Identity: description: The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. type: string RoleSid: description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new member. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string required: - Identity title: CreateInviteRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: delete: description: '' operationId: DeleteInvite parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Invite resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Invite resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Pending invitations to users to become channel members get: description: '' operationId: FetchInvite parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Invite resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Invite resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Invite resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.invite' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: description: Users joined to specific channels get: description: '' operationId: ListMember parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Member resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details. in: query name: Identity schema: items: type: string type: array - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: members: items: $ref: '#/components/schemas/chat.v2.service.channel.member' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListMemberResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateMember parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Member resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Member resource belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated. format: date-time type: string Identity: description: The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. type: string LastConsumedMessageIndex: description: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source. nullable: true type: integer LastConsumptionTimestamp: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). format: date-time type: string RoleSid: description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string required: - Identity title: CreateMemberRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: delete: description: '' operationId: DeleteMember parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Member resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Member resource to delete. This value can be either the Member's `sid` or its `identity` value. in: path name: Sid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Users joined to specific channels get: description: '' operationId: FetchMember parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Member resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Member resource to fetch. This value can be either the Member's `sid` or its `identity` value. in: path name: Sid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateMember parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Member resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value. in: path name: Sid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. format: date-time type: string LastConsumedMessageIndex: description: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels). nullable: true type: integer LastConsumptionTimestamp: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). format: date-time type: string RoleSid: description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource). maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string title: UpdateMemberRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.member' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: description: Individual chat messages get: description: '' operationId: ListMessage parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Message resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to read belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: 'The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.' in: query name: Order schema: enum: - asc - desc type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: messages: items: $ref: '#/components/schemas/chat.v2.service.channel.message' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListMessageResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateMessage parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Message resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Message resource belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string Body: description: The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string. type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. format: date-time type: string From: description: The [Identity](https://www.twilio.com/docs/chat/identity) of the new message's author. The default value is `system`. type: string LastUpdatedBy: description: The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable. type: string MediaSid: description: The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message. maxLength: 34 minLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ type: string title: CreateMessageRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - date_created pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: delete: description: '' operationId: DeleteMessage parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Message resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Message resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Individual chat messages get: description: '' operationId: FetchMessage parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Message resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Message resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateMessage parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Message resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Message resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string Body: description: The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string. type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. format: date-time type: string From: description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. type: string LastUpdatedBy: description: The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable. type: string title: UpdateMessageRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.message' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - date_created pathType: instance /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: description: Webhooks for specific channels get: description: '' operationId: ListChannelWebhook parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to read the resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resources to read belong to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object webhooks: items: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' type: array title: ListChannelWebhookResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateChannelWebhook parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to create the Webhook resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the new Channel Webhook resource belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Configuration.Filters: description: The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). items: type: string type: array Configuration.FlowSid: description: The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`. maxLength: 34 minLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ type: string Configuration.Method: description: 'The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.' enum: - GET - POST type: string Configuration.RetryCount: description: The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0. type: integer Configuration.Triggers: description: A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`. items: type: string type: array Configuration.Url: description: The URL of the webhook to call using the `configuration.method`. type: string Type: description: 'The type of webhook. Can be: `webhook`, `studio`, or `trigger`.' enum: - webhook - trigger - studio type: string required: - Type title: CreateChannelWebhookRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - configuration pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: delete: description: '' operationId: DeleteChannelWebhook parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to delete the Webhook resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to delete belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Channel Webhook resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Webhooks for specific channels get: description: '' operationId: FetchChannelWebhook parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel to fetch the Webhook resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to fetch belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Channel Webhook resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateChannelWebhook parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel that has the Webhook resource to update. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string - description: The SID of the Channel Webhook resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Configuration.Filters: description: The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger). items: type: string type: array Configuration.FlowSid: description: The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` = `studio`. maxLength: 34 minLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ type: string Configuration.Method: description: 'The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.' enum: - GET - POST type: string Configuration.RetryCount: description: The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0. type: integer Configuration.Triggers: description: A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`. items: type: string type: array Configuration.Url: description: The URL of the webhook to call using the `configuration.method`. type: string title: UpdateChannelWebhookRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel.channel_webhook' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - configuration pathType: instance /v2/Services/{ServiceSid}/Channels/{Sid}: delete: description: '' operationId: DeleteChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Channel resource to delete. This value can be either the `sid` or the `unique_name` of the Channel resource to delete. in: path name: Sid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Channels represent chat rooms get: description: '' operationId: FetchChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Channel resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Channel resource to fetch. This value can be either the `sid` or the `unique_name` of the Channel resource to fetch. in: path name: Sid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Channel resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Channel resource to update. This value can be either the `sid` or the `unique_name` of the Channel resource to update. in: path name: Sid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string CreatedBy: description: 'The `identity` of the User that created the channel. Default is: `system`.' type: string DateCreated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source. format: date-time type: string DateUpdated: description: The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. format: date-time type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 256 characters long. type: string UniqueName: description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 256 characters or less in length and unique within the Service. type: string title: UpdateChannelRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.channel' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: instance /v2/Services/{ServiceSid}/Roles: description: Roles determining user or member permissions get: description: '' operationId: ListRole parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the Role resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object roles: items: $ref: '#/components/schemas/chat.v2.service.role' type: array title: ListRoleResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateRole parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the Role resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. type: string Permission: description: A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`. items: type: string type: array Type: description: 'The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.' enum: - channel - deployment type: string required: - FriendlyName - Type - Permission title: CreateRoleRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list /v2/Services/{ServiceSid}/Roles/{Sid}: delete: description: '' operationId: DeleteRole parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the Role resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Role resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Roles determining user or member permissions get: description: '' operationId: FetchRole parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the Role resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Role resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateRole parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the Role resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the Role resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Permission: description: A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`. items: type: string type: array required: - Permission title: UpdateRoleRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.role' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance /v2/Services/{ServiceSid}/Users: description: Unique chat users within a chat service get: description: '' operationId: ListUser parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object users: items: $ref: '#/components/schemas/chat.v2.service.user' type: array title: ListUserResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateUser parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the User resource under. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string FriendlyName: description: A descriptive string that you create to describe the new resource. This value is often used for display purposes. type: string Identity: description: The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or email address. See the Identity documentation for more info. type: string RoleSid: description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new User. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string required: - Identity title: CreateUserRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created pathType: list /v2/Services/{ServiceSid}/Users/{Sid}: delete: description: '' operationId: DeleteUser parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the User resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete. in: path name: Sid required: true schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Unique chat users within a chat service get: description: '' operationId: FetchUser parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch. in: path name: Sid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateUser parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the User resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update. in: path name: Sid required: true schema: type: string - description: The X-Twilio-Webhook-Enabled HTTP request header in: header name: X-Twilio-Webhook-Enabled schema: enum: - 'true' - 'false' type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Attributes: description: A valid JSON string that contains application-specific data. type: string FriendlyName: description: A descriptive string that you create to describe the resource. It is often used for display purposes. type: string RoleSid: description: The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the User. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string title: UpdateUserRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created pathType: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: description: List of bindings for a given user get: description: '' operationId: ListUserBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User Binding resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resources to read. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. in: path name: UserSid required: true schema: type: string - description: 'The push technology used by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.' in: query name: BindingType schema: items: enum: - gcm - apn - fcm type: string type: array - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: bindings: items: $ref: '#/components/schemas/chat.v2.service.user.user_binding' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListUserBindingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type pathType: list /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: delete: description: '' operationId: DeleteUserBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the User Binding resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resources to delete. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. in: path name: UserSid required: true schema: type: string - description: The SID of the User Binding resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: List of bindings for a given user get: description: '' operationId: FetchUserBinding parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User Binding resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User Binding resource to fetch. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. in: path name: UserSid required: true schema: type: string - description: The SID of the User Binding resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_binding' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type pathType: instance /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: description: List of channels for a given user get: description: List all Channels for a given User. operationId: ListUserChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the User Channel resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to read the User Channel resources from. This value can be either the `sid` or the `identity` of the User resource. in: path name: UserSid required: true schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: channels: items: $ref: '#/components/schemas/chat.v2.service.user.user_channel' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListUserChannelResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - channel_sid - status pathType: list /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: delete: description: Removes User from selected Channel. operationId: DeleteUserChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/api/chat/rest/users) to read the User Channel resources from. in: path name: UserSid required: true schema: type: string - description: The SID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the resource belongs to. in: path name: ChannelSid required: true schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: List of channels for a given user get: description: '' operationId: FetchUserChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the User Channel resource from. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource. in: path name: UserSid required: true schema: type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel to fetch. This value can be either the `sid` or the `unique_name` of the Channel to fetch. in: path name: ChannelSid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateUserChannel parameters: - description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to update the User Channel resource in. in: path name: ServiceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string - description: The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to update the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource. in: path name: UserSid required: true schema: type: string - description: The SID of the [Channel](https://www.twilio.com/docs/chat/channels) with the User Channel resource to update. This value can be the Channel resource's `sid` or `unique_name`. in: path name: ChannelSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: LastConsumedMessageIndex: description: The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. nullable: true type: integer LastConsumptionTimestamp: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels). format: date-time type: string NotificationLevel: description: 'The push notification level to assign to the User Channel. Can be: `default` or `muted`.' enum: - default - muted type: string title: UpdateUserChannelRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service.user.user_channel' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - channel_sid - status pathType: instance /v2/Services/{Sid}: delete: description: '' operationId: DeleteService parameters: - description: The SID of the Service resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Top level scope for all chat resources get: description: '' operationId: FetchService parameters: - description: The SID of the Service resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateService parameters: - description: The SID of the Service resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ConsumptionReportInterval: description: DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints. type: integer DefaultChannelCreatorRoleSid: description: The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string DefaultChannelRoleSid: description: The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string DefaultServiceRoleSid: description: The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles. maxLength: 34 minLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ type: string FriendlyName: description: A descriptive string that you create to describe the resource. type: string Limits.ChannelMembers: description: The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000. type: integer Limits.UserChannels: description: The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000. type: integer Media.CompatibilityMessage: description: The message to send when a media message has no text. Can be used as placeholder message. type: string Notifications.AddedToChannel.Enabled: description: Whether to send a notification when a member is added to a channel. The default is `false`. type: boolean Notifications.AddedToChannel.Sound: description: The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`. type: string Notifications.AddedToChannel.Template: description: 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`. type: string Notifications.InvitedToChannel.Enabled: description: Whether to send a notification when a user is invited to a channel. The default is `false`. type: boolean Notifications.InvitedToChannel.Sound: description: The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`. type: string Notifications.InvitedToChannel.Template: description: 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`. type: string Notifications.LogEnabled: description: Whether to log notifications. The default is `false`. type: boolean Notifications.NewMessage.BadgeCountEnabled: description: Whether the new message badge is enabled. The default is `false`. type: boolean Notifications.NewMessage.Enabled: description: Whether to send a notification when a new message is added to a channel. The default is `false`. type: boolean Notifications.NewMessage.Sound: description: The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`. type: string Notifications.NewMessage.Template: description: 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`. type: string Notifications.RemovedFromChannel.Enabled: description: Whether to send a notification to a user when they are removed from a channel. The default is `false`. type: boolean Notifications.RemovedFromChannel.Sound: description: 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`. type: string Notifications.RemovedFromChannel.Template: description: 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`. type: string PostWebhookRetryCount: description: 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. type: integer PostWebhookUrl: description: The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details. format: uri type: string PreWebhookRetryCount: description: 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. type: integer PreWebhookUrl: description: The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details. format: uri type: string ReachabilityEnabled: description: Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`. type: boolean ReadStatusEnabled: description: Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`. type: boolean TypingIndicatorTimeout: description: 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. type: integer WebhookFilters: description: 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. items: type: string type: array WebhookMethod: description: '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.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string title: UpdateServiceRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/chat.v2.service' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://chat.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: instance servers: - url: https://chat.twilio.com x-maturity: - description: This product is Generally Available. name: GA