openapi: 3.0.1 info: title: Twilio - Accounts A2p Services API description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.52.0 servers: - url: https://accounts.twilio.com tags: - name: Services paths: /v1/Services: servers: - url: https://conversations.twilio.com description: A Service resource is a top-level conversation resource container that serves as a data silo. x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list dependentProperties: conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations bindings: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Bindings users: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users roles: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Roles configuration: mapping: chat_service_sid: sid resource_url: /v1None participant_conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations post: description: Create a new conversation service on your account tags: - Services responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' description: Created security: - accountSid_authToken: [] operationId: CreateService x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceRequest' get: description: Retrieve a list of all conversation services on your account tags: - Services parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceResponse' description: OK security: - accountSid_authToken: [] operationId: ListService x-maturity: - GA /v1/Services/{Sid}: servers: - url: https://conversations.twilio.com description: A Service resource is a top-level conversation resource container that serves as a data silo. x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance dependentProperties: conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations bindings: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Bindings users: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users roles: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Roles configuration: mapping: chat_service_sid: sid resource_url: /v1None participant_conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations delete: description: Remove a conversation service with all its nested resources from your account tags: - Services parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService x-maturity: - GA get: description: Fetch a conversation service from your account tags: - Services parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' description: OK security: - accountSid_authToken: [] operationId: FetchService x-maturity: - GA post: description: '' tags: - Services parameters: - name: Sid in: path description: The SID of the Service resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' description: OK security: - accountSid_authToken: [] operationId: UpdateService x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceRequest_3' /v1/Services/{ChatServiceSid}/Bindings/{Sid}: servers: - url: https://conversations.twilio.com description: A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints. x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: instance parent: /Services/{Sid} delete: description: Remove a push notification binding from the conversation service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Binding resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Binding resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceBinding x-maturity: - GA get: description: Fetch a push notification binding from the conversation service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_binding' description: OK security: - accountSid_authToken: [] operationId: FetchServiceBinding x-maturity: - GA /v1/Services/{ChatServiceSid}/Bindings: servers: - url: https://conversations.twilio.com description: A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints. x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: list parent: /Services/{Sid} get: description: Retrieve a list of all push notification bindings in the conversation service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: BindingType in: query 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.' schema: type: array items: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' - name: Identity in: query description: The identity of a [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) this binding belongs to. See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more details. schema: type: array items: type: string x-twilio: pii: handling: standard deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceBindingResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceBinding x-maturity: - GA /v1/Services/{ChatServiceSid}/Configuration: servers: - url: https://conversations.twilio.com description: A Service Configuration resource manages service-level settings applicable to the Conversation API. x-twilio: defaultOutputProperties: - chat_service_sid pathType: instance parent: /Services/{Sid} get: description: Fetch the configuration of a conversation service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the Service configuration resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConfiguration x-maturity: - GA post: description: Update configuration settings of a conversation service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the Service configuration resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConfiguration x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceConfigurationRequest' /v1/Services/{ChatServiceSid}/Conversations: servers: - url: https://conversations.twilio.com description: A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created pathType: list dependentProperties: participants: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants messages: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages webhooks: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks parent: /Services/{Sid} post: description: Create a new conversation in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversation x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceConversationRequest' get: description: Retrieve a list of conversations in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: StartDate in: query description: Start date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the start time of the date is used (YYYY-MM-DDT00:00:00Z). Can be combined with other filters. schema: type: string - name: EndDate in: query description: End date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the end time of the date is used (YYYY-MM-DDT23:59:59Z). Can be combined with other filters. schema: type: string - name: State in: query description: State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed` schema: type: string $ref: '#/components/schemas/service_conversation_enum_state' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceConversationResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceConversation x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created pathType: instance dependentProperties: participants: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants messages: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages webhooks: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks parent: /Services/{Sid} post: description: Update an existing conversation in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversation x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceConversationRequest' delete: description: Remove a conversation from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversation x-maturity: - GA get: description: Fetch a conversation from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversation x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com description: A Service Message resource represents a message in a conversation within a specific service. x-twilio: defaultOutputProperties: - sid - index - author - date_created pathType: list dependentProperties: delivery_receipts: mapping: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts channel_metadata: mapping: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid resource_url: /v1None parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Add a new message to the conversation in a specific service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationMessage x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceConversationMessageRequest' get: description: Retrieve a list of all messages in the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages. schema: type: string required: true - name: Order in: query description: 'The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.' schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_order_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceConversationMessageResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessage x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Message resource represents a message in a conversation within a specific service. x-twilio: defaultOutputProperties: - sid - index - author - date_created pathType: instance dependentProperties: delivery_receipts: mapping: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts channel_metadata: mapping: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid resource_url: /v1None parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Update an existing message in the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationMessage x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceConversationMessageRequest' delete: description: Remove a message from the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationMessage x-maturity: - GA get: description: Fetch a message from the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessage x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts get: description: Fetch the delivery and read receipts of the conversation message tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessageReceipt x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com description: A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created pathType: list parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts get: description: Retrieve a list of all delivery and read receipts of the conversation message tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceConversationMessageReceiptResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessageReceipt x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com description: A Service Participant resource represents a member of the conversation within a specific service. x-twilio: defaultOutputProperties: - sid - messaging_binding pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Add a new participant to the conversation in a specific service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationParticipant x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceConversationParticipantRequest' get: description: Retrieve a list of all participants of the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceConversationParticipantResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationParticipant x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Participant resource represents a member of the conversation within a specific service. x-twilio: defaultOutputProperties: - sid - messaging_binding pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Update an existing participant in the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationParticipant x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceConversationParticipantRequest' delete: description: Remove a participant from the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationParticipant x-maturity: - GA get: description: Fetch a participant of the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationParticipant x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com description: A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target pathType: list parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Create a new webhook scoped to the conversation in a specific service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationScopedWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceConversationScopedWebhookRequest' get: description: Retrieve a list of all webhooks scoped to the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceConversationScopedWebhookResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationScopedWebhook x-maturity: - GA /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com description: A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target pathType: instance parent: /Services/{ChatServiceSid}/Conversations/{Sid} post: description: Update an existing conversation-scoped webhook tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationScopedWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceConversationScopedWebhookRequest' delete: description: Remove an existing webhook scoped to the conversation tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationScopedWebhook x-maturity: - GA get: description: Fetch the configuration of a conversation-scoped webhook tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationScopedWebhook x-maturity: - GA /v1/Services/{ChatServiceSid}/Configuration/Notifications: servers: - url: https://conversations.twilio.com description: A Service Notification resource manages a set of settings to determine push notification behavior at service level. x-twilio: defaultOutputProperties: - chat_service_sid pathType: instance parent: /Services/{ChatServiceSid}/Configuration post: description: Update push notification service settings tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceNotification x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceNotificationRequest' get: description: Fetch push notification service settings tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' description: OK security: - accountSid_authToken: [] operationId: FetchServiceNotification x-maturity: - GA /v1/Services/{ChatServiceSid}/ParticipantConversations: servers: - url: https://conversations.twilio.com description: Service Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a specific conversation service. x-twilio: defaultOutputProperties: - chat_service_sid - participant_sid - conversation_sid pathType: list parent: /Services/{Sid} get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant Conversations resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Identity in: query description: A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. schema: type: string - name: Address in: query description: A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceParticipantConversationResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceParticipantConversation x-maturity: - GA /v1/Services/{ChatServiceSid}/Roles: servers: - url: https://conversations.twilio.com description: A Service Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list parent: /Services/{Sid} post: description: Create a new user role in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' description: Created security: - accountSid_authToken: [] operationId: CreateServiceRole x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceRoleRequest' get: description: Retrieve a list of all user roles in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceRoleResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceRole x-maturity: - GA /v1/Services/{ChatServiceSid}/Roles/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance parent: /Services/{Sid} post: description: Update an existing user role in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceRole x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceRoleRequest' delete: description: Remove a user role from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceRole x-maturity: - GA get: description: Fetch a user role from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' description: OK security: - accountSid_authToken: [] operationId: FetchServiceRole x-maturity: - GA /v1/Services/{ChatServiceSid}/Users: servers: - url: https://conversations.twilio.com description: A Service User resource represents a conversation user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - sid - identity pathType: list dependentProperties: user_conversations: mapping: chat_service_sid: chat_service_sid user_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations parent: /Services/{Sid} post: description: Add a new conversation user to your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' description: Created security: - accountSid_authToken: [] operationId: CreateServiceUser x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceUserRequest' get: description: Retrieve a list of all conversation users in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceUserResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceUser x-maturity: - GA /v1/Services/{ChatServiceSid}/Users/{Sid}: servers: - url: https://conversations.twilio.com description: A Service User resource represents a conversation user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - sid - identity pathType: instance dependentProperties: user_conversations: mapping: chat_service_sid: chat_service_sid user_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations parent: /Services/{Sid} post: description: Update an existing conversation user in your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUser x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceUserRequest' delete: description: Remove a conversation user from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceUser x-maturity: - GA get: description: Fetch a conversation user from your service tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' description: OK security: - accountSid_authToken: [] operationId: FetchServiceUser x-maturity: - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com description: A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created pathType: instance parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations post: description: Update a specific User Conversation. tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource. schema: type: string required: true - name: ConversationSid in: path description: The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUserConversation x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceUserConversationRequest' delete: description: Delete a specific User Conversation. tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource. schema: type: string required: true - name: ConversationSid in: path description: The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource). schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceUserConversation x-maturity: - GA get: description: Fetch a specific User Conversation. tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource. schema: type: string required: true - name: ConversationSid in: path description: The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' description: OK security: - accountSid_authToken: [] operationId: FetchServiceUserConversation x-maturity: - GA /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com description: A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created pathType: list parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations get: description: Retrieve a list of all User Conversations for the User. tags: - Services parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceUserConversationResponse' description: OK security: - accountSid_authToken: [] operationId: ListServiceUserConversation x-maturity: - GA /v1/Services/{ChatServiceSid}/Configuration/Webhooks: servers: - url: https://conversations.twilio.com description: A service webhook configuration resource manages a service-level set of callback URLs and their configuration for receiving all the corresponding service events. x-twilio: defaultOutputProperties: - chat_service_sid pathType: instance parent: /Services/{ChatServiceSid}/Configuration post: description: Update a specific Webhook. tags: - Services parameters: - name: ChatServiceSid in: path description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' description: OK security: - accountSid_authToken: [] operationId: UpdateServiceWebhookConfiguration x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceWebhookConfigurationRequest' get: description: Fetch a specific service webhook configuration. tags: - Services parameters: - name: ChatServiceSid in: path description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' description: OK security: - accountSid_authToken: [] operationId: FetchServiceWebhookConfiguration x-maturity: - GA /v2/Services: servers: - url: https://intelligence.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - language_code - date_created - version pathType: list post: description: Create a new Service for the given Account tags: - Services responses: '201': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' description: Created security: - accountSid_authToken: [] operationId: CreateService x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceRequest_2' get: description: Retrieves a list of all Services for an account. tags: - Services parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListServiceResponse_2' description: OK security: - accountSid_authToken: [] operationId: ListService x-maturity: - Beta /v2/Services/{Sid}: servers: - url: https://intelligence.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - language_code - date_created - version pathType: instance delete: description: Delete a specific Service. tags: - Services parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this Service. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService x-maturity: - Beta get: description: Fetch a specific Service. tags: - Services parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this Service. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' description: OK security: - accountSid_authToken: [] operationId: FetchService x-maturity: - Beta post: description: Update a specific Service. tags: - Services parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this Service. schema: type: string required: true - name: If-Match in: header description: The If-Match HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/intelligence.v2.service' description: OK security: - accountSid_authToken: [] operationId: UpdateService x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateServiceRequest' /v2/Services/{ServiceSid}/Bindings: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: list parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: BindingType in: query description: '' schema: type: array items: type: string $ref: '#/components/schemas/binding_enum_binding_type' - name: Identity in: query description: '' schema: type: array items: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListBindingResponse' description: OK security: - accountSid_authToken: [] operationId: ListBinding x-maturity: - GA /v2/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - endpoint - identity pathType: instance parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.binding' description: OK security: - accountSid_authToken: [] operationId: FetchBinding x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBinding x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: instance dependentProperties: members: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members messages: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages invites: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites webhooks: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' description: OK security: - accountSid_authToken: [] operationId: FetchChannel x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/channel_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteChannel x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/channel_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' description: OK security: - accountSid_authToken: [] operationId: UpdateChannel x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateChannelRequest' /v2/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: list dependentProperties: members: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Members messages: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Messages invites: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Invites webhooks: mapping: service_sid: service_sid channel_sid: sid resource_url: /v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/channel_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel' description: Created security: - accountSid_authToken: [] operationId: CreateChannel x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateChannelRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Type in: query description: '' schema: type: array items: type: string $ref: '#/components/schemas/channel_enum_channel_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListChannelResponse' description: OK security: - accountSid_authToken: [] operationId: ListChannel x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - configuration pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListChannelWebhookResponse' description: OK security: - accountSid_authToken: [] operationId: ListChannelWebhook x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' description: Created security: - accountSid_authToken: [] operationId: CreateChannelWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateChannelWebhookRequest' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - configuration pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' description: OK security: - accountSid_authToken: [] operationId: FetchChannelWebhook x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' description: OK security: - accountSid_authToken: [] operationId: UpdateChannelWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateChannelWebhookRequest' delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteChannelWebhook x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' description: OK security: - accountSid_authToken: [] operationId: FetchInvite x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteInvite x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' description: Created security: - accountSid_authToken: [] operationId: CreateInvite x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateInviteRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Identity in: query description: '' schema: type: array items: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListInviteResponse' description: OK security: - accountSid_authToken: [] operationId: ListInvite x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' description: OK security: - accountSid_authToken: [] operationId: FetchMember x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/member_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMember x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/member_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' description: OK security: - accountSid_authToken: [] operationId: UpdateMember x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateMemberRequest' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/member_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' description: Created security: - accountSid_authToken: [] operationId: CreateMember x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMemberRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Identity in: query description: '' schema: type: array items: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMemberResponse' description: OK security: - accountSid_authToken: [] operationId: ListMember x-maturity: - GA /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - from - to - date_created pathType: instance parent: /Services/{ServiceSid}/Channels/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' description: OK security: - accountSid_authToken: [] operationId: FetchMessage x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/message_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMessage x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/message_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' description: OK security: - accountSid_authToken: [] operationId: UpdateMessage x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateMessageRequest' /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - from - to - date_created pathType: list parent: /Services/{ServiceSid}/Channels/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/message_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' description: Created security: - accountSid_authToken: [] operationId: CreateMessage x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMessageRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: '' schema: type: string required: true - name: Order in: query description: '' schema: type: string $ref: '#/components/schemas/message_enum_order_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessageResponse' description: OK security: - accountSid_authToken: [] operationId: ListMessage x-maturity: - GA /v2/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' description: OK security: - accountSid_authToken: [] operationId: FetchRole x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteRole x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' description: OK security: - accountSid_authToken: [] operationId: UpdateRole x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateRoleRequest' /v2/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.role' description: Created security: - accountSid_authToken: [] operationId: CreateRole x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateRoleRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListRoleResponse' description: OK security: - accountSid_authToken: [] operationId: ListRole x-maturity: - GA /v2/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created pathType: instance dependentProperties: user_channels: mapping: service_sid: service_sid user_sid: sid resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels user_bindings: mapping: service_sid: service_sid user_sid: sid resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' description: OK security: - accountSid_authToken: [] operationId: FetchUser x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUser x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/user_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' description: OK security: - accountSid_authToken: [] operationId: UpdateUser x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserRequest' /v2/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - identity - date_created pathType: list dependentProperties: user_channels: mapping: service_sid: service_sid user_sid: sid resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Channels user_bindings: mapping: service_sid: service_sid user_sid: sid resource_url: /v2/Services/{service_sid}/Users/{user_sid}/Bindings parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: type: string $ref: '#/components/schemas/user_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user' description: Created security: - accountSid_authToken: [] operationId: CreateUser x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUserRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUserResponse' description: OK security: - accountSid_authToken: [] operationId: ListUser x-maturity: - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: BindingType in: query description: '' schema: type: array items: type: string $ref: '#/components/schemas/user_binding_enum_binding_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUserBindingResponse' description: OK security: - accountSid_authToken: [] operationId: ListUserBinding x-maturity: - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - endpoint - identity - binding_type pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_bindings get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' description: OK security: - accountSid_authToken: [] operationId: FetchUserBinding x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUserBinding x-maturity: - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - channel_sid - status pathType: list parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUserChannelResponse' description: OK security: - accountSid_authToken: [] operationId: ListUserChannel x-maturity: - GA /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: servers: - url: https://ip-messaging.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - channel_sid - status pathType: instance parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: ChannelSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' description: OK security: - accountSid_authToken: [] operationId: FetchUserChannel x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: ChannelSid in: path description: '' schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUserChannel x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path description: '' schema: type: string required: true - name: ChannelSid in: path description: '' schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' description: OK security: - accountSid_authToken: [] operationId: UpdateUserChannel x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateUserChannelRequest' /v1/Services/{ServiceSid}/AlphaSenders: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service. x-twilio: defaultOutputProperties: - sid - alpha_sender pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' description: Created security: - accountSid_authToken: [] operationId: CreateAlphaSender x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateAlphaSenderRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAlphaSenderResponse' description: OK security: - accountSid_authToken: [] operationId: ListAlphaSender x-maturity: - Beta /v1/Services/{ServiceSid}/AlphaSenders/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service. x-twilio: defaultOutputProperties: - sid - alpha_sender pathType: instance parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' description: OK security: - accountSid_authToken: [] operationId: FetchAlphaSender x-maturity: - Beta delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteAlphaSender x-maturity: - Beta /v1/Services/{MessagingServiceSid}/ChannelSenders: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service. x-twilio: defaultOutputProperties: - sid - sender - sender_type pathType: list parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListChannelSenderResponse' description: OK security: - accountSid_authToken: [] operationId: ListChannelSender x-maturity: - Beta /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service. x-twilio: defaultOutputProperties: - sid - sender - sender_type pathType: instance parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ChannelSender resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.channel_sender' description: OK security: - accountSid_authToken: [] operationId: FetchChannelSender x-maturity: - Beta /v1/Services/PreregisteredUsa2p: servers: - url: https://messaging.twilio.com description: Resource to associate preregistered campaign with Messaging Service. x-twilio: defaultOutputProperties: - campaign_id - messaging_service_sid pathType: list mountName: external_campaign post: description: '' tags: - Services responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.external_campaign' description: Created security: - accountSid_authToken: [] operationId: CreateExternalCampaign x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateExternalCampaignRequest' /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - phone_number - country_code pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreatePhoneNumberRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListPhoneNumberResponse' description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber x-maturity: - Beta /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - phone_number - country_code pathType: instance parent: /Services/{Sid} delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the PhoneNumber resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeletePhoneNumber x-maturity: - Beta get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the PhoneNumber resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber x-maturity: - Beta post: description: Update a specific Proxy Number. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the PhoneNumber resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.phone_number' description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdatePhoneNumberRequest' /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - short_code - country_code pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' description: Created security: - accountSid_authToken: [] operationId: CreateShortCode x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateShortCodeRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListShortCodeResponse' description: OK security: - accountSid_authToken: [] operationId: ListShortCode x-maturity: - Beta /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - short_code - country_code pathType: instance parent: /Services/{Sid} delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ShortCode resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteShortCode x-maturity: - Beta get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ShortCode resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' description: OK security: - accountSid_authToken: [] operationId: FetchShortCode x-maturity: - Beta post: description: Update a specific Short Code. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the ShortCode resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.short_code' description: OK security: - accountSid_authToken: [] operationId: UpdateShortCode x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateShortCodeRequest' /v1/Services/{MessagingServiceSid}/Compliance/Usa2p: servers: - url: https://messaging.twilio.com description: A service for (fetch/create/delete) A2P Campaign for a Messaging Service x-twilio: defaultOutputProperties: - brand_registration_sid - campaign_status - date_created pathType: list parent: /Services/{Sid} mountName: us_app_to_person post: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' description: Created security: - accountSid_authToken: [] operationId: CreateUsAppToPerson x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateUsAppToPersonRequest' get: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUsAppToPersonResponse' description: OK security: - accountSid_authToken: [] operationId: ListUsAppToPerson x-maturity: - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}: servers: - url: https://messaging.twilio.com description: A service for (fetch/create/delete) A2P Campaign for a Messaging Service x-twilio: defaultOutputProperties: - brand_registration_sid - campaign_status - date_created pathType: instance parent: /Services/{Sid} mountName: us_app_to_person delete: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the US A2P Compliance resource to delete `QE2c6890da8086d771620e9b13fadeba0b`. schema: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUsAppToPerson x-maturity: - Beta get: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the US A2P Compliance resource to fetch `QE2c6890da8086d771620e9b13fadeba0b`. schema: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPerson x-maturity: - Beta /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases: servers: - url: https://messaging.twilio.com description: Messaging Service Use Case resource. Fetch possible use cases for service. The Use Cases API returns an empty list if there is an issue with the customer's A2P brand registration. This Brand cannot register any campaign use cases. Customers are requested to contact support with their A2P brand information. x-twilio: defaultOutputProperties: - us_app_to_person_usecases pathType: list parent: /Services/{Sid} mountName: us_app_to_person_usecases get: description: '' tags: - Services parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: BrandRegistrationSid in: query description: The unique string to identify the A2P brand. schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person_usecase' description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPersonUsecase x-maturity: - Beta /v1/Services/Usecases: servers: - url: https://messaging.twilio.com description: Use Case resource. Fetch possible use cases for a Messaging Service. x-twilio: defaultOutputProperties: - usecases pathType: list get: description: '' tags: - Services responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.usecase' description: OK security: - accountSid_authToken: [] operationId: FetchUsecase x-maturity: - Beta /v1/Services/{ServiceSid}/Bindings/{Sid}: servers: - url: https://notify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - endpoint - binding_type - address pathType: instance parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Binding resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' description: OK security: - accountSid_authToken: [] operationId: FetchBinding x-maturity: - Beta delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Binding resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBinding x-maturity: - Beta /v1/Services/{ServiceSid}/Bindings: servers: - url: https://notify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - endpoint - binding_type - address pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/notify.v1.service.binding' description: Created security: - accountSid_authToken: [] operationId: CreateBinding x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBindingRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to read the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: StartDate in: query description: Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. schema: type: string format: date - name: EndDate in: query description: Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. schema: type: string format: date - name: Identity in: query description: The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. schema: type: array items: type: string x-twilio: pii: handling: standard deleteSla: 120 - name: Tag in: query description: 'Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.' schema: type: array items: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListBindingResponse_2' description: OK security: - accountSid_authToken: [] operationId: ListBinding x-maturity: - Beta /v1/Services/{ServiceSid}/Notifications: servers: - url: https://notify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - priority - title pathType: list parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/notify.v1.service.notification' description: Created security: - accountSid_authToken: [] operationId: CreateNotification x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateNotificationRequest' x-twilio: conditional: - - identity - tag /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - type - data pathType: instance parent: /Services/{ServiceSid}/Sessions/{Sid} get: description: Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session). tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Interaction resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.interaction' description: OK security: - accountSid_authToken: [] operationId: FetchInteraction x-maturity: - Beta delete: description: Delete a specific Interaction. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Interaction resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteInteraction x-maturity: - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - type - data pathType: list parent: /Services/{ServiceSid}/Sessions/{Sid} get: description: Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListInteractionResponse' description: OK security: - accountSid_authToken: [] operationId: ListInteraction x-maturity: - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - type - data pathType: list parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} post: description: Create a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The `inbound` properties for the Interaction will always be empty. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: ParticipantSid in: path description: The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' description: Created security: - accountSid_authToken: [] operationId: CreateMessageInteraction x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMessageInteractionRequest' x-twilio: conditional: - - body - media_url get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: ParticipantSid in: path description: The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessageInteractionResponse' description: OK security: - accountSid_authToken: [] operationId: ListMessageInteraction x-maturity: - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - type - data pathType: instance parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: ParticipantSid in: path description: The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the MessageInteraction resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' description: OK security: - accountSid_authToken: [] operationId: FetchMessageInteraction x-maturity: - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier pathType: instance dependentProperties: message_interactions: mapping: service_sid: service_sid session_sid: session_sid participant_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions parent: /Services/{ServiceSid}/Sessions/{Sid} get: description: Fetch a specific Participant. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Participant resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' description: OK security: - accountSid_authToken: [] operationId: FetchParticipant x-maturity: - Beta delete: description: Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanently deleted when the [Session](https://www.twilio.com/docs/proxy/api/session) is deleted. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Participant resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteParticipant x-maturity: - Beta /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier pathType: list dependentProperties: message_interactions: mapping: service_sid: service_sid session_sid: session_sid participant_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants/{participant_sid}/MessageInteractions parent: /Services/{ServiceSid}/Sessions/{Sid} get: description: Retrieve a list of all Participants in a Session. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) of the resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListParticipantResponse' description: OK security: - accountSid_authToken: [] operationId: ListParticipant x-maturity: - Beta post: description: Add a new Participant to the Session tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: SessionSid in: path description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant' description: Created security: - accountSid_authToken: [] operationId: CreateParticipant x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateParticipantRequest' /v1/Services/{ServiceSid}/Sessions/{Sid}: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended pathType: instance dependentProperties: interactions: mapping: service_sid: service_sid session_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Interactions participants: mapping: service_sid: service_sid session_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants parent: /Services/{Sid} get: description: Fetch a specific Session. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Session resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' description: OK security: - accountSid_authToken: [] operationId: FetchSession x-maturity: - Beta delete: description: Delete a specific Session. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Session resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSession x-maturity: - Beta post: description: Update a specific Session. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Session resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' description: OK security: - accountSid_authToken: [] operationId: UpdateSession x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSessionRequest' /v1/Services/{ServiceSid}/Sessions: servers: - url: https://proxy.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended pathType: list dependentProperties: interactions: mapping: service_sid: service_sid session_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Interactions participants: mapping: service_sid: service_sid session_sid: sid resource_url: /v1/Services/{service_sid}/Sessions/{session_sid}/Participants parent: /Services/{Sid} get: description: Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the resource to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSessionResponse' description: OK security: - accountSid_authToken: [] operationId: ListSession x-maturity: - Beta post: description: Create a new Session tags: - Services parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session' description: Created security: - accountSid_authToken: [] operationId: CreateSession x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSessionRequest' /v1/Services/{ServiceSid}/Assets: servers: - url: https://serverless.twilio.com description: A wrapper that represents a static file and groups the different Versions of the static file. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: list dependentProperties: asset_versions: mapping: service_sid: service_sid asset_sid: sid resource_url: /v1/Services/{service_sid}/Assets/{asset_sid}/Versions parent: /Services/{Sid} get: description: Retrieve a list of all Assets. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Asset resources from. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAssetResponse' description: OK security: - accountSid_authToken: [] operationId: ListAsset x-maturity: - Beta post: description: Create a new Asset resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Asset resource under. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' description: Created security: - accountSid_authToken: [] operationId: CreateAsset x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateAssetRequest' /v1/Services/{ServiceSid}/Assets/{Sid}: servers: - url: https://serverless.twilio.com description: A wrapper that represents a static file and groups the different Versions of the static file. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: instance dependentProperties: asset_versions: mapping: service_sid: service_sid asset_sid: sid resource_url: /v1/Services/{service_sid}/Assets/{asset_sid}/Versions parent: /Services/{Sid} get: description: Retrieve a specific Asset resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Asset resource from. schema: type: string required: true - name: Sid in: path description: The SID that identifies the Asset resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' description: OK security: - accountSid_authToken: [] operationId: FetchAsset x-maturity: - Beta delete: description: Delete an Asset resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to delete the Asset resource from. schema: type: string required: true - name: Sid in: path description: The SID that identifies the Asset resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteAsset x-maturity: - Beta post: description: Update a specific Asset resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to update the Asset resource from. schema: type: string required: true - name: Sid in: path description: The SID that identifies the Asset resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset' description: OK security: - accountSid_authToken: [] operationId: UpdateAsset x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateAssetRequest' /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions: servers: - url: https://serverless.twilio.com description: The content of an Asset. x-twilio: defaultOutputProperties: - sid - path - visibility - date_created pathType: list parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions get: description: Retrieve a list of all Asset Versions. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Asset Version resource from. schema: type: string required: true - name: AssetSid in: path description: The SID of the Asset resource that is the parent of the Asset Version resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAssetVersionResponse' description: OK security: - accountSid_authToken: [] operationId: ListAssetVersion x-maturity: - Beta /v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com description: The content of an Asset. x-twilio: defaultOutputProperties: - sid - path - visibility - date_created pathType: instance parent: /Services/{ServiceSid}/Assets/{Sid} mountName: asset_versions get: description: Retrieve a specific Asset Version. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Asset Version resource from. schema: type: string required: true - name: AssetSid in: path description: The SID of the Asset resource that is the parent of the Asset Version resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Asset Version resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' description: OK security: - accountSid_authToken: [] operationId: FetchAssetVersion x-maturity: - Beta /v1/Services/{ServiceSid}/Builds: servers: - url: https://serverless.twilio.com description: A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit. x-twilio: defaultOutputProperties: - sid - status - date_created pathType: list dependentProperties: build_status: mapping: service_sid: service_sid sid: sid resource_url: /v1None parent: /Services/{Sid} get: description: Retrieve a list of all Builds. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Build resources from. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListBuildResponse' description: OK security: - accountSid_authToken: [] operationId: ListBuild x-maturity: - Beta post: description: Create a new Build resource. At least one function version or asset version is required. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Build resource under. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' description: Created security: - accountSid_authToken: [] operationId: CreateBuild x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBuildRequest' /v1/Services/{ServiceSid}/Builds/{Sid}: servers: - url: https://serverless.twilio.com description: A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit. x-twilio: defaultOutputProperties: - sid - status - date_created pathType: instance dependentProperties: build_status: mapping: service_sid: service_sid sid: sid resource_url: /v1None parent: /Services/{Sid} get: description: Retrieve a specific Build resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Build resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Build resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build' description: OK security: - accountSid_authToken: [] operationId: FetchBuild x-maturity: - Beta delete: description: Delete a Build resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to delete the Build resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Build resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBuild x-maturity: - Beta /v1/Services/{ServiceSid}/Builds/{Sid}/Status: servers: - url: https://serverless.twilio.com description: The status of a Build resource. x-twilio: defaultOutputProperties: - sid - status pathType: instance parent: /Services/{ServiceSid}/Builds/{Sid} mountName: build_status get: description: Retrieve a specific Build resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Build resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Build resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.build.build_status' description: OK security: - accountSid_authToken: [] operationId: FetchBuildStatus x-maturity: - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments: servers: - url: https://serverless.twilio.com description: An association of a Build with an Environment so that the Build is published in the Environment. x-twilio: defaultOutputProperties: - sid - build_sid - date_created pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a list of all Deployments. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Deployment resources from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment used by the Deployment resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDeploymentResponse' description: OK security: - accountSid_authToken: [] operationId: ListDeployment x-maturity: - Beta post: description: Create a new Deployment. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Deployment resource under. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment for the Deployment. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' description: Created security: - accountSid_authToken: [] operationId: CreateDeployment x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateDeploymentRequest' /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}: servers: - url: https://serverless.twilio.com description: An association of a Build with an Environment so that the Build is published in the Environment. x-twilio: defaultOutputProperties: - sid - build_sid - date_created pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a specific Deployment. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Deployment resource from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment used by the Deployment to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID that identifies the Deployment resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' description: OK security: - accountSid_authToken: [] operationId: FetchDeployment x-maturity: - Beta /v1/Services/{ServiceSid}/Environments: servers: - url: https://serverless.twilio.com description: Represents a deployed build of a given set of Functions and/or Assets at a specific URL. x-twilio: defaultOutputProperties: - sid - unique_name - domain_name - build_sid pathType: list dependentProperties: variables: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Variables deployments: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Deployments logs: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Logs parent: /Services/{Sid} get: description: Retrieve a list of all environments. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Environment resources from. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEnvironmentResponse' description: OK security: - accountSid_authToken: [] operationId: ListEnvironment x-maturity: - Beta post: description: Create a new environment. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Environment resource under. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' description: Created security: - accountSid_authToken: [] operationId: CreateEnvironment x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEnvironmentRequest' /v1/Services/{ServiceSid}/Environments/{Sid}: servers: - url: https://serverless.twilio.com description: Represents a deployed build of a given set of Functions and/or Assets at a specific URL. x-twilio: defaultOutputProperties: - sid - unique_name - domain_name - build_sid pathType: instance dependentProperties: variables: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Variables deployments: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Deployments logs: mapping: service_sid: service_sid environment_sid: sid resource_url: /v1/Services/{service_sid}/Environments/{environment_sid}/Logs parent: /Services/{Sid} get: description: Retrieve a specific environment. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Environment resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Environment resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment' description: OK security: - accountSid_authToken: [] operationId: FetchEnvironment x-maturity: - Beta delete: description: Delete a specific environment. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to delete the Environment resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Environment resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEnvironment x-maturity: - Beta /v1/Services/{ServiceSid}/Functions: servers: - url: https://serverless.twilio.com description: A wrapper that represents a Serverless JavaScript function and groups the different and groups the different Versions of this code. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: list dependentProperties: function_versions: mapping: service_sid: service_sid function_sid: sid resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions parent: /Services/{Sid} get: description: Retrieve a list of all Functions. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Function resources from. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFunctionResponse' description: OK security: - accountSid_authToken: [] operationId: ListFunction x-maturity: - Beta post: description: Create a new Function resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Function resource under. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' description: Created security: - accountSid_authToken: [] operationId: CreateFunction x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateFunctionRequest' /v1/Services/{ServiceSid}/Functions/{Sid}: servers: - url: https://serverless.twilio.com description: A wrapper that represents a Serverless JavaScript function and groups the different and groups the different Versions of this code. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: instance dependentProperties: function_versions: mapping: service_sid: service_sid function_sid: sid resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions parent: /Services/{Sid} get: description: Retrieve a specific Function resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Function resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Function resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' description: OK security: - accountSid_authToken: [] operationId: FetchFunction x-maturity: - Beta delete: description: Delete a Function resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to delete the Function resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Function resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFunction x-maturity: - Beta post: description: Update a specific Function resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to update the Function resource from. schema: type: string required: true - name: Sid in: path description: The SID of the Function resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function' description: OK security: - accountSid_authToken: [] operationId: UpdateFunction x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateFunctionRequest' /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions: servers: - url: https://serverless.twilio.com description: The content of a Function. x-twilio: defaultOutputProperties: - sid - path - visibility - date_created pathType: list dependentProperties: function_version_content: mapping: service_sid: service_sid function_sid: function_sid sid: sid resource_url: /v1None parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions get: description: Retrieve a list of all Function Version resources. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Function Version resources from. schema: type: string required: true - name: FunctionSid in: path description: The SID of the function that is the parent of the Function Version resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFunctionVersionResponse' description: OK security: - accountSid_authToken: [] operationId: ListFunctionVersion x-maturity: - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}: servers: - url: https://serverless.twilio.com description: The content of a Function. x-twilio: defaultOutputProperties: - sid - path - visibility - date_created pathType: instance dependentProperties: function_version_content: mapping: service_sid: service_sid function_sid: function_sid sid: sid resource_url: /v1None parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions get: description: Retrieve a specific Function Version resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Function Version resource from. schema: type: string required: true - name: FunctionSid in: path description: The SID of the function that is the parent of the Function Version resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Function Version resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version' description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersion x-maturity: - Beta /v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content: servers: - url: https://serverless.twilio.com description: The code of a Function Version. x-twilio: defaultOutputProperties: - sid - content pathType: instance parent: /Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid} mountName: function_version_content get: description: Retrieve a the content of a specific Function Version resource. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Function Version content from. schema: type: string required: true - name: FunctionSid in: path description: The SID of the Function that is the parent of the Function Version content to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Function Version content to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.function.function_version.function_version_content' description: OK security: - accountSid_authToken: [] operationId: FetchFunctionVersionContent x-maturity: - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a list of all logs. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Log resource from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the environment with the Log resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: FunctionSid in: query description: The SID of the function whose invocation produced the Log resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ - name: StartDate in: query description: The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time. schema: type: string format: date-time - name: EndDate in: query description: The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time. schema: type: string format: date-time - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListLogResponse' description: OK security: - accountSid_authToken: [] operationId: ListLog x-maturity: - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}: servers: - url: https://serverless.twilio.com description: A record of an event that occurred related to a function invocation. x-twilio: defaultOutputProperties: [] pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a specific log. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Log resource from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the environment with the Log resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Log resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.log' description: OK security: - accountSid_authToken: [] operationId: FetchLog x-maturity: - Beta /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables: servers: - url: https://serverless.twilio.com description: A key and value pair that is specific to an Environment. x-twilio: defaultOutputProperties: - sid - key - date_created pathType: list parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a list of all Variables. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to read the Variable resources from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment with the Variable resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListVariableResponse' description: OK security: - accountSid_authToken: [] operationId: ListVariable x-maturity: - Beta post: description: Create a new Variable. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to create the Variable resource under. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment in which the Variable resource exists. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' description: Created security: - accountSid_authToken: [] operationId: CreateVariable x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateVariableRequest' /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}: servers: - url: https://serverless.twilio.com description: A key and value pair that is specific to an Environment. x-twilio: defaultOutputProperties: - sid - key - date_created pathType: instance parent: /Services/{ServiceSid}/Environments/{Sid} get: description: Retrieve a specific Variable. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to fetch the Variable resource from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment with the Variable resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Variable resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZV[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' description: OK security: - accountSid_authToken: [] operationId: FetchVariable x-maturity: - Beta post: description: Update a specific Variable. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to update the Variable resource under. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment with the Variable resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Variable resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZV[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/serverless.v1.service.environment.variable' description: OK security: - accountSid_authToken: [] operationId: UpdateVariable x-maturity: - Beta requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateVariableRequest' delete: description: Delete a specific Variable. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the Service to delete the Variable resource from. schema: type: string required: true - name: EnvironmentSid in: path description: The SID of the Environment with the Variables to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Variable resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^ZV[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteVariable x-maturity: - Beta /v1/Services/{ServiceSid}/Documents/{Sid}: servers: - url: https://sync.twilio.com description: Sync Document objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: instance dependentProperties: document_permissions: mapping: service_sid: service_sid document_sid: sid resource_url: /v1/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to fetch. schema: type: string required: true - name: Sid in: path description: The SID of the Document resource to fetch. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' description: OK security: - accountSid_authToken: [] operationId: FetchDocument x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to delete. schema: type: string required: true - name: Sid in: path description: The SID of the Document resource to delete. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteDocument x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resource to update. schema: type: string required: true - name: Sid in: path description: The SID of the Document resource to update. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true - name: If-Match in: header description: The If-Match HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' description: OK security: - accountSid_authToken: [] operationId: UpdateDocument x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDocumentRequest' /v1/Services/{ServiceSid}/Documents: servers: - url: https://sync.twilio.com description: Sync Document objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: list dependentProperties: document_permissions: mapping: service_sid: service_sid document_sid: sid resource_url: /v1/Services/{service_sid}/Documents/{document_sid}/Permissions parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Document resource in. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document' description: Created security: - accountSid_authToken: [] operationId: CreateDocument x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateDocumentRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document resources to read. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDocumentResponse' description: OK security: - accountSid_authToken: [] operationId: ListDocument x-maturity: - GA /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com description: Sync document permissions x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: instance parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions get: description: Fetch a specific Sync Document Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to fetch. schema: type: string required: true - name: DocumentSid in: path description: The SID of the Sync Document with the Document Permission resource to fetch. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Document Permission resource to fetch. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' description: OK security: - accountSid_authToken: [] operationId: FetchDocumentPermission x-maturity: - GA delete: description: Delete a specific Sync Document Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to delete. schema: type: string required: true - name: DocumentSid in: path description: The SID of the Sync Document with the Document Permission resource to delete. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Document Permission resource to delete. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteDocumentPermission x-maturity: - GA post: description: Update an identity's access to a specific Sync Document. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resource to update. schema: type: string required: true - name: DocumentSid in: path description: The SID of the Sync Document with the Document Permission resource to update. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Document Permission resource to update. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.document.document_permission' description: OK security: - accountSid_authToken: [] operationId: UpdateDocumentPermission x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDocumentPermissionRequest' /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://sync.twilio.com description: Sync document permissions x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: list parent: /Services/{ServiceSid}/Documents/{Sid} mountName: document_permissions get: description: Retrieve a list of all Permissions applying to a Sync Document. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Document Permission resources to read. schema: type: string required: true - name: DocumentSid in: path description: The SID of the Sync Document with the Document Permission resources to read. Can be the Document resource's `sid` or its `unique_name`. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListDocumentPermissionResponse' description: OK security: - accountSid_authToken: [] operationId: ListDocumentPermission x-maturity: - GA /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages: servers: - url: https://sync.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid pathType: list parent: /Services/{ServiceSid}/Streams/{Sid} mountName: stream_messages post: description: Create a new Stream Message. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Stream Message in. schema: type: string required: true - name: StreamSid in: path description: The SID of the Sync Stream to create the new Stream Message resource for. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream.stream_message' description: Created security: - accountSid_authToken: [] operationId: CreateStreamMessage x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateStreamMessageRequest' /v1/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://sync.twilio.com description: Sync list objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: instance dependentProperties: sync_list_items: mapping: service_sid: service_sid list_sid: sid resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Items sync_list_permissions: mapping: service_sid: service_sid list_sid: sid resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} mountName: sync_lists get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to fetch. schema: type: string required: true - name: Sid in: path description: The SID of the Sync List resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' description: OK security: - accountSid_authToken: [] operationId: FetchSyncList x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to delete. schema: type: string required: true - name: Sid in: path description: The SID of the Sync List resource to delete. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncList x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resource to update. schema: type: string required: true - name: Sid in: path description: The SID of the Sync List resource to update. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncList x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncListRequest' /v1/Services/{ServiceSid}/Lists: servers: - url: https://sync.twilio.com description: Sync list objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: list dependentProperties: sync_list_items: mapping: service_sid: service_sid list_sid: sid resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Items sync_list_permissions: mapping: service_sid: service_sid list_sid: sid resource_url: /v1/Services/{service_sid}/Lists/{list_sid}/Permissions parent: /Services/{Sid} mountName: sync_lists post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Sync List in. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list' description: Created security: - accountSid_authToken: [] operationId: CreateSyncList x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSyncListRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List resources to read. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncListResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncList x-maturity: - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://sync.twilio.com description: Items in a sync list x-twilio: defaultOutputProperties: - index - revision - created_by pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to fetch. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Item resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Index in: path description: The index of the Sync List Item resource to fetch. schema: type: integer required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' description: OK security: - accountSid_authToken: [] operationId: FetchSyncListItem x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to delete. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Item resource to delete. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Index in: path description: The index of the Sync List Item resource to delete. schema: type: integer required: true - name: If-Match in: header description: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match). schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncListItem x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item resource to update. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Item resource to update. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Index in: path description: The index of the Sync List Item resource to update. schema: type: integer required: true - name: If-Match in: header description: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match). schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListItem x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncListItemRequest' /v1/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://sync.twilio.com description: Items in a sync list x-twilio: defaultOutputProperties: - index - revision - created_by pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_items post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new List Item in. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List to add the new List Item to. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' description: Created security: - accountSid_authToken: [] operationId: CreateSyncListItem x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSyncListItemRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the List Item resources to read. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the List Items to read. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Order in: query description: 'How to order the List Items returned by their `index` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending.' schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_result_order' - name: From in: query description: The `index` of the first Sync List Item resource to read. See also `bounds`. schema: type: string - name: Bounds in: query description: 'Whether to include the List Item referenced by the `from` parameter. Can be: `inclusive` to include the List Item referenced by the `from` parameter or `exclusive` to start with the next List Item. The default value is `inclusive`.' schema: type: string $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncListItemResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncListItem x-maturity: - GA /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com description: Permissions for Sync list items x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: instance parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions get: description: Fetch a specific Sync List Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to fetch. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Permission resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync List Permission resource to fetch. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' description: OK security: - accountSid_authToken: [] operationId: FetchSyncListPermission x-maturity: - GA delete: description: Delete a specific Sync List Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to delete. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Permission resource to delete. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync List Permission resource to delete. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncListPermission x-maturity: - GA post: description: Update an identity's access to a specific Sync List. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to update. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Permission resource to update. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync List Permission resource to update. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncListPermission x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncListPermissionRequest' /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://sync.twilio.com description: Permissions for Sync list items x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: list parent: /Services/{ServiceSid}/Lists/{Sid} mountName: sync_list_permissions get: description: Retrieve a list of all Permissions applying to a Sync List. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Permission resources to read. schema: type: string required: true - name: ListSid in: path description: The SID of the Sync List with the Sync List Permission resources to read. Can be the Sync List resource's `sid` or its `unique_name`. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncListPermissionResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncListPermission x-maturity: - GA /v1/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://sync.twilio.com description: Sync map objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: instance dependentProperties: sync_map_items: mapping: service_sid: service_sid map_sid: sid resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Items sync_map_permissions: mapping: service_sid: service_sid map_sid: sid resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Permissions parent: /Services/{Sid} mountName: sync_maps get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to fetch. schema: type: string required: true - name: Sid in: path description: The SID of the Sync Map resource to fetch. Can be the Sync Map's `sid` or its `unique_name`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' description: OK security: - accountSid_authToken: [] operationId: FetchSyncMap x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to delete. schema: type: string required: true - name: Sid in: path description: The SID of the Sync Map resource to delete. Can be the Sync Map's `sid` or its `unique_name`. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncMap x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resource to update. schema: type: string required: true - name: Sid in: path description: The SID of the Sync Map resource to update. Can be the Sync Map's `sid` or its `unique_name`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMap x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncMapRequest' /v1/Services/{ServiceSid}/Maps: servers: - url: https://sync.twilio.com description: Sync map objects x-twilio: defaultOutputProperties: - sid - unique_name - revision pathType: list dependentProperties: sync_map_items: mapping: service_sid: service_sid map_sid: sid resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Items sync_map_permissions: mapping: service_sid: service_sid map_sid: sid resource_url: /v1/Services/{service_sid}/Maps/{map_sid}/Permissions parent: /Services/{Sid} mountName: sync_maps post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the Sync Map in. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map' description: Created security: - accountSid_authToken: [] operationId: CreateSyncMap x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSyncMapRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map resources to read. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncMapResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncMap x-maturity: - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://sync.twilio.com description: Keys in a sync map x-twilio: defaultOutputProperties: - key - revision - created_by pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to fetch. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Key in: path description: The `key` value of the Sync Map Item resource to fetch. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapItem x-maturity: - GA delete: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to delete. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Item resource to delete. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Key in: path description: The `key` value of the Sync Map Item resource to delete. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: If-Match in: header description: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match). schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncMapItem x-maturity: - GA post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item resource to update. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Item resource to update. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Key in: path description: 'The `key` value of the Sync Map Item resource to update. ' schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: If-Match in: header description: If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match). schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapItem x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncMapItemRequest' /v1/Services/{ServiceSid}/Maps/{MapSid}/Items: servers: - url: https://sync.twilio.com description: Keys in a sync map x-twilio: defaultOutputProperties: - key - revision - created_by pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_items post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the Map Item in. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map to add the new Map Item to. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' description: Created security: - accountSid_authToken: [] operationId: CreateSyncMapItem x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSyncMapItemRequest' get: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Map Item resources to read. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Order in: query description: 'How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.' schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_result_order' - name: From in: query description: The `key` of the first Sync Map Item resource to read. See also `bounds`. schema: type: string - name: Bounds in: query description: 'Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.' schema: type: string $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncMapItemResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncMapItem x-maturity: - GA /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://sync.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: instance parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions get: description: Fetch a specific Sync Map Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to fetch. Can be the Service's `sid` value or `default`. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Permission resource to fetch. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync Map Permission resource to fetch. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' description: OK security: - accountSid_authToken: [] operationId: FetchSyncMapPermission x-maturity: - GA delete: description: Delete a specific Sync Map Permission. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to delete. Can be the Service's `sid` value or `default`. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Permission resource to delete. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync Map Permission resource to delete. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncMapPermission x-maturity: - GA post: description: Update an identity's access to a specific Sync Map. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resource to update. Can be the Service's `sid` value or `default`. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Sync Map Permission resource to update. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: Identity in: path description: The application-defined string that uniquely identifies the User's Sync Map Permission resource to update. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncMapPermission x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncMapPermissionRequest' /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://sync.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - identity - read - write - manage pathType: list parent: /Services/{ServiceSid}/Maps/{Sid} mountName: sync_map_permissions get: description: Retrieve a list of all Permissions applying to a Sync Map. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Permission resources to read. Can be the Service's `sid` value or `default`. schema: type: string required: true - name: MapSid in: path description: The SID of the Sync Map with the Permission resources to read. Can be the Sync Map resource's `sid` or its `unique_name`. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncMapPermissionResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncMapPermission x-maturity: - GA /v1/Services/{ServiceSid}/Streams/{Sid}: servers: - url: https://sync.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - created_by pathType: instance dependentProperties: stream_messages: mapping: service_sid: service_sid stream_sid: sid resource_url: /v1/Services/{service_sid}/Streams/{stream_sid}/Messages parent: /Services/{Sid} mountName: sync_streams get: description: Fetch a specific Stream. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to fetch. schema: type: string required: true - name: Sid in: path description: The SID of the Stream resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' description: OK security: - accountSid_authToken: [] operationId: FetchSyncStream x-maturity: - GA delete: description: Delete a specific Stream. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to delete. schema: type: string required: true - name: Sid in: path description: The SID of the Stream resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSyncStream x-maturity: - GA post: description: Update a specific Stream. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to update. schema: type: string required: true - name: Sid in: path description: The SID of the Stream resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' description: OK security: - accountSid_authToken: [] operationId: UpdateSyncStream x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSyncStreamRequest' /v1/Services/{ServiceSid}/Streams: servers: - url: https://sync.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - created_by pathType: list dependentProperties: stream_messages: mapping: service_sid: service_sid stream_sid: sid resource_url: /v1/Services/{service_sid}/Streams/{stream_sid}/Messages parent: /Services/{Sid} mountName: sync_streams post: description: Create a new Stream. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Stream in. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/sync.v1.service.sync_stream' description: Created security: - accountSid_authToken: [] operationId: CreateSyncStream x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateSyncStreamRequest' get: description: Retrieve a list of all Streams in a Service Instance. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Stream resources to read. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSyncStreamResponse' description: OK security: - accountSid_authToken: [] operationId: ListSyncStream x-maturity: - GA /Services: get: operationId: listServices summary: Twilio List Verify Services description: Retrieve a list of all Verify services in your account. tags: - Services parameters: - name: PageSize in: query schema: type: integer minimum: 1 maximum: 100 responses: '200': description: List of services content: application/json: schema: $ref: '#/components/schemas/ServiceList' '401': description: Unauthorized post: operationId: createService summary: Twilio Create a Verify Service description: Create a new Verify service to configure verification behavior including code length, channels, and branding. tags: - Services requestBody: required: true content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceRequest_9' responses: '201': description: Service created content: application/json: schema: $ref: '#/components/schemas/VerifyService' '400': description: Invalid request /Services/{ServiceSid}: get: operationId: fetchService summary: Twilio Fetch a Verify Service tags: - Services parameters: - $ref: '#/components/parameters/ServiceSid' responses: '200': description: Service details content: application/json: schema: $ref: '#/components/schemas/VerifyService' '404': description: Service not found post: operationId: updateService summary: Twilio Update a Verify Service tags: - Services parameters: - $ref: '#/components/parameters/ServiceSid' requestBody: required: true content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateServiceRequest_9' responses: '200': description: Service updated content: application/json: schema: $ref: '#/components/schemas/VerifyService' delete: operationId: deleteService summary: Twilio Delete a Verify Service tags: - Services parameters: - $ref: '#/components/parameters/ServiceSid' responses: '204': description: Service deleted /v2/Services/{ServiceSid}/AccessTokens: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - account_sid - service_sid - entity_identity - factor_type - factor_friendly_name - token - ttl - date_created pathType: list parent: /Services/{Sid} post: description: Create a new enrollment Access Token for the Entity tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' description: Created security: - accountSid_authToken: [] operationId: CreateAccessToken x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateAccessTokenRequest' /v2/Services/{ServiceSid}/AccessTokens/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - account_sid - service_sid - entity_identity - factor_type - factor_friendly_name - token - ttl - date_created pathType: instance parent: /Services/{Sid} get: description: Fetch an Access Token for the Entity tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Access Token. schema: type: string minLength: 34 maxLength: 34 pattern: ^YK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' description: OK security: - accountSid_authToken: [] operationId: FetchAccessToken x-maturity: - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - rate_limit_sid - account_sid - max - interval - date_created - date_updated pathType: list parent: /Services/{ServiceSid}/RateLimits/{Sid} post: description: Create a new Bucket for a Rate Limit tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' description: Created security: - accountSid_authToken: [] operationId: CreateBucket x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateBucketRequest' get: description: Retrieve a list of all Buckets for a Rate Limit. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListBucketResponse' description: OK security: - accountSid_authToken: [] operationId: ListBucket x-maturity: - GA /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - rate_limit_sid - account_sid - max - interval - date_created - date_updated pathType: instance parent: /Services/{ServiceSid}/RateLimits/{Sid} post: description: Update a specific Bucket. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' description: OK security: - accountSid_authToken: [] operationId: UpdateBucket x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateBucketRequest' get: description: Fetch a specific Bucket. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' description: OK security: - accountSid_authToken: [] operationId: FetchBucket x-maturity: - GA delete: description: Delete a specific Bucket. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBucket x-maturity: - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created pathType: list dependentProperties: notifications: mapping: service_sid: service_sid identity: identity challenge_sid: sid resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} post: description: Create a new Challenge for the Factor tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' description: Created security: - accountSid_authToken: [] operationId: CreateChallenge x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateChallengeRequest' get: description: Retrieve a list of all Challenges for a Factor. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: FactorSid in: query description: The unique SID identifier of the Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ - name: Status in: query description: The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`. schema: type: string $ref: '#/components/schemas/challenge_enum_challenge_statuses' - name: Order in: query description: The desired sort order of the Challenges list. One of `asc` or `desc` for ascending and descending respectively. Defaults to `asc`. schema: type: string $ref: '#/components/schemas/challenge_enum_list_orders' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListChallengeResponse' description: OK security: - accountSid_authToken: [] operationId: ListChallenge x-maturity: - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created pathType: instance dependentProperties: notifications: mapping: service_sid: service_sid identity: identity challenge_sid: sid resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} get: description: Fetch a specific Challenge. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenges. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' description: OK security: - accountSid_authToken: [] operationId: FetchChallenge x-maturity: - GA post: description: Verify a specific Challenge. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' description: OK security: - accountSid_authToken: [] operationId: UpdateChallenge x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateChallengeRequest' /v2/Services/{ServiceSid}/Entities: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: list dependentProperties: factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors new_factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors challenges: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} post: description: Create a new Entity for the Service tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' description: Created security: - accountSid_authToken: [] operationId: CreateEntity x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateEntityRequest' get: description: Retrieve a list of all Entities for a Service. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEntityResponse' description: OK security: - accountSid_authToken: [] operationId: ListEntity x-maturity: - GA /v2/Services/{ServiceSid}/Entities/{Identity}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - date_created pathType: instance dependentProperties: factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors new_factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors challenges: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} delete: description: Delete a specific Entity. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEntity x-maturity: - GA get: description: Fetch a specific Entity. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' description: OK security: - accountSid_authToken: [] operationId: FetchEntity x-maturity: - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type pathType: instance parent: /Services/{ServiceSid}/Entities/{Identity} delete: description: Delete a specific Factor. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFactor x-maturity: - GA get: description: Fetch a specific Factor. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' description: OK security: - accountSid_authToken: [] operationId: FetchFactor x-maturity: - GA post: description: Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' description: OK security: - accountSid_authToken: [] operationId: UpdateFactor x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateFactorRequest' /v2/Services/{ServiceSid}/Entities/{Identity}/Factors: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type pathType: list parent: /Services/{ServiceSid}/Entities/{Identity} get: description: Retrieve a list of all Factors for an Entity. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factors. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFactorResponse' description: OK security: - accountSid_authToken: [] operationId: ListFactor x-maturity: - GA post: description: Create a new Factor for the Entity tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.new_factor' description: Created security: - accountSid_authToken: [] operationId: CreateNewFactor x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateNewFactorRequest' x-twilio: mountName: new_factors /v2/Services/{ServiceSid}/MessagingConfigurations: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - account_sid - service_sid - country - messaging_service_sid - date_created - date_updated pathType: list parent: /Services/{Sid} post: description: Create a new MessagingConfiguration for a service. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' description: Created security: - accountSid_authToken: [] operationId: CreateMessagingConfiguration x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateMessagingConfigurationRequest' get: description: Retrieve a list of all Messaging Configurations for a Service. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListMessagingConfigurationResponse' description: OK security: - accountSid_authToken: [] operationId: ListMessagingConfiguration x-maturity: - GA /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - account_sid - service_sid - country - messaging_service_sid - date_created - date_updated pathType: instance parent: /Services/{Sid} post: description: Update a specific MessagingConfiguration tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' description: OK security: - accountSid_authToken: [] operationId: UpdateMessagingConfiguration x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateMessagingConfigurationRequest' get: description: Fetch a specific MessagingConfiguration. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' description: OK security: - accountSid_authToken: [] operationId: FetchMessagingConfiguration x-maturity: - GA delete: description: Delete a specific MessagingConfiguration. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMessagingConfiguration x-maturity: - GA /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - identity - challenge_sid - date_created pathType: list parent: /Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} post: description: Create a new Notification for the corresponding Challenge tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: ChallengeSid in: path description: The unique SID identifier of the Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge.notification' description: Created security: - accountSid_authToken: [] operationId: CreateNotification x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateNotificationRequest_2' /v2/Services/{ServiceSid}/RateLimits: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - account_sid - unique_name - description - date_created - date_updated pathType: list dependentProperties: buckets: mapping: service_sid: service_sid rate_limit_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} post: description: Create a new Rate Limit for a Service tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' description: Created security: - accountSid_authToken: [] operationId: CreateRateLimit x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateRateLimitRequest' get: description: Retrieve a list of all Rate Limits for a service. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListRateLimitResponse' description: OK security: - accountSid_authToken: [] operationId: ListRateLimit x-maturity: - GA /v2/Services/{ServiceSid}/RateLimits/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - account_sid - unique_name - description - date_created - date_updated pathType: instance dependentProperties: buckets: mapping: service_sid: service_sid rate_limit_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} post: description: Update a specific Rate Limit. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' description: OK security: - accountSid_authToken: [] operationId: UpdateRateLimit x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateRateLimitRequest' get: description: Fetch a specific Rate Limit. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' description: OK security: - accountSid_authToken: [] operationId: FetchRateLimit x-maturity: - GA delete: description: Delete a specific Rate Limit. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteRateLimit x-maturity: - GA /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created pathType: list parent: /Services/{Sid} post: description: Create a new Verification using a Service tags: - Services parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' description: Created security: - accountSid_authToken: [] operationId: CreateVerification x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateVerificationRequest' /v2/Services/{ServiceSid}/Verifications/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created pathType: instance parent: /Services/{Sid} post: description: Update a Verification status tags: - Services parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to update the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' description: OK security: - accountSid_authToken: [] operationId: UpdateVerification x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateVerificationRequest' get: description: Fetch a specific Verification tags: - Services parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' description: OK security: - accountSid_authToken: [] operationId: FetchVerification x-maturity: - GA /v2/Services/{ServiceSid}/VerificationCheck: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created pathType: list parent: /Services/{Sid} mountName: verification_checks post: description: challenge a specific Verification Check. tags: - Services parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification_check' description: Created security: - accountSid_authToken: [] operationId: CreateVerificationCheck x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateVerificationCheckRequest' /v2/Services/{ServiceSid}/Webhooks: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - friendly_name - event_types - webhook_url - webhook_method - status - date_created pathType: list parent: /Services/{Sid} post: description: Create a new Webhook for the Service tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' description: Created security: - accountSid_authToken: [] operationId: CreateWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateWebhookRequest' get: description: Retrieve a list of all Webhooks for a Service. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListWebhookResponse' description: OK security: - accountSid_authToken: [] operationId: ListWebhook x-maturity: - GA /v2/Services/{ServiceSid}/Webhooks/{Sid}: servers: - url: https://verify.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - service_sid - friendly_name - event_types - webhook_url - webhook_method - status - date_created pathType: instance parent: /Services/{Sid} post: description: '' tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook x-maturity: - GA requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateWebhookRequest' delete: description: Delete a specific Webhook. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteWebhook x-maturity: - GA get: description: Fetch a specific Webhook. tags: - Services parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' description: OK security: - accountSid_authToken: [] operationId: FetchWebhook x-maturity: - GA components: schemas: ListServiceResponse: type: object properties: services: type: array items: $ref: '#/components/schemas/conversations.v1.service' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateChallengeRequest: type: object properties: AuthPayload: type: string description: The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must be between 3 and 8 characters long. For `Push` this value can be up to 5456 characters in length Metadata: description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' CreateVerificationCheckRequest: type: object properties: Code: type: string description: The 4-10 character string being verified. To: type: string description: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). VerificationSid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ description: A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified. Amount: type: string description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. Payee: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. serverless.v1.service.environment.variable: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Variable resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Variable resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Variable resource is associated with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true description: The SID of the Environment in which the Variable exists. key: type: string nullable: true description: A string by which the Variable resource can be referenced. x-twilio: pii: handling: standard deleteSla: 7 value: type: string nullable: true description: A string that contains the actual value of the Variable. x-twilio: pii: handling: standard deleteSla: 7 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Variable resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Variable resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Variable resource. UpdateServiceConfigurationRequest: type: object properties: DefaultConversationCreatorRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. DefaultConversationRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. DefaultChatServiceRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. ReachabilityEnabled: type: boolean description: Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. user_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' ListFunctionResponse: type: object properties: functions: type: array items: $ref: '#/components/schemas/serverless.v1.service.function' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateUserRequest: type: object properties: RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' Attributes: type: string description: '' FriendlyName: type: string description: '' ListAssetResponse: type: object properties: assets: type: array items: $ref: '#/components/schemas/serverless.v1.service.asset' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateServiceConversationParticipantRequest: type: object properties: DateCreated: type: string format: date-time description: The date on which this resource was created. DateUpdated: type: string format: date-time description: The date on which this resource was last updated. Identity: type: string description: A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. MessagingBinding.ProxyAddress: type: string description: The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it. LastReadMessageIndex: type: integer nullable: true description: Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. LastReadTimestamp: type: string description: Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. session_enum_mode: type: string enum: - message-only - voice-only - voice-and-message ListChannelWebhookResponse: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.channel_webhook' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string build_enum_runtime: type: string enum: - node8 - node10 - node12 - node14 - node16 - node18 CreateNewFactorRequest: type: object required: - FriendlyName - FactorType properties: FriendlyName: type: string description: 'The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For `factor_type` `push`, this could be a device name. For `factor_type` `totp`, this value is used as the “account name” in constructing the `binding.uri` property. At the same time, we recommend avoiding providing PII.' FactorType: type: string $ref: '#/components/schemas/new_factor_enum_factor_types' description: The Type of this Factor. Currently `push` and `totp` are supported. Binding.Alg: type: string description: 'The algorithm used when `factor_type` is `push`. Algorithm supported: `ES256`' Binding.PublicKey: type: string description: 'The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64. Required when `factor_type` is `push`' Config.AppId: type: string description: 'The ID that uniquely identifies your app in the Google or Apple store, such as `com.example.myapp`. It can be up to 100 characters long. Required when `factor_type` is `push`.' Config.NotificationPlatform: type: string $ref: '#/components/schemas/new_factor_enum_notification_platforms' description: 'The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`. Required when `factor_type` is `push`.' Config.NotificationToken: type: string description: 'For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long. Required when `factor_type` is `push`.' Config.SdkVersion: type: string description: 'The Verify Push SDK version used to configure the factor Required when `factor_type` is `push`' Binding.Secret: type: string description: 'The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated. Used when `factor_type` is `totp`' Config.TimeStep: type: integer description: 'Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property `totp.time_step`. Defaults to 30 seconds if not configured. Used when `factor_type` is `totp`' Config.Skew: type: integer description: 'The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property `totp.skew`. If not configured defaults to 1. Used when `factor_type` is `totp`' Config.CodeLength: type: integer description: 'Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property `totp.code_length`. If not configured defaults to 6. Used when `factor_type` is `totp`' Config.Alg: type: string $ref: '#/components/schemas/new_factor_enum_totp_algorithms' description: 'The algorithm used to derive the TOTP codes. Can be `sha1`, `sha256` or `sha512`. Defaults to `sha1`. Used when `factor_type` is `totp`' Metadata: description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' ListUserChannelResponse: type: object properties: channels: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_channel' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string proxy.v1.service.session.interaction: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Interaction resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Interaction resource. data: type: string nullable: true description: 'A JSON string that includes the message body of message interactions (e.g. `{"body": "hello"}`) or the call duration (when available) of a call (e.g. `{"duration": "5"}`).' x-twilio: pii: handling: sensitive deleteSla: 30 type: type: string $ref: '#/components/schemas/interaction_enum_type' nullable: true description: 'The Type of the Interaction. Can be: `message`, `voice` or `unknown`.' inbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: The SID of the inbound [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. inbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource). inbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' nullable: true description: The inbound resource status of the Interaction. Will always be `delivered` for messages and `in-progress` for calls. inbound_resource_type: type: string nullable: true description: The inbound resource type. Can be [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource). inbound_resource_url: type: string format: uri nullable: true description: The URL of the Twilio inbound resource outbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant)). outbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the outbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource). outbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' nullable: true description: 'The outbound resource status of the Interaction. Can be: `accepted`, `canceled`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `partially-delivered`, `queued`, `read`, `received`, `receiving`, `scheduled`, `sending`, `sent`, `undelivered`, or `unknown` for messages. Can be `initiated` or `completed` or `unknown` for calls.' outbound_resource_type: type: string nullable: true description: 'The outbound resource type. Can be: [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource).' outbound_resource_url: type: string format: uri nullable: true description: The URL of the Twilio outbound resource. date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Interaction was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. url: type: string format: uri nullable: true description: The absolute URL of the Interaction resource. conversations.v1.service: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service. sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this service, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this service. links: type: object format: uri-map nullable: true description: Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service. conversations.v1.service.service_conversation.service_conversation_participant: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. identity: type: string nullable: true description: A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. x-twilio: pii: handling: sensitive deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. date_created: type: string format: date-time nullable: true description: The date on which this resource was created. date_updated: type: string format: date-time nullable: true description: The date on which this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this participant. last_read_message_index: type: integer nullable: true description: Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. last_read_timestamp: type: string nullable: true description: Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant. UpdateSyncMapPermissionRequest: type: object required: - Read - Write - Manage properties: Read: type: boolean description: Whether the identity can read the Sync Map and its Items. Default value is `false`. Write: type: boolean description: Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`. Manage: type: boolean description: Whether the identity can delete the Sync Map. Default value is `false`. ListAlphaSenderResponse: type: object properties: alpha_senders: type: array items: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string interaction_enum_type: type: string enum: - message - voice - unknown factor_enum_factor_types: type: string enum: - push - totp conversations.v1.service.service_binding: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this binding. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Credential](https://www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. endpoint: type: string nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. x-twilio: pii: handling: standard deleteSla: 30 identity: type: string nullable: true description: The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info. x-twilio: pii: handling: standard deleteSla: 30 binding_type: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' nullable: true description: 'The push technology to use for the Binding. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.' message_types: type: array items: type: string nullable: true description: The [Conversation message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to. url: type: string format: uri nullable: true description: An absolute API resource URL for this binding. ListShortCodeResponse: type: object properties: short_codes: type: array items: $ref: '#/components/schemas/messaging.v1.service.short_code' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string messaging.v1.service.phone_number: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the PhoneNumber resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. phone_number: type: string format: phone-number nullable: true description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `Voice`, `SMS`, and `MMS`.' url: type: string format: uri nullable: true description: The absolute URL of the PhoneNumber resource. notification_enum_priority: type: string enum: - high - low sync_list_item_enum_query_from_bound_type: type: string enum: - inclusive - exclusive message_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' ListLogResponse: type: object properties: logs: type: array items: $ref: '#/components/schemas/serverless.v1.service.environment.log' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string service_webhook_configuration_enum_method: type: string enum: - GET - POST ListInviteResponse: type: object properties: invites: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.invite' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string sync.v1.service.sync_stream: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^TO[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Sync Stream resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Stream resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. url: type: string format: uri nullable: true description: The absolute URL of the Message Stream resource. links: type: object format: uri-map nullable: true description: The URLs of the Stream's nested resources. date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is `null`. The Stream might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'. x-twilio: pii: handling: standard deleteSla: 30 CreateSyncListRequest: type: object properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource. Ttl: type: integer description: Alias for collection_ttl. If both are provided, this value is ignored. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. ListDocumentPermissionResponse: type: object properties: permissions: type: array items: $ref: '#/components/schemas/sync.v1.service.document.document_permission' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateServiceRequest: type: object required: - FriendlyName properties: FriendlyName: type: string description: The human-readable name of this service, limited to 256 characters. Optional. asset_version_enum_visibility: type: string enum: - public - private - protected ListEnvironmentResponse: type: object properties: environments: type: array items: $ref: '#/components/schemas/serverless.v1.service.environment' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateChannelWebhookRequest: type: object required: - Type properties: Type: type: string $ref: '#/components/schemas/channel_webhook_enum_type' description: '' Configuration.Url: type: string description: '' Configuration.Method: type: string $ref: '#/components/schemas/channel_webhook_enum_method' description: '' Configuration.Filters: type: array items: type: string description: '' Configuration.Triggers: type: array items: type: string description: '' Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: '' Configuration.RetryCount: type: integer description: '' UpdateDocumentPermissionRequest: type: object required: - Read - Write - Manage properties: Read: type: boolean description: Whether the identity can read the Sync Document. Default value is `false`. Write: type: boolean description: Whether the identity can update the Sync Document. Default value is `false`. Manage: type: boolean description: Whether the identity can delete the Sync Document. Default value is `false`. ListSyncListItemResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_item' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListSessionResponse: type: object properties: sessions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string member_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.service.service_role: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 type: type: string $ref: '#/components/schemas/service_role_enum_role_type' nullable: true description: 'The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.' permissions: type: array items: type: string nullable: true description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: An absolute API resource URL for this user role. verify.v2.service.rate_limit: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Rate Limit. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource. unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.** description: type: string nullable: true description: Description of this Rate Limit date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. proxy.v1.service.phone_number: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the PhoneNumber resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the PhoneNumber resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. phone_number: type: string format: phone-number nullable: true description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. iso_country: type: string nullable: true description: The ISO Country Code for the phone number. capabilities: type: object format: phone-number-capabilities properties: mms: type: boolean sms: type: boolean voice: type: boolean fax: type: boolean nullable: true description: The capabilities of the phone number. url: type: string format: uri nullable: true description: The absolute URL of the PhoneNumber resource. is_reserved: type: boolean nullable: true description: Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. in_use: type: integer nullable: true description: The number of open session assigned to the number. See the [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) guide for more information. ListServiceRoleResponse: type: object properties: roles: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_role' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string intelligence.v2.service: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account the Service belongs to. auto_redaction: type: boolean nullable: true description: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. media_redaction: type: boolean nullable: true description: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise. auto_transcribe: type: boolean nullable: true description: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. data_logging: type: boolean nullable: true description: 'Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.' date_created: type: string format: date-time nullable: true description: The date that this Service was created, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that this Service was updated, given in ISO 8601 format. friendly_name: type: string nullable: true description: A human readable description of this resource, up to 64 characters. language_code: type: string nullable: true description: The default language code of the audio. sid: type: string nullable: true description: A 34 character string that uniquely identifies this Service. unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID. url: type: string format: uri nullable: true description: The URL of this resource. webhook_url: type: string nullable: true description: The URL Twilio will request when executing the Webhook. webhook_http_method: type: string $ref: '#/components/schemas/service_enum_http_method' nullable: true description: The HTTP method for the Webhook. One of `GET` or `POST`. version: type: integer nullable: true description: The version number of this Service. UpdateUserChannelRequest: type: object properties: NotificationLevel: type: string $ref: '#/components/schemas/user_channel_enum_notification_level' description: '' LastConsumedMessageIndex: type: integer nullable: true description: '' LastConsumptionTimestamp: type: string format: date-time description: '' service_user_conversation_enum_notification_level: type: string enum: - default - muted channel_webhook_enum_type: type: string enum: - webhook - trigger - studio service_enum_http_method: type: string enum: - GET - POST - 'NULL' CreateServiceRequest_9: type: object required: - FriendlyName properties: FriendlyName: type: string description: Human-readable service name (shown in verification messages) CodeLength: type: integer minimum: 4 maximum: 10 default: 6 description: Length of the verification code LookupEnabled: type: boolean default: false SkipSmsToLandlines: type: boolean default: false DtmfInputRequired: type: boolean default: true TtsName: type: string DoNotShareWarningEnabled: type: boolean default: false CustomCodeEnabled: type: boolean default: false Push.IncludeDate: type: boolean Push.ApnCredentialSid: type: string Push.FcmCredentialSid: type: string Totp.Issuer: type: string Totp.TimeStep: type: integer Totp.CodeLength: type: integer Totp.Skew: type: integer DefaultTemplateSid: type: string ListServiceConversationParticipantResponse: type: object properties: participants: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateServiceRequest_2: type: object required: - UniqueName properties: UniqueName: type: string description: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID. AutoTranscribe: type: boolean description: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. DataLogging: type: boolean description: 'Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to 64 characters. LanguageCode: type: string description: The default language code of the audio. AutoRedaction: type: boolean description: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. MediaRedaction: type: boolean description: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise. WebhookUrl: type: string description: The URL Twilio will request when executing the Webhook. WebhookHttpMethod: type: string $ref: '#/components/schemas/service_enum_http_method' description: The HTTP method for the Webhook. One of `GET` or `POST`. CreateRateLimitRequest: type: object required: - UniqueName properties: UniqueName: type: string description: Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.** Description: type: string description: Description of this Rate Limit interaction_enum_resource_status: type: string enum: - accepted - answered - busy - canceled - completed - deleted - delivered - delivery-unknown - failed - in-progress - initiated - no-answer - queued - received - receiving - ringing - scheduled - sending - sent - undelivered - unknown verification_enum_risk_check: type: string enum: - enable - disable UpdateAssetRequest: type: object required: - FriendlyName properties: FriendlyName: type: string description: A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters. notify.v1.service.notification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^NT[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Notification resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. identities: type: array items: type: string nullable: true description: The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list. x-twilio: pii: handling: standard deleteSla: 120 tags: type: array items: type: string nullable: true description: The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property. x-twilio: pii: handling: standard deleteSla: 120 segments: type: array items: type: string nullable: true description: The list of Segments to notify. The [Segment](https://www.twilio.com/docs/notify/api/segment-resource) resource is deprecated. Use the `tags` property, instead. priority: type: string $ref: '#/components/schemas/notification_enum_priority' nullable: true description: 'The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app''s battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property.' ttl: type: integer nullable: true description: How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property. title: type: string nullable: true description: The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices. body: type: string nullable: true description: The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. x-twilio: pii: handling: standard deleteSla: 0 sound: type: string nullable: true description: The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property. action: type: string nullable: true description: The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels. data: nullable: true description: The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels. apn: nullable: true description: The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. gcm: nullable: true description: The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. fcm: nullable: true description: The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel. sms: nullable: true description: 'The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/api/message-resource) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.' facebook_messenger: nullable: true description: Deprecated. alexa: nullable: true description: Deprecated. proxy.v1.service.short_code: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ShortCode resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the ShortCode resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. short_code: type: string nullable: true description: The short code's number. iso_country: type: string nullable: true description: The ISO Country Code for the short code. capabilities: type: object format: phone-number-capabilities properties: mms: type: boolean sms: type: boolean voice: type: boolean fax: type: boolean nullable: true description: The capabilities of the short code. url: type: string format: uri nullable: true description: The absolute URL of the ShortCode resource. is_reserved: type: boolean nullable: true description: Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. service_user_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' PaginationMeta: type: object properties: page: type: integer page_size: type: integer first_page_url: type: string format: uri previous_page_url: type: string format: uri next_page_url: type: string format: uri url: type: string format: uri key: type: string messaging.v1.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. inbound_request_url: type: string format: uri nullable: true description: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. inbound_method: type: string format: http-method enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true description: The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`. fallback_url: type: string format: uri nullable: true description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. fallback_method: type: string format: http-method enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true description: 'The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`.' status_callback: type: string format: uri nullable: true description: The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. sticky_sender: type: boolean nullable: true description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. mms_converter: type: boolean nullable: true description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. smart_encoding: type: boolean nullable: true description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. scan_message_content: type: string $ref: '#/components/schemas/service_enum_scan_message_content' nullable: true description: Reserved. fallback_to_long_code: type: boolean nullable: true description: '[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.' area_code_geomatch: type: boolean nullable: true description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. synchronous_validation: type: boolean nullable: true description: Reserved. validity_period: type: integer nullable: true description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. url: type: string format: uri nullable: true description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true description: The absolute URLs of related resources. usecase: type: string nullable: true description: A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. us_app_to_person_registered: type: boolean nullable: true description: Whether US A2P campaign is registered for this Service. use_inbound_webhook_on_number: type: boolean nullable: true description: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. UpdateMessageRequest: type: object properties: Body: type: string description: '' Attributes: type: string description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' LastUpdatedBy: type: string description: '' From: type: string description: '' verify.v2.service.verification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Verification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource. to: type: string nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). x-twilio: pii: handling: standard deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_enum_channel' nullable: true description: 'The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`.' status: type: string nullable: true description: 'The status of the verification. One of: `pending`, `approved`, or `canceled`' valid: type: boolean nullable: true description: Use "status" instead. Legacy property indicating whether the verification was successful. lookup: nullable: true description: Information about the phone number being verified. amount: type: string nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 send_code_attempts: type: array items: {} nullable: true description: An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. sna: nullable: true description: The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number. url: type: string format: uri nullable: true description: The absolute URL of the Verification resource. ListDocumentResponse: type: object properties: documents: type: array items: $ref: '#/components/schemas/sync.v1.service.document' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string conversations.v1.service.service_configuration.service_webhook_configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. pre_webhook_url: type: string format: uri nullable: true description: The absolute url the pre-event webhook request should be sent to. post_webhook_url: type: string format: uri nullable: true description: The absolute url the post-event webhook request should be sent to. filters: type: array items: type: string nullable: true description: The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`. method: type: string $ref: '#/components/schemas/service_webhook_configuration_enum_method' nullable: true description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. url: type: string format: uri nullable: true description: An absolute API resource URL for this webhook. ListChannelSenderResponse: type: object properties: senders: type: array items: $ref: '#/components/schemas/messaging.v1.service.channel_sender' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateRoleRequest: type: object required: - FriendlyName - Type - Permission properties: FriendlyName: type: string description: '' Type: type: string $ref: '#/components/schemas/role_enum_role_type' description: '' Permission: type: array items: type: string description: '' messaging.v1.service.alpha_sender: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^AI[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the AlphaSender resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AlphaSender resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. alpha_sender: type: string nullable: true description: The Alphanumeric Sender ID string. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `SMS`.' url: type: string format: uri nullable: true description: The absolute URL of the AlphaSender resource. ListSyncMapPermissionResponse: type: object properties: permissions: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_permission' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string verify.v2.service.entity.challenge.notification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^NT[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Notification. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 challenge_sid: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Challenge. priority: type: string nullable: true description: The priority of the notification. For `push` Challenges it's always `high` which sends the notification immediately, and can wake up a sleeping device. ttl: type: integer nullable: true description: 'How long, in seconds, the notification is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true description: The date that this Notification was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. verification_enum_status: type: string enum: - canceled - approved CreateStreamMessageRequest: type: object required: - Data properties: Data: description: A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length. serverless.v1.service.asset.asset_version: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Asset Version resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Asset Version resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Asset Version resource is associated with. asset_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Asset resource that is the parent of the Asset Version. path: type: string nullable: true description: The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. x-twilio: pii: handling: standard deleteSla: 7 visibility: type: string $ref: '#/components/schemas/asset_version_enum_visibility' nullable: true description: 'The access control that determines how the Asset Version resource can be accessed. Can be: `public`, `protected`, or `private`.' date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Asset Version resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Asset Version resource. build_enum_status: type: string enum: - building - completed - failed UpdateServiceNotificationRequest: type: object properties: LogEnabled: type: boolean description: Weather the notification logging is enabled. NewMessage.Enabled: type: boolean description: Whether to send a notification when a new message is added to a conversation. The default is `false`. NewMessage.Template: type: string description: The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`. NewMessage.Sound: type: string description: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`. NewMessage.BadgeCountEnabled: type: boolean description: Whether the new message badge is enabled. The default is `false`. AddedToConversation.Enabled: type: boolean description: Whether to send a notification when a participant is added to a conversation. The default is `false`. AddedToConversation.Template: type: string description: The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`. AddedToConversation.Sound: type: string description: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`. RemovedFromConversation.Enabled: type: boolean description: Whether to send a notification to a user when they are removed from a conversation. The default is `false`. RemovedFromConversation.Template: type: string description: The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`. RemovedFromConversation.Sound: type: string description: The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`. NewMessage.WithMedia.Enabled: type: boolean description: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`. NewMessage.WithMedia.Template: type: string description: The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`. ListBindingResponse_2: type: object properties: bindings: type: array items: $ref: '#/components/schemas/notify.v1.service.binding' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateWebhookRequest: type: object properties: FriendlyName: type: string description: The string that you assigned to describe the webhook. **This value should not contain PII.** EventTypes: type: array items: type: string description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' WebhookUrl: type: string description: The URL associated with this Webhook. Status: type: string $ref: '#/components/schemas/webhook_enum_status' description: 'The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`' Version: type: string $ref: '#/components/schemas/webhook_enum_version' description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. CreateExternalCampaignRequest: type: object required: - CampaignId - MessagingServiceSid properties: CampaignId: type: string description: ID of the preregistered campaign. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. CreateSyncMapItemRequest: type: object required: - Key - Data properties: Key: type: string description: The unique, user-defined key for the Map Item. Can be up to 320 characters long. Data: description: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. Ttl: type: integer description: An alias for `item_ttl`. If both parameters are provided, this value is ignored. ItemTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. verify.v2.service.entity: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Entity. identity: type: string nullable: true description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. date_created: type: string format: date-time nullable: true description: The date that this Entity was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Entity was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: Contains a dictionary of URL links to nested resources of this Entity. UpdateServiceWebhookConfigurationRequest: type: object properties: PreWebhookUrl: type: string format: uri description: The absolute url the pre-event webhook request should be sent to. PostWebhookUrl: type: string format: uri description: The absolute url the post-event webhook request should be sent to. Filters: type: array items: type: string description: The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`. Method: type: string description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. webhook_enum_methods: type: string enum: - GET - POST UpdateServiceConversationMessageRequest: type: object properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. Subject: type: string description: The subject of the message, can be up to 256 characters long. ServiceList: type: object properties: services: type: array items: $ref: '#/components/schemas/VerifyService' meta: $ref: '#/components/schemas/PaginationMeta' ListBuildResponse: type: object properties: builds: type: array items: $ref: '#/components/schemas/serverless.v1.service.build' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateFunctionRequest: type: object required: - FriendlyName properties: FriendlyName: type: string description: A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters. message_enum_order_type: type: string enum: - asc - desc ListServiceConversationMessageResponse: type: object properties: messages: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListSyncStreamResponse: type: object properties: streams: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_stream' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateVerificationRequest: type: object required: - Status properties: Status: type: string $ref: '#/components/schemas/verification_enum_status' description: 'The new status of the resource. Can be: `canceled` or `approved`.' CreateShortCodeRequest: type: object required: - ShortCodeSid properties: ShortCodeSid: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ description: The SID of the ShortCode resource being added to the Service. CreateServiceConversationRequest: type: object properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. UniqueName: type: string 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. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. State: type: string $ref: '#/components/schemas/service_conversation_enum_state' description: Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active` Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. CreateServiceConversationMessageRequest: type: object properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. MediaSid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: The Media SID to be attached to the new Message. ContentSid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. ContentVariables: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. Subject: type: string description: The subject of the message, can be up to 256 characters long. ListMessageResponse: type: object properties: messages: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.message' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListWebhookResponse: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/verify.v2.service.webhook' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ip_messaging.v2.service.binding: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true endpoint: type: string nullable: true identity: type: string nullable: true credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true binding_type: type: string $ref: '#/components/schemas/binding_enum_binding_type' nullable: true message_types: type: array items: type: string nullable: true url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true message_interaction_enum_resource_status: type: string enum: - accepted - answered - busy - canceled - completed - deleted - delivered - delivery-unknown - failed - in-progress - initiated - no-answer - queued - received - receiving - ringing - scheduled - sending - sent - undelivered - unknown verify.v2.service.entity.challenge: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Challenge. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 factor_sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Factor. date_created: type: string format: date-time nullable: true description: The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_responded: type: string format: date-time nullable: true description: The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. expiration_date: type: string format: date-time nullable: true description: The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation. status: type: string $ref: '#/components/schemas/challenge_enum_challenge_statuses' nullable: true description: The Status of this Challenge. One of `pending`, `expired`, `approved` or `denied`. responded_reason: type: string $ref: '#/components/schemas/challenge_enum_challenge_reasons' nullable: true description: Reason for the Challenge to be in certain `status`. One of `none`, `not_needed` or `not_requested`. details: nullable: true description: Details provided to give context about the Challenge. Intended to be shown to the end user. x-twilio: pii: handling: standard deleteSla: 30 hidden_details: nullable: true description: 'Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`' x-twilio: pii: handling: standard deleteSla: 30 metadata: nullable: true description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 factor_type: type: string $ref: '#/components/schemas/challenge_enum_factor_types' nullable: true description: The Factor Type of this Challenge. Currently `push` and `totp` are supported. url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: Contains a dictionary of URL links to nested resources of this Challenge. ip_messaging.v2.service.channel.channel_webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true type: type: string nullable: true url: type: string format: uri nullable: true configuration: nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true ListServiceUserConversationResponse: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateSyncMapRequest: type: object properties: Ttl: type: integer description: An alias for `collection_ttl`. If both parameters are provided, this value is ignored. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. verify.v2.service.verification_check: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the VerificationCheck resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource. to: type: string nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). x-twilio: pii: handling: standard deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_check_enum_channel' nullable: true description: 'The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`.' status: type: string nullable: true description: 'The status of the verification. Can be: `pending`, `approved`, or `canceled`.' valid: type: boolean nullable: true description: Use "status" instead. Legacy property indicating whether the verification was successful. amount: type: string nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated. sna_attempts_error_codes: type: array items: {} nullable: true description: List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`. UpdateSyncListRequest: type: object properties: Ttl: type: integer description: An alias for `collection_ttl`. If both are provided, this value is ignored. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted. ListFunctionVersionResponse: type: object properties: function_versions: type: array items: $ref: '#/components/schemas/serverless.v1.service.function.function_version' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateSessionRequest: type: object properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.** DateExpiry: type: string format: date-time description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value. Ttl: type: integer description: The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction. Mode: type: string $ref: '#/components/schemas/session_enum_mode' description: 'The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message` and the default value is `voice-and-message`.' Status: type: string $ref: '#/components/schemas/session_enum_status' description: 'The initial status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`. The default is `open` on create.' Participants: type: array items: {} description: The Participant objects to include in the new session. binding_enum_binding_type: type: string enum: - gcm - apn - fcm serverless.v1.service.function: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Function resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function resource is associated with. friendly_name: type: string nullable: true description: The string that you assigned to describe the Function resource. It can be a maximum of 255 characters. x-twilio: pii: handling: standard deleteSla: 7 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Function resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Function resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Function resource. links: type: object format: uri-map nullable: true description: The URLs of nested resources of the Function resource. sync_map_item_enum_query_result_order: type: string enum: - asc - desc service_conversation_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' new_factor_enum_totp_algorithms: type: string enum: - sha1 - sha256 - sha512 verification_check_enum_channel: type: string enum: - sms - call - email - whatsapp - sna ip_messaging.v2.service.role: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true type: type: string $ref: '#/components/schemas/role_enum_role_type' nullable: true permissions: type: array items: type: string nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true url: type: string format: uri nullable: true VerifyService: type: object properties: sid: type: string pattern: ^VA[0-9a-fA-F]{32}$ description: Unique identifier for the service account_sid: type: string pattern: ^AC[0-9a-fA-F]{32}$ friendly_name: type: string description: Friendly name of the service code_length: type: integer description: Length of verification codes (4-10) lookup_enabled: type: boolean description: Whether to perform a Lookup before sending skip_sms_to_landlines: type: boolean dtmf_input_required: type: boolean tts_name: type: string description: Text-to-speech voice name do_not_share_warning_enabled: type: boolean custom_code_enabled: type: boolean push: type: object properties: include_date: type: boolean apn_credential_sid: type: string fcm_credential_sid: type: string totp: type: object properties: issuer: type: string time_step: type: integer code_length: type: integer skew: type: integer default_template_sid: type: string date_created: type: string format: date-time date_updated: type: string format: date-time url: type: string format: uri links: type: object ListFactorResponse: type: object properties: factors: type: array items: $ref: '#/components/schemas/verify.v2.service.entity.factor' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateMemberRequest: type: object required: - Identity properties: Identity: type: string description: '' RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' LastConsumedMessageIndex: type: integer nullable: true description: '' LastConsumptionTimestamp: type: string format: date-time description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' Attributes: type: string description: '' UpdateDocumentRequest: type: object properties: Data: description: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. Ttl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live). ListMessagingConfigurationResponse: type: object properties: messaging_configurations: type: array items: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string sync.v1.service.sync_list.sync_list_item: type: object properties: index: type: integer nullable: true description: The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the List Item resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. list_sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true description: The SID of the Sync List that contains the List Item. url: type: string format: uri nullable: true description: The absolute URL of the List Item resource. revision: type: string nullable: true description: The current revision of the item, represented as a string. data: nullable: true description: An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. x-twilio: pii: handling: sensitive deleteSla: 7 date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the List Item does not expire, this value is `null`. The List Item resource might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`. x-twilio: pii: handling: standard deleteSla: 30 service_role_enum_role_type: type: string enum: - conversation - service CreateEntityRequest: type: object required: - Identity properties: Identity: type: string description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. UpdateSessionRequest: type: object properties: DateExpiry: type: string format: date-time description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value. Ttl: type: integer description: The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction. Status: type: string $ref: '#/components/schemas/session_enum_status' description: 'The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session.' service_conversation_message_enum_order_type: type: string enum: - asc - desc UpdatePhoneNumberRequest: type: object properties: IsReserved: type: boolean description: Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. serverless.v1.service.function.function_version: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Function Version resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function Version resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function Version resource is associated with. function_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Function resource that is the parent of the Function Version resource. path: type: string nullable: true description: The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. x-twilio: pii: handling: standard deleteSla: 7 visibility: type: string $ref: '#/components/schemas/function_version_enum_visibility' nullable: true description: 'The access control that determines how the Function Version resource can be accessed. Can be: `public`, `protected`, or `private`.' date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Function Version resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Function Version resource. links: type: object format: uri-map nullable: true ListServiceConversationScopedWebhookResponse: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string proxy.v1.service.session.participant.message_interaction: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KI[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the MessageInteraction resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MessageInteraction resource. data: type: string nullable: true description: 'A JSON string that includes the message body sent to the participant. (e.g. `{"body": "hello"}`)' x-twilio: pii: handling: sensitive deleteSla: 30 type: type: string $ref: '#/components/schemas/message_interaction_enum_type' nullable: true description: The Type of Message Interaction. This value is always `message`. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. inbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: Always empty for created Message Interactions. inbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: Always empty for created Message Interactions. inbound_resource_status: type: string $ref: '#/components/schemas/message_interaction_enum_resource_status' nullable: true description: Always empty for created Message Interactions. inbound_resource_type: type: string nullable: true description: Always empty for created Message Interactions. inbound_resource_url: type: string format: uri nullable: true description: Always empty for created Message Interactions. outbound_participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: The SID of the outbound [Participant](https://www.twilio.com/docs/proxy/api/participant) resource. outbound_resource_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the outbound [Message](https://www.twilio.com/docs/sms/api/message-resource) resource. outbound_resource_status: type: string $ref: '#/components/schemas/message_interaction_enum_resource_status' nullable: true description: 'The outbound message resource status. Can be: `accepted`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `queued`, `received`, `receiving`, `scheduled`, `sending`, `sent`, `undelivered`, or `unknown`.' outbound_resource_type: type: string nullable: true description: The outbound resource type. This value is always `Message`. outbound_resource_url: type: string format: uri nullable: true description: The URL of the Twilio message resource. date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. url: type: string format: uri nullable: true description: The absolute URL of the MessageInteraction resource. ListParticipantResponse: type: object properties: participants: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.participant' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateSyncMapRequest: type: object properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. Ttl: type: integer description: An alias for `collection_ttl`. If both parameters are provided, this value is ignored. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. ListRoleResponse: type: object properties: roles: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.role' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string challenge_enum_factor_types: type: string enum: - push - totp service_participant_conversation_enum_state: type: string enum: - inactive - active - closed CreateDeploymentRequest: type: object properties: BuildSid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ description: The SID of the Build for the Deployment. conversations.v1.service.service_configuration: type: object properties: chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service configuration resource. default_conversation_creator_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. default_conversation_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. default_chat_service_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles. url: type: string format: uri nullable: true description: An absolute API resource URL for this service configuration. links: type: object format: uri-map nullable: true description: Contains an absolute API resource URL to access the push notifications configuration of this service. reachability_enabled: type: boolean nullable: true description: Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. CreateWebhookRequest: type: object required: - FriendlyName - EventTypes - WebhookUrl properties: FriendlyName: type: string description: The string that you assigned to describe the webhook. **This value should not contain PII.** EventTypes: type: array items: type: string description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' WebhookUrl: type: string description: The URL associated with this Webhook. Status: type: string $ref: '#/components/schemas/webhook_enum_status' description: 'The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`' Version: type: string $ref: '#/components/schemas/webhook_enum_version' description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. CreateServiceRoleRequest: type: object required: - FriendlyName - Type - Permission properties: FriendlyName: type: string description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. Type: type: string $ref: '#/components/schemas/service_role_enum_role_type' description: 'The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.' Permission: type: array items: type: string 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`. ip_messaging.v2.service.channel.member: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true identity: type: string nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true last_consumed_message_index: type: integer nullable: true last_consumption_timestamp: type: string format: date-time nullable: true url: type: string format: uri nullable: true attributes: type: string nullable: true user_channel_enum_channel_status: type: string enum: - joined - invited - not_participating serverless.v1.service.function.function_version.function_version_content: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Function Version resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Function Version resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Function Version resource is associated with. function_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the Function that is the parent of the Function Version. content: type: string nullable: true description: The content of the Function Version resource. url: type: string format: uri nullable: true ListChallengeResponse: type: object properties: challenges: type: array items: $ref: '#/components/schemas/verify.v2.service.entity.challenge' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string sync.v1.service.sync_map.sync_map_item: type: object properties: key: type: string nullable: true description: The unique, user-defined key for the Map Item. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Map Item resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. map_sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true description: The SID of the Sync Map that contains the Map Item. url: type: string format: uri nullable: true description: The absolute URL of the Map Item resource. revision: type: string nullable: true description: The current revision of the Map Item, represented as a string. data: nullable: true description: An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. x-twilio: pii: handling: sensitive deleteSla: 7 date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the Map Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map Item does not expire, this value is `null`. The Map Item might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`. x-twilio: pii: handling: standard deleteSla: 30 CreateServiceConversationScopedWebhookRequest: type: object required: - Target properties: Target: type: string $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_target' description: 'The target of this webhook: `webhook`, `studio`, `trigger`' Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: type: string $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_method' description: The HTTP method to be used when sending a webhook request. Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. Configuration.ReplayAfter: type: integer description: The message index for which and it's successors the webhook will be replayed. Not set by default new_factor_enum_notification_platforms: type: string enum: - apn - fcm - none role_enum_role_type: type: string enum: - channel - deployment verification_enum_channel: type: string enum: - sms - call - email - whatsapp - sna CreateMessageInteractionRequest: type: object properties: Body: type: string description: The message to send to the participant MediaUrl: type: array items: type: string format: uri description: Reserved. Not currently supported. ListUsAppToPersonResponse: type: object properties: compliance: type: array items: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string serverless.v1.service.asset: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Asset resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Asset resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Asset resource is associated with. friendly_name: type: string nullable: true description: The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters. x-twilio: pii: handling: standard deleteSla: 7 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Asset resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Asset resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Asset resource. links: type: object format: uri-map nullable: true description: The URLs of the Asset resource's nested resources. verify.v2.service.messaging_configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. country: type: string nullable: true description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. conversations.v1.service.service_configuration.service_notification: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. new_message: nullable: true description: The Push Notification configuration for New Messages. added_to_conversation: nullable: true description: The Push Notification configuration for being added to a Conversation. removed_from_conversation: nullable: true description: The Push Notification configuration for being removed from a Conversation. log_enabled: type: boolean nullable: true description: Weather the notification logging is enabled. url: type: string format: uri nullable: true description: An absolute API resource URL for this configuration. sync.v1.service.document: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ET[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Document resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. url: type: string format: uri nullable: true description: The absolute URL of the Document resource. links: type: object format: uri-map nullable: true description: The URLs of resources related to the Sync Document. revision: type: string nullable: true description: The current revision of the Sync Document, represented as a string. The `revision` property is used with conditional updates to ensure data consistency. data: nullable: true description: An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. x-twilio: pii: handling: sensitive deleteSla: 7 date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is `null`. The Document resource might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`. x-twilio: pii: handling: standard deleteSla: 30 ListBucketResponse: type: object properties: buckets: type: array items: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListSyncMapItemResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_map.sync_map_item' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string sync.v1.service.document.document_permission: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. document_sid: type: string minLength: 34 maxLength: 34 pattern: ^ET[0-9a-fA-F]{32}$ nullable: true description: The SID of the Sync Document to which the Document Permission applies. identity: type: string nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. x-twilio: pii: handling: standard deleteSla: 30 read: type: boolean nullable: true description: Whether the identity can read the Sync Document. write: type: boolean nullable: true description: Whether the identity can update the Sync Document. manage: type: boolean nullable: true description: Whether the identity can delete the Sync Document. url: type: string format: uri nullable: true description: The absolute URL of the Sync Document Permission resource. CreateInviteRequest: type: object required: - Identity properties: Identity: type: string description: '' RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' UpdateRateLimitRequest: type: object properties: Description: type: string description: Description of this Rate Limit conversations.v1.service.service_conversation.service_conversation_scoped_webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. target: type: string nullable: true description: 'The target of this webhook: `webhook`, `studio`, `trigger`' url: type: string format: uri nullable: true description: An absolute API resource URL for this webhook. configuration: nullable: true description: The configuration of this webhook. Is defined based on target. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. challenge_enum_list_orders: type: string enum: - asc - desc service_conversation_message_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' new_factor_enum_factor_types: type: string enum: - push - totp CreateMessagingConfigurationRequest: type: object required: - Country - MessagingServiceSid properties: Country: type: string description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. ListServiceResponse_2: type: object properties: services: type: array items: $ref: '#/components/schemas/intelligence.v2.service' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string conversations.v1.service.service_user.service_user_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation. unread_messages_count: type: integer nullable: true description: The number of unread Messages in the Conversation for the Participant. last_read_message_index: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/service_user_conversation_enum_state' nullable: true description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. timers: nullable: true description: Timer date values representing state update for this conversation. attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. x-twilio: pii: handling: sensitive deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. created_by: type: string nullable: true description: Identity of the creator of this Conversation. notification_level: type: string $ref: '#/components/schemas/service_user_conversation_enum_notification_level' nullable: true description: The Notification Level of this User Conversation. One of `default` or `muted`. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation. ListSyncMapResponse: type: object properties: maps: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_map' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateBucketRequest: type: object required: - Max - Interval properties: Max: type: integer description: Maximum number of requests permitted in during the interval. Interval: type: integer description: Number of seconds that the rate limit will be enforced over. messaging.v1.usecase: type: object properties: usecases: type: array items: {} nullable: true description: Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases. conversations.v1.service.service_conversation.service_conversation_message: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. index: type: integer nullable: true description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). author: type: string nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. x-twilio: pii: handling: standard deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. x-twilio: pii: handling: sensitive deleteSla: 30 media: type: array items: {} nullable: true description: 'An array of objects that describe the Message''s media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. x-twilio: pii: handling: sensitive deleteSla: 30 participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of messages's author participant. Null in case of `system` sent message. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the message has not been edited. delivery: nullable: true description: An object that contains the summary of delivery statuses for the message to non-chat participants. url: type: string format: uri nullable: true description: An absolute API resource URL for this message. links: type: object format: uri-map nullable: true description: Contains an absolute API resource URL to access the delivery & read receipts of this message. content_sid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. messaging.v1.external_campaign: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to. campaign_id: type: string nullable: true description: ID of the preregistered campaign. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. ListMessageInteractionResponse: type: object properties: interactions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string serverless.v1.service.environment.deployment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZD[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Deployment resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Deployment resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Deployment resource is associated with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true description: The SID of the Environment for the Deployment. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true description: The SID of the Build for the deployment. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Deployment resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Deployment resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Deployment resource. ListDeploymentResponse: type: object properties: deployments: type: array items: $ref: '#/components/schemas/serverless.v1.service.environment.deployment' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateServiceRequest_3: type: object properties: FriendlyName: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. InboundRequestUrl: type: string format: uri description: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. InboundMethod: type: string format: http-method enum: - HEAD - GET - POST - PATCH - PUT - DELETE description: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. FallbackUrl: type: string format: uri description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. FallbackMethod: type: string format: http-method enum: - HEAD - GET - POST - PATCH - PUT - DELETE description: 'The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.' StatusCallback: type: string format: uri description: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. StickySender: type: boolean description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. MmsConverter: type: boolean description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. SmartEncoding: type: boolean description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. ScanMessageContent: type: string $ref: '#/components/schemas/service_enum_scan_message_content' description: Reserved. FallbackToLongCode: type: boolean description: '[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.' AreaCodeGeomatch: type: boolean description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. ValidityPeriod: type: integer description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`. SynchronousValidation: type: boolean description: Reserved. Usecase: type: string description: A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. UseInboundWebhookOnNumber: type: boolean description: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. UpdateChannelWebhookRequest: type: object properties: Configuration.Url: type: string description: '' Configuration.Method: type: string $ref: '#/components/schemas/channel_webhook_enum_method' description: '' Configuration.Filters: type: array items: type: string description: '' Configuration.Triggers: type: array items: type: string description: '' Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: '' Configuration.RetryCount: type: integer description: '' messaging.v1.service.us_app_to_person: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to. brand_registration_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify the A2P brand. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. description: type: string nullable: true description: 'A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.' message_samples: type: array items: type: string nullable: true description: 'An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.' us_app_to_person_usecase: type: string nullable: true description: 'A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING, SOLE_PROPRIETOR...]. SOLE_PROPRIETOR campaign use cases can only be created by SOLE_PROPRIETOR Brands, and there can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR Brand.' has_embedded_links: type: boolean nullable: true description: Indicate that this SMS campaign will send messages that contain links. has_embedded_phone: type: boolean nullable: true description: Indicates that this SMS campaign will send messages that contain phone numbers. campaign_status: type: string nullable: true description: 'Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.' campaign_id: type: string nullable: true description: The Campaign Registry (TCR) Campaign ID. is_externally_registered: type: boolean nullable: true description: Indicates whether the campaign was registered externally or not. rate_limits: nullable: true description: Rate limit and/or classification set by each carrier, Ex. AT&T or T-Mobile. message_flow: type: string nullable: true description: Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum. opt_in_message: type: string nullable: true description: If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum. opt_out_message: type: string nullable: true description: Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. help_message: type: string nullable: true description: When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. opt_in_keywords: type: array items: type: string nullable: true description: If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum. opt_out_keywords: type: array items: type: string nullable: true description: End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. help_keywords: type: array items: type: string nullable: true description: End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the US App to Person resource. mock: type: boolean nullable: true description: A boolean that specifies whether campaign is a mock or not. Mock campaigns will be automatically created if using a mock brand. Mock campaigns should only be used for testing purposes. errors: type: array items: {} nullable: true description: Details indicating why a campaign registration failed. These errors can indicate one or more fields that were incorrect or did not meet review requirements. verify.v2.service.access_token: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YK[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Access Token. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Verify Service. entity_identity: type: string nullable: true description: The unique external identifier for the Entity of the Service. factor_type: type: string $ref: '#/components/schemas/access_token_enum_factor_types' nullable: true description: The Type of the Factor. Currently only `push` is supported. factor_friendly_name: type: string nullable: true description: A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name. x-twilio: pii: handling: standard deleteSla: 30 token: type: string nullable: true description: The access token generated for enrollment, this is an encrypted json web token. url: type: string format: uri nullable: true description: The URL of this resource. ttl: type: integer nullable: true description: 'How long, in seconds, the access token is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true description: The date that this access token was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. CreateServiceConversationParticipantRequest: type: object properties: Identity: type: string description: A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. MessagingBinding.Address: type: string description: The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field). MessagingBinding.ProxyAddress: type: string description: The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field). DateCreated: type: string format: date-time description: The date on which this resource was created. DateUpdated: type: string format: date-time description: The date on which this resource was last updated. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. new_factor_enum_factor_statuses: type: string enum: - unverified - verified sync.v1.service.sync_list.sync_list_permission: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. list_sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true description: The SID of the Sync List to which the Permission applies. identity: type: string nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. x-twilio: pii: handling: standard deleteSla: 30 read: type: boolean nullable: true description: Whether the identity can read the Sync List and its Items. write: type: boolean nullable: true description: Whether the identity can create, update, and delete Items in the Sync List. manage: type: boolean nullable: true description: Whether the identity can delete the Sync List. url: type: string format: uri nullable: true description: The absolute URL of the Sync List Permission resource. sync.v1.service.sync_map.sync_map_permission: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map Permission resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. map_sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true description: The SID of the Sync Map to which the Permission applies. identity: type: string nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. x-twilio: pii: handling: standard deleteSla: 30 read: type: boolean nullable: true description: Whether the identity can read the Sync Map and its Items. write: type: boolean nullable: true description: Whether the identity can create, update, and delete Items in the Sync Map. manage: type: boolean nullable: true description: Whether the identity can delete the Sync Map. url: type: string format: uri nullable: true description: The absolute URL of the Sync Map Permission resource. ListServiceParticipantConversationResponse: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_participant_conversation' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateServiceUserRequest: type: object required: - Identity properties: Identity: type: string description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. CreateVariableRequest: type: object required: - Key - Value properties: Key: type: string description: A string by which the Variable resource can be referenced. It can be a maximum of 128 characters. Value: type: string description: A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size. sync_map_item_enum_query_from_bound_type: type: string enum: - inclusive - exclusive messaging.v1.service.us_app_to_person_usecase: type: object properties: us_app_to_person_usecases: type: array items: {} nullable: true description: Human readable name, code, description and post_approval_required (indicates whether or not post approval is required for this Use Case) of A2P Campaign Use Cases. UpdateShortCodeRequest: type: object properties: IsReserved: type: boolean description: Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information. UpdateBucketRequest: type: object properties: Max: type: integer description: Maximum number of requests permitted in during the interval. Interval: type: integer description: Number of seconds that the rate limit will be enforced over. challenge_enum_challenge_statuses: type: string enum: - pending - expired - approved - denied proxy.v1.service.session: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Session resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/proxy/api/service) the session is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Session resource. date_started: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session started. date_ended: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session ended. date_last_interaction: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session last had an interaction. date_expiry: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. **This value should not have PII.** status: type: string $ref: '#/components/schemas/session_enum_status' nullable: true description: 'The status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`.' closed_reason: type: string nullable: true description: The reason the Session ended. ttl: type: integer nullable: true description: The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction. mode: type: string $ref: '#/components/schemas/session_enum_mode' nullable: true description: 'The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message`.' date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. url: type: string format: uri nullable: true description: The absolute URL of the Session resource. links: type: object format: uri-map nullable: true description: The URLs of resources related to the Session. proxy.v1.service.session.participant: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Participant resource. session_sid: type: string minLength: 34 maxLength: 34 pattern: ^KC[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent [Session](https://www.twilio.com/docs/proxy/api/session) resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The SID of the resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. **This value should not have PII.** identifier: type: string nullable: true description: The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters. x-twilio: pii: handling: standard deleteSla: 30 proxy_identifier: type: string nullable: true description: The phone number or short code (masked number) of the participant's partner. The participant will call or message the partner participant at this number. proxy_identifier_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Proxy Identifier assigned to the Participant. date_deleted: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Participant was removed from the session. date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated. url: type: string format: uri nullable: true description: The absolute URL of the Participant resource. links: type: object format: uri-map nullable: true description: The URLs to resources related the participant. service_conversation_scoped_webhook_enum_method: type: string enum: - GET - POST CreateDocumentRequest: type: object properties: UniqueName: type: string description: An application-defined string that uniquely identifies the Sync Document Data: description: A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. Ttl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live). CreatePhoneNumberRequest: type: object required: - PhoneNumberSid properties: PhoneNumberSid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ description: The SID of the Phone Number being added to the Service. UpdateChannelRequest: type: object properties: FriendlyName: type: string description: '' UniqueName: type: string description: '' Attributes: type: string description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' CreatedBy: type: string description: '' CreateUserRequest: type: object required: - Identity properties: Identity: type: string description: '' RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' Attributes: type: string description: '' FriendlyName: type: string description: '' sync.v1.service.sync_stream.stream_message: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^TZ[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Stream Message resource. data: nullable: true description: An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length. x-twilio: pii: handling: sensitive deleteSla: 0 log_enum_level: type: string enum: - info - warn - error serverless.v1.service.environment.log: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Log resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Log resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Log resource is associated with. environment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true description: The SID of the environment in which the log occurred. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true description: The SID of the build that corresponds to the log. deployment_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZD[0-9a-fA-F]{32}$ nullable: true description: The SID of the deployment that corresponds to the log. function_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZH[0-9a-fA-F]{32}$ nullable: true description: The SID of the function whose invocation produced the log. request_sid: type: string minLength: 34 maxLength: 34 pattern: ^RQ[0-9a-fA-F]{32}$ nullable: true description: The SID of the request associated with the log. level: type: string $ref: '#/components/schemas/log_enum_level' nullable: true description: 'The log level. Can be: `info`, `warn`, or `error`.' message: type: string nullable: true description: The log message. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Log resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Log resource. ListUserBindingResponse: type: object properties: bindings: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.user.user_binding' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string factor_enum_totp_algorithms: type: string enum: - sha1 - sha256 - sha512 UpdateServiceRequest: type: object properties: AutoTranscribe: type: boolean description: Instructs the Speech Recognition service to automatically transcribe all recordings made on the account. DataLogging: type: boolean description: 'Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to 64 characters. LanguageCode: type: string description: The default language code of the audio. UniqueName: type: string description: Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID. AutoRedaction: type: boolean description: Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service. MediaRedaction: type: boolean description: Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise. WebhookUrl: type: string description: The URL Twilio will request when executing the Webhook. WebhookHttpMethod: type: string $ref: '#/components/schemas/service_enum_http_method' description: The HTTP method for the Webhook. One of `GET` or `POST`. UpdateServiceUserConversationRequest: type: object properties: NotificationLevel: type: string $ref: '#/components/schemas/service_user_conversation_enum_notification_level' description: The Notification Level of this User Conversation. One of `default` or `muted`. LastReadTimestamp: type: string format: date-time description: The date of the last message read in conversation by the user, given in ISO 8601 format. LastReadMessageIndex: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. service_enum_scan_message_content: type: string enum: - inherit - enable - disable UpdateServiceConversationScopedWebhookRequest: type: object properties: Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: type: string $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_method' description: The HTTP method to be used when sending a webhook request. Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. CreateChallengeRequest: type: object required: - FactorSid properties: FactorSid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ description: The unique SID identifier of the Factor. ExpirationDate: type: string format: date-time description: The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation. Details.Message: type: string description: Shown to the user when the push notification arrives. Required when `factor_type` is `push`. Can be up to 256 characters in length Details.Fields: type: array items: {} description: A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when `factor_type` is `push`. There can be up to 20 details fields. HiddenDetails: description: 'Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in length' AuthPayload: type: string description: Optional payload used to verify the Challenge upon creation. Only used with a Factor of type `totp` to carry the TOTP code that needs to be verified. For `TOTP` this value must be between 3 and 8 characters long. ListRateLimitResponse: type: object properties: rate_limits: type: array items: $ref: '#/components/schemas/verify.v2.service.rate_limit' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string serverless.v1.service.build: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Build resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Build resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Build resource is associated with. status: type: string $ref: '#/components/schemas/build_enum_status' nullable: true description: 'The status of the Build. Can be: `building`, `completed`, or `failed`.' asset_versions: type: array items: {} nullable: true description: The list of Asset Version resource SIDs that are included in the Build. function_versions: type: array items: {} nullable: true description: The list of Function Version resource SIDs that are included in the Build. dependencies: type: array items: {} nullable: true description: A list of objects that describe the Dependencies included in the Build. Each object contains the `name` and `version` of the dependency. runtime: type: string $ref: '#/components/schemas/build_enum_runtime' nullable: true description: The Runtime version that will be used to run the Build resource when it is deployed. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Build resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Build resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Build resource. links: type: object format: uri-map nullable: true UpdateServiceRoleRequest: type: object required: - Permission properties: Permission: type: array items: type: string 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`. binding_enum_binding_type_2: type: string enum: - apn - gcm - sms - fcm - facebook-messenger - alexa user_binding_enum_binding_type: type: string enum: - gcm - apn - fcm UpdateFunctionRequest: type: object required: - FriendlyName properties: FriendlyName: type: string description: A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters. session_enum_status: type: string enum: - open - in-progress - closed - failed - unknown sync.v1.service.sync_list: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ES[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Sync List resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. url: type: string format: uri nullable: true description: The absolute URL of the Sync List resource. links: type: object format: uri-map nullable: true description: The URLs of the Sync List's nested resources. revision: type: string nullable: true description: The current revision of the Sync List, represented as a string. date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the Sync List expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync List does not expire, this value is `null`. The Sync List might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`. x-twilio: pii: handling: standard deleteSla: 30 CreateVerificationRequest: type: object required: - To - Channel properties: To: type: string description: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). Channel: type: string description: 'The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.' CustomFriendlyName: type: string description: A custom user defined friendly name that overwrites the existing one in the verification message CustomMessage: type: string description: The text of a custom message to use for the verification. SendDigits: type: string description: The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits). Locale: type: string description: Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See supported languages and more information here](https://www.twilio.com/docs/verify/supported-languages). CustomCode: type: string description: A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive. Amount: type: string description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. Payee: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. RateLimits: description: The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request. ChannelConfiguration: description: '[`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields ''from'' and ''from_name'' are optional but if included the ''from'' field must have a valid email address.' AppHash: type: string description: 'Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.' TemplateSid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ description: The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only. TemplateCustomSubstitutions: type: string description: A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions. DeviceIp: type: string description: Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address. RiskCheck: type: string $ref: '#/components/schemas/verification_enum_risk_check' description: 'Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: `enable`(default) or `disable`. For SMS channel only.' Tags: type: string description: A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. UpdateVariableRequest: type: object properties: Key: type: string description: A string by which the Variable resource can be referenced. It can be a maximum of 128 characters. Value: type: string description: A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size. ListSyncListPermissionResponse: type: object properties: permissions: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_list.sync_list_permission' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateSyncStreamRequest: type: object properties: Ttl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). CreateChannelRequest: type: object properties: FriendlyName: type: string description: '' UniqueName: type: string description: '' Attributes: type: string description: '' Type: type: string $ref: '#/components/schemas/channel_enum_channel_type' description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' CreatedBy: type: string description: '' UpdateFactorRequest: type: object properties: AuthPayload: type: string description: The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code. FriendlyName: type: string description: The new friendly name of this Factor. It can be up to 64 characters. Config.NotificationToken: type: string description: For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when `factor_type` is `push`. If specified, this value must be between 32 and 255 characters long. Config.SdkVersion: type: string description: The Verify Push SDK version used to configure the factor Config.TimeStep: type: integer description: Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive Config.Skew: type: integer description: The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive Config.CodeLength: type: integer description: Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive Config.Alg: type: string $ref: '#/components/schemas/factor_enum_totp_algorithms' description: The algorithm used to derive the TOTP codes. Can be `sha1`, `sha256` or `sha512` Config.NotificationPlatform: type: string description: 'The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`. Required when `factor_type` is `push`.' CreateSyncListItemRequest: type: object required: - Data properties: Data: description: A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. Ttl: type: integer description: An alias for `item_ttl`. If both parameters are provided, this value is ignored. ItemTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. ListMemberResponse: type: object properties: members: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.channel.member' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ip_messaging.v2.service.channel: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true unique_name: type: string nullable: true attributes: type: string nullable: true type: type: string $ref: '#/components/schemas/channel_enum_channel_type' nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true created_by: type: string nullable: true members_count: type: integer nullable: true messages_count: type: integer nullable: true url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true ip_messaging.v2.service.user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true attributes: type: string nullable: true friendly_name: type: string nullable: true role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true identity: type: string nullable: true is_online: type: boolean nullable: true is_notifiable: type: boolean nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true joined_channels_count: type: integer nullable: true links: type: object format: uri-map nullable: true url: type: string format: uri nullable: true UpdateMessagingConfigurationRequest: type: object required: - MessagingServiceSid properties: MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. UpdateMemberRequest: type: object properties: RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' LastConsumedMessageIndex: type: integer nullable: true description: '' LastConsumptionTimestamp: type: string format: date-time description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' Attributes: type: string description: '' conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. message_sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to sid: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. channel_message_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: 'A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ' participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the participant the delivery receipt belongs to. status: type: string $ref: '#/components/schemas/service_conversation_message_receipt_enum_delivery_status' nullable: true description: The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null. error_code: type: integer nullable: true description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the delivery receipt has not been updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this delivery receipt. UpdateSyncListPermissionRequest: type: object required: - Read - Write - Manage properties: Read: type: boolean description: Whether the identity can read the Sync List and its Items. Default value is `false`. Write: type: boolean description: Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`. Manage: type: boolean description: Whether the identity can delete the Sync List. Default value is `false`. service_user_conversation_enum_state: type: string enum: - inactive - active - closed ListAssetVersionResponse: type: object properties: asset_versions: type: array items: $ref: '#/components/schemas/serverless.v1.service.asset.asset_version' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string service_conversation_message_receipt_enum_delivery_status: type: string enum: - read - failed - delivered - undelivered - sent CreateAssetRequest: type: object required: - FriendlyName properties: FriendlyName: type: string description: A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters. CreateUsAppToPersonRequest: type: object required: - BrandRegistrationSid - Description - MessageFlow - MessageSamples - UsAppToPersonUsecase - HasEmbeddedLinks - HasEmbeddedPhone properties: BrandRegistrationSid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ description: A2P Brand Registration SID Description: type: string description: 'A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.' MessageFlow: type: string description: Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum. MessageSamples: type: array items: type: string description: 'An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.' UsAppToPersonUsecase: type: string description: 'A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]' HasEmbeddedLinks: type: boolean description: Indicates that this SMS campaign will send messages that contain links. HasEmbeddedPhone: type: boolean description: Indicates that this SMS campaign will send messages that contain phone numbers. OptInMessage: type: string description: If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum. OptOutMessage: type: string description: Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. HelpMessage: type: string description: When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum. OptInKeywords: type: array items: type: string description: If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum. OptOutKeywords: type: array items: type: string description: End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. HelpKeywords: type: array items: type: string description: End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. verify.v2.service.webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Webhook resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the webhook. **This value should not contain PII.** event_types: type: array items: type: string nullable: true description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' status: type: string $ref: '#/components/schemas/webhook_enum_status' nullable: true description: 'The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`' version: type: string $ref: '#/components/schemas/webhook_enum_version' nullable: true description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. webhook_url: type: string format: uri nullable: true description: The URL associated with this Webhook. webhook_method: type: string $ref: '#/components/schemas/webhook_enum_methods' nullable: true description: The method to be used when calling the webhook's URL. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Webhook resource. ip_messaging.v2.service.channel.invite: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IN[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true identity: type: string nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true created_by: type: string nullable: true url: type: string format: uri nullable: true challenge_enum_challenge_reasons: type: string enum: - none - not_needed - not_requested CreateAccessTokenRequest: type: object required: - Identity - FactorType properties: Identity: type: string description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID. FactorType: type: string $ref: '#/components/schemas/access_token_enum_factor_types' description: The Type of this Factor. Eg. `push` FactorFriendlyName: type: string description: The friendly name of the factor that is going to be created with this access token Ttl: type: integer description: How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60. messaging.v1.service.channel_sender: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ChannelSender resource. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/messaging/services) the resource is associated with. sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ChannelSender resource. sender: type: string nullable: true description: The unique string that identifies the sender e.g whatsapp:+123456XXXX. sender_type: type: string nullable: true description: A string value that identifies the sender type e.g WhatsApp, Messenger. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the ChannelSender resource. verify.v2.service.entity.new_factor: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 binding: nullable: true description: 'Contains the `factor_type` specific secret and metadata. For push, this is `binding.public_key` and `binding.alg`. For totp, this is `binding.secret` and `binding.uri`. The `binding.uri` property is generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format), and `Factor.friendly_name` is used for the “accountname” value and `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer` value. The Binding property is ONLY returned upon Factor creation.' date_created: type: string format: date-time nullable: true description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. friendly_name: type: string nullable: true description: 'The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For `factor_type` `push`, this could be a device name. For `factor_type` `totp`, this value is used as the “account name” in constructing the `binding.uri` property. At the same time, we recommend avoiding providing PII.' status: type: string $ref: '#/components/schemas/new_factor_enum_factor_statuses' nullable: true description: The Status of this Factor. One of `unverified` or `verified`. factor_type: type: string $ref: '#/components/schemas/new_factor_enum_factor_types' nullable: true description: The Type of this Factor. Currently `push` and `totp` are supported. config: nullable: true description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true description: The URL of this resource. ip_messaging.v2.service.channel.message: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true attributes: type: string nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true to: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true last_updated_by: type: string nullable: true was_edited: type: boolean nullable: true from: type: string nullable: true body: type: string nullable: true index: type: integer nullable: true type: type: string nullable: true media: nullable: true url: type: string format: uri nullable: true access_token_enum_factor_types: type: string enum: - push CreateParticipantRequest: type: object required: - Identifier properties: Identifier: type: string description: The phone number of the Participant. FriendlyName: type: string description: The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.** ProxyIdentifier: type: string description: The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool. ProxyIdentifierSid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ description: The SID of the Proxy Identifier to assign to the Participant. ListChannelResponse: type: object properties: channels: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.channel' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string sync.v1.service.sync_map: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^MP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Sync Map resource. unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with. url: type: string format: uri nullable: true description: The absolute URL of the Sync Map resource. links: type: object format: uri-map nullable: true description: The URLs of the Sync Map's nested resources. revision: type: string nullable: true description: The current revision of the Sync Map, represented as a string. date_expires: type: string format: date-time nullable: true description: The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is `null`. The Sync Map might not be deleted immediately after it expires. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. created_by: type: string nullable: true description: The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`. x-twilio: pii: handling: standard deleteSla: 30 conversations.v1.service.service_user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user. identity: type: string nullable: true description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. x-twilio: pii: handling: sensitive deleteSla: 30 is_online: type: boolean nullable: true description: Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for this Conversations Service, even if the Service's `reachability_enabled` is `true`. is_notifiable: type: boolean nullable: true description: Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: An absolute API resource URL for this user. links: type: object format: uri-map nullable: true CreateBuildRequest: type: object properties: AssetVersions: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ description: The list of Asset Version resource SIDs to include in the Build. FunctionVersions: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^ZN[0-9a-fA-F]{32}$ description: The list of the Function Version resource SIDs to include in the Build. Dependencies: type: string description: A list of objects that describe the Dependencies included in the Build. Each object contains the `name` and `version` of the dependency. Runtime: type: string description: The Runtime version that will be used to run the Build resource when it is deployed. channel_enum_channel_type: type: string enum: - public - private CreateAlphaSenderRequest: type: object required: - AlphaSender properties: AlphaSender: type: string description: The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers. service_binding_enum_binding_type: type: string enum: - apn - gcm - fcm service_conversation_scoped_webhook_enum_target: type: string enum: - webhook - trigger - studio ListServiceBindingResponse: type: object properties: bindings: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_binding' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string serverless.v1.service.build.build_status: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Build resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Build resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Build resource is associated with. status: type: string $ref: '#/components/schemas/build_status_enum_status' nullable: true description: 'The status of the Build. Can be: `building`, `completed`, or `failed`.' url: type: string format: uri nullable: true description: The absolute URL of the Build Status resource. conversations.v1.service.service_participant_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). participant_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). participant_identity: type: string nullable: true description: A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. x-twilio: pii: handling: standard deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to. conversation_unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the Conversation resource. x-twilio: pii: handling: standard deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. x-twilio: pii: handling: sensitive deleteSla: 30 conversation_date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. conversation_date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. conversation_created_by: type: string nullable: true description: Identity of the creator of this Conversation. conversation_state: type: string $ref: '#/components/schemas/service_participant_conversation_enum_state' nullable: true description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. conversation_timers: nullable: true description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true description: Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation. ListServiceUserResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_user' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string service_conversation_enum_state: type: string enum: - inactive - active - closed channel_webhook_enum_method: type: string enum: - GET - POST ListVariableResponse: type: object properties: variables: type: array items: $ref: '#/components/schemas/serverless.v1.service.environment.variable' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateSyncListItemRequest: type: object properties: Data: description: A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. Ttl: type: integer description: An alias for `item_ttl`. If both parameters are provided, this value is ignored. ItemTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request. webhook_enum_version: type: string enum: - v1 - v2 sync_list_item_enum_query_result_order: type: string enum: - asc - desc CreateBindingRequest: type: object required: - Identity - BindingType - Address properties: Identity: type: string 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/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service. BindingType: type: string $ref: '#/components/schemas/binding_enum_binding_type_2' description: 'The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.' Address: type: string description: The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format. Tag: type: array items: type: string description: A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags. NotificationProtocolVersion: type: string description: The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). The current version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed. CredentialSid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only `apn`, `fcm`, and `gcm` type Bindings. Endpoint: type: string description: Deprecated. ip_messaging.v2.service.user.user_binding: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true endpoint: type: string nullable: true identity: type: string nullable: true user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true binding_type: type: string $ref: '#/components/schemas/user_binding_enum_binding_type' nullable: true message_types: type: array items: type: string nullable: true url: type: string format: uri nullable: true verify.v2.service.entity.factor: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. friendly_name: type: string nullable: true description: A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name. status: type: string $ref: '#/components/schemas/factor_enum_factor_statuses' nullable: true description: The Status of this Factor. One of `unverified` or `verified`. factor_type: type: string $ref: '#/components/schemas/factor_enum_factor_types' nullable: true description: The Type of this Factor. Currently `push` and `totp` are supported. config: nullable: true description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true description: The URL of this resource. ListEntityResponse: type: object properties: entities: type: array items: $ref: '#/components/schemas/verify.v2.service.entity' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string CreateEnvironmentRequest: type: object required: - UniqueName properties: UniqueName: type: string description: A user-defined string that uniquely identifies the Environment resource. It can be a maximum of 100 characters. DomainSuffix: type: string description: A URL-friendly name that represents the environment and forms part of the domain name. It can be a maximum of 16 characters. function_version_enum_visibility: type: string enum: - public - private - protected verify.v2.service.rate_limit.bucket: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Bucket. rate_limit_sid: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true description: The Twilio-provided string that uniquely identifies the Rate Limit resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource. max: type: integer nullable: true description: Maximum number of requests permitted in during the interval. interval: type: integer nullable: true description: Number of seconds that the rate limit will be enforced over. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. ListPhoneNumberResponse: type: object properties: phone_numbers: type: array items: $ref: '#/components/schemas/messaging.v1.service.phone_number' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string build_status_enum_status: type: string enum: - building - completed - failed CreateMessageRequest: type: object properties: From: type: string description: '' Attributes: type: string description: '' DateCreated: type: string format: date-time description: '' DateUpdated: type: string format: date-time description: '' LastUpdatedBy: type: string description: '' Body: type: string description: '' MediaSid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: '' CreateNotificationRequest: type: object properties: Body: type: string description: The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. Priority: type: string $ref: '#/components/schemas/notification_enum_priority' description: 'The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app''s battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property.' Ttl: type: integer description: How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property. Title: type: string description: The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices. Sound: type: string description: The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property. Action: type: string description: The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels. Data: description: The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels. Apn: description: The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. Gcm: description: The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref). Sms: description: 'The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.' FacebookMessenger: description: Deprecated. Fcm: description: The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel. Segment: type: array items: type: string description: The Segment resource is deprecated. Use the `tag` parameter, instead. Alexa: description: Deprecated. ToBinding: type: array items: type: string description: The destination address specified as a JSON string. Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers. DeliveryCallbackUrl: type: string description: URL to send webhooks. Identity: type: array items: type: string 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/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list. Tag: type: array items: type: string description: A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel. messaging.v1.service.short_code: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ShortCode resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. short_code: type: string nullable: true description: The [E.164](https://www.twilio.com/docs/glossary/what-e164) format of the short code. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `SMS` and `MMS`.' url: type: string format: uri nullable: true description: The absolute URL of the ShortCode resource. service_conversation_participant_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' UpdateServiceUserRequest: type: object properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. ListServiceConversationMessageReceiptResponse: type: object properties: delivery_receipts: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string message_interaction_enum_type: type: string enum: - message - voice - unknown ListBindingResponse: type: object properties: bindings: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.binding' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateSyncMapItemRequest: type: object properties: Data: description: A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. Ttl: type: integer description: An alias for `item_ttl`. If both parameters are provided, this value is ignored. ItemTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted. CollectionTtl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. UpdateRoleRequest: type: object required: - Permission properties: Permission: type: array items: type: string description: '' ListServiceConversationResponse: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string serverless.v1.service.environment: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^ZE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Environment resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Environment resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Service that the Environment resource is associated with. build_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZB[0-9a-fA-F]{32}$ nullable: true description: The SID of the build deployed in the environment. unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Environment resource. x-twilio: pii: handling: standard deleteSla: 7 domain_suffix: type: string nullable: true description: A URL-friendly name that represents the environment and forms part of the domain name. x-twilio: pii: handling: standard deleteSla: 7 domain_name: type: string nullable: true description: The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix. x-twilio: pii: handling: standard deleteSla: 7 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Environment resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Environment resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Environment resource. links: type: object format: uri-map nullable: true description: The URLs of the Environment resource's nested resources. user_channel_enum_notification_level: type: string enum: - default - muted ListInteractionResponse: type: object properties: interactions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.interaction' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListSyncListResponse: type: object properties: lists: type: array items: $ref: '#/components/schemas/sync.v1.service.sync_list' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateServiceConversationRequest: type: object properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. Attributes: type: string description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. State: type: string $ref: '#/components/schemas/service_conversation_enum_state' description: Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active` Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. UniqueName: type: string 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. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. CreateNotificationRequest_2: type: object properties: Ttl: type: integer description: How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. ip_messaging.v2.service.user.user_channel: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true member_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true status: type: string $ref: '#/components/schemas/user_channel_enum_channel_status' nullable: true last_consumed_message_index: type: integer nullable: true unread_messages_count: type: integer nullable: true links: type: object format: uri-map nullable: true url: type: string format: uri nullable: true notification_level: type: string $ref: '#/components/schemas/user_channel_enum_notification_level' nullable: true factor_enum_factor_statuses: type: string enum: - unverified - verified CreateSyncStreamRequest: type: object properties: UniqueName: type: string description: An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource. Ttl: type: integer description: How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). webhook_enum_status: type: string enum: - enabled - disabled ListUserResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/ip_messaging.v2.service.user' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string channel_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.service.service_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. x-twilio: pii: handling: sensitive deleteSla: 30 state: type: string $ref: '#/components/schemas/service_conversation_enum_state' nullable: true description: Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active` date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. timers: nullable: true description: Timer date values representing state update for this conversation. url: type: string format: uri nullable: true description: An absolute API resource URL for this conversation. links: type: object format: uri-map nullable: true description: Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation. bindings: nullable: true notify.v1.service.binding: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Binding resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to `apn`, `fcm`, and `gcm` type Bindings. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. notification_protocol_version: type: string nullable: true description: The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` in the [Service](https://www.twilio.com/docs/notify/api/service-resource) for the protocol. The current version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed. endpoint: type: string nullable: true description: Deprecated. identity: type: string nullable: true description: The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service. x-twilio: pii: handling: standard deleteSla: 120 binding_type: type: string nullable: true description: 'The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.' address: type: string nullable: true description: The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format. x-twilio: pii: handling: sensitive deleteSla: 120 tags: type: array items: type: string nullable: true description: The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed. x-twilio: pii: handling: standard deleteSla: 120 url: type: string format: uri nullable: true description: The absolute URL of the Binding resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. parameters: ServiceSid: name: ServiceSid in: path required: true description: The SID of the Verify service schema: type: string pattern: ^VA[0-9a-fA-F]{32}$ securitySchemes: accountSid_authToken: type: http scheme: basic x-maturity: - name: GA description: This product is Generally Available. - name: Beta description: PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution.