components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: 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: $ref: '#/components/schemas/interaction_enum_type' 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: $ref: '#/components/schemas/interaction_enum_resource_status' 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: $ref: '#/components/schemas/interaction_enum_resource_status' 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. interaction_enum_type: type: string enum: - message - voice - unknown description: 'The Type of the Interaction. Can be: `message`, `voice` or `unknown`.' 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 description: The inbound resource status of the Interaction. Will always be `delivered` for messages and `in-progress` for calls. 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: $ref: '#/components/schemas/message_interaction_enum_type' 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: $ref: '#/components/schemas/message_interaction_enum_resource_status' 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: $ref: '#/components/schemas/message_interaction_enum_resource_status' 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. message_interaction_enum_type: type: string enum: - message - voice - unknown description: The Type of Message Interaction. This value is always `message`. 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 description: Always empty for created Message Interactions. 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. 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 x-class-extra-annotation: '@JsonInclude(JsonInclude.Include.NON_NULL)' nullable: true description: The capabilities of the phone number. properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean 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 default: 0 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. proxy.v1.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service resource. 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.** 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. chat_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship. callback_url: type: string format: uri nullable: true description: The URL we call when the interaction status changes. default_ttl: type: integer default: 0 description: The default `ttl` value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value. number_selection_behavior: $ref: '#/components/schemas/service_enum_number_selection_behavior' geo_match_level: $ref: '#/components/schemas/service_enum_geo_match_level' intercept_callback_url: type: string format: uri nullable: true description: The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues. out_of_session_callback_url: type: string format: uri nullable: true description: The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information. 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 Service resource. links: type: object format: uri-map nullable: true description: The URLs of resources related to the Service. service_enum_geo_match_level: type: string enum: - area-code - overlay - radius - country description: 'Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.' service_enum_number_selection_behavior: type: string enum: - avoid-sticky - prefer-sticky description: 'The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.' 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: $ref: '#/components/schemas/session_enum_status' closed_reason: type: string nullable: true description: The reason the Session ended. ttl: type: integer default: 0 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: $ref: '#/components/schemas/session_enum_mode' 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. session_enum_status: type: string enum: - open - in-progress - closed - failed - unknown description: 'The status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`.' session_enum_mode: type: string enum: - message-only - voice-only - voice-and-message description: 'The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message`.' info: title: Twilio - Proxy 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.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - type - data parent: /Services/{ServiceSid}/Sessions/{Sid} pathType: instance get: description: Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session). summary: Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session). tags: - ProxyV1Interaction 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' examples: fetch: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data: '{"body":"some message"}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' inbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa inbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa inbound_resource_status: sent inbound_resource_type: Message inbound_resource_url: null outbound_participant_sid: KPbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb outbound_resource_sid: SMbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb outbound_resource_status: sent outbound_resource_type: Message outbound_resource_url: null sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: message url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInteraction delete: description: Delete a specific Interaction. summary: Delete a specific Interaction. tags: - ProxyV1Interaction 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 /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - type - data parent: /Services/{ServiceSid}/Sessions/{Sid} pathType: list get: description: Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page. summary: Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page. tags: - ProxyV1Interaction 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 format: int64 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: type: object properties: interactions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.interaction' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInteractionResponse examples: readEmpty: value: interactions: [] meta: previous_page_url: null next_page_url: null url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 page: 0 first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0 page_size: 50 key: interactions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInteraction /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - type - data parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} pathType: list 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. summary: 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: - ProxyV1MessageInteraction 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: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' examples: create: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data: '{"body":"some message"}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa inbound_participant_sid: null inbound_resource_sid: null inbound_resource_status: null inbound_resource_type: null inbound_resource_url: null outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa outbound_resource_status: sent outbound_resource_type: Message outbound_resource_url: null sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: message url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: CreateMessageInteraction requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateMessageInteractionRequest properties: Body: type: string description: The message to send to the participant MediaUrl: type: array items: type: string format: uri x-twilio: ignoreFormat: true description: Reserved. Not currently supported. examples: create: value: Body: some message x-twilio: conditional: - - body - media_url get: description: '' summary: '' tags: - ProxyV1MessageInteraction 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 format: int64 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: type: object properties: interactions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.participant.message_interaction' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListMessageInteractionResponse examples: readEmpty: value: interactions: [] meta: previous_page_url: null next_page_url: null url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 page: 0 first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions?PageSize=50&Page=0 page_size: 50 key: interactions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListMessageInteraction /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - type - data parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid} pathType: instance get: description: '' summary: '' tags: - ProxyV1MessageInteraction 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' examples: fetch: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data: '{"body":"some message"}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa inbound_participant_sid: null inbound_resource_sid: null inbound_resource_status: null inbound_resource_type: null inbound_resource_url: null outbound_participant_sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa outbound_resource_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa outbound_resource_status: sent outbound_resource_type: Message outbound_resource_url: null sid: KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: message url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions/KIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchMessageInteraction /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier 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} pathType: instance get: description: Fetch a specific Participant. summary: Fetch a specific Participant. tags: - ProxyV1Participant 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' examples: fetch: value: sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identifier: '+14155551212' proxy_identifier: '+14155559999' proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name date_deleted: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions fetchChannel: value: sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identifier: messenger:14155551212 proxy_identifier: messenger:14155559999 proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: a facebook user date_deleted: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchParticipant 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. summary: 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: - ProxyV1Participant 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: '200': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteParticipant /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - identifier - proxy_identifier 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} pathType: list get: description: Retrieve a list of all Participants in a Session. summary: Retrieve a list of all Participants in a Session. tags: - ProxyV1Participant 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 format: int64 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: type: object properties: participants: type: array items: $ref: '#/components/schemas/proxy.v1.service.session.participant' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListParticipantResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 page: 0 first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 page_size: 50 key: participants participants: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListParticipant post: description: Add a new Participant to the Session summary: Add a new Participant to the Session tags: - ProxyV1Participant 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' examples: create: value: sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identifier: '+14155551212' proxy_identifier: '+14155559999' proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name date_deleted: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions createChannel: value: sid: KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa session_sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identifier: messenger:123456 proxy_identifier: messenger:987654532 proxy_identifier_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: a facebook user date_deleted: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: message_interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/KPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessageInteractions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateParticipantRequest 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. required: - Identifier examples: create: value: FriendlyName: friendly_name Identifier: '+14155551212' createChannel: value: FriendlyName: a facebook user Identifier: messenger:123456 ProxyIdentifier: messenger:987654532 /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number parent: /Services/{Sid} pathType: list post: description: Add a Phone Number to a Service's Proxy Number Pool. summary: Add a Phone Number to a Service's Proxy Number Pool. tags: - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID parent [Service](https://www.twilio.com/docs/proxy/api/service) resource of the new PhoneNumber 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.phone_number' examples: create: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' phone_number: '+1987654321' friendly_name: Friendly Name iso_country: US capabilities: sms_outbound: true voice_inbound: false url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa is_reserved: false in_use: 0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreatePhoneNumber requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePhoneNumberRequest properties: Sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ description: The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service. PhoneNumber: type: string format: phone-number description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. IsReserved: type: boolean description: Whether the new 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. examples: create: value: Sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page. summary: Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page. tags: - ProxyV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resources 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 format: int64 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: type: object properties: phone_numbers: type: array items: $ref: '#/components/schemas/proxy.v1.service.phone_number' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPhoneNumberResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: phone_numbers url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 phone_numbers: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' phone_number: '+1987654321' friendly_name: Friendly Name iso_country: US capabilities: sms_outbound: true voice_inbound: false url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa is_reserved: false in_use: 0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - phone_number parent: /Services/{Sid} pathType: instance delete: description: Delete a specific Phone Number from a Service. summary: Delete a specific Phone Number from a Service. tags: - ProxyV1PhoneNumber 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 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 PhoneNumber resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeletePhoneNumber get: description: Fetch a specific Phone Number. summary: Fetch a specific Phone Number. tags: - ProxyV1PhoneNumber 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 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 PhoneNumber resource to fetch. 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' examples: fetch: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' phone_number: '12345' friendly_name: Friendly Name iso_country: US capabilities: sms_outbound: true voice_inbound: false url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa is_reserved: false in_use: 0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber post: description: Update a specific Proxy Number. summary: Update a specific Proxy Number. tags: - ProxyV1PhoneNumber 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' examples: update: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' phone_number: '12345' friendly_name: Friendly Name iso_country: US capabilities: sms_outbound: true voice_inbound: false url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa is_reserved: true in_use: 0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdatePhoneNumber requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdatePhoneNumberRequest 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. examples: update: value: IsReserved: true /v1/Services/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created dependentProperties: sessions: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Sessions phone_numbers: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/PhoneNumbers pathType: instance get: description: Fetch a specific Service. summary: Fetch a specific Service. tags: - ProxyV1Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Service resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' examples: fetch: value: sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My Service default_ttl: 3600 callback_url: http://www.example.com geo_match_level: country number_selection_behavior: prefer-sticky intercept_callback_url: http://www.example.com out_of_session_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchService delete: description: Delete a specific Service. summary: Delete a specific Service. tags: - ProxyV1Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Service resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService post: description: Update a specific Service. summary: Update a specific Service. tags: - ProxyV1Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Service resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^KS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' examples: update: value: sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My Service default_ttl: 3600 callback_url: http://www.example.com geo_match_level: country number_selection_behavior: prefer-sticky intercept_callback_url: http://www.example.com out_of_session_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceRequest 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.** DefaultTtl: type: integer description: The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value. CallbackUrl: type: string format: uri description: The URL we should call when the interaction status changes. GeoMatchLevel: $ref: '#/components/schemas/service_enum_geo_match_level' NumberSelectionBehavior: $ref: '#/components/schemas/service_enum_number_selection_behavior' InterceptCallbackUrl: type: string format: uri description: The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues. OutOfSessionCallbackUrl: type: string format: uri description: The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information. ChatInstanceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship. examples: update: value: DefaultTtl: 3600 CallbackUrl: http://www.example.com UniqueName: My Service ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_created dependentProperties: sessions: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Sessions phone_numbers: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/PhoneNumbers pathType: list get: description: Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page. summary: Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page. tags: - ProxyV1Service 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 format: int64 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: type: object properties: services: type: array items: $ref: '#/components/schemas/proxy.v1.service' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListServiceResponse examples: readEmpty: value: services: [] meta: first_page_url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 key: services next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://proxy.twilio.com/v1/Services?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListService post: description: Create a new Service for Twilio Proxy summary: Create a new Service for Twilio Proxy tags: - ProxyV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/proxy.v1.service' examples: create: value: sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My Service default_ttl: 3600 callback_url: http://www.example.com geo_match_level: country number_selection_behavior: prefer-sticky intercept_callback_url: http://www.example.com out_of_session_callback_url: http://www.example.com date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: sessions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions phone_numbers: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceRequest 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.** DefaultTtl: type: integer description: The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value. CallbackUrl: type: string format: uri description: The URL we should call when the interaction status changes. GeoMatchLevel: $ref: '#/components/schemas/service_enum_geo_match_level' NumberSelectionBehavior: $ref: '#/components/schemas/service_enum_number_selection_behavior' InterceptCallbackUrl: type: string format: uri description: The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues. OutOfSessionCallbackUrl: type: string format: uri description: The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information. ChatInstanceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship. required: - UniqueName examples: create: value: DefaultTtl: 3600 CallbackUrl: http://www.example.com UniqueName: My Service ChatInstanceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/Services/{ServiceSid}/Sessions/{Sid}: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended 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} pathType: instance get: description: Fetch a specific Session. summary: Fetch a specific Session. tags: - ProxyV1Session 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' examples: fetch: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: open unique_name: 'Order #1234' date_started: '2015-07-30T20:00:00Z' date_ended: '2015-07-30T20:00:00Z' date_last_interaction: '2015-07-30T20:00:00Z' date_expiry: '2015-07-30T20:00:00Z' ttl: 3600 mode: voice-and-message closed_reason: '' sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSession delete: description: Delete a specific Session. summary: Delete a specific Session. tags: - ProxyV1Session 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 post: description: Update a specific Session. summary: Update a specific Session. tags: - ProxyV1Session 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' examples: update: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: in-progress unique_name: 'Order #1234' date_started: '2015-07-30T20:00:00Z' date_ended: '2015-07-30T20:00:00Z' date_last_interaction: '2015-07-30T20:00:00Z' date_expiry: '2015-07-30T20:00:00Z' ttl: 3600 mode: voice-and-message closed_reason: '' sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateSession requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateSessionRequest 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: $ref: '#/components/schemas/session_enum_status' examples: update: value: Ttl: 3600 Status: in-progress /v1/Services/{ServiceSid}/Sessions: servers: - url: https://proxy.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - date_started - date_ended 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} pathType: list get: description: Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page. summary: Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page. tags: - ProxyV1Session 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 format: int64 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: type: object properties: sessions: type: array items: $ref: '#/components/schemas/proxy.v1.service.session' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSessionResponse examples: readEmpty: value: sessions: [] meta: previous_page_url: null next_page_url: null url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 page: 0 first_page_url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions?PageSize=50&Page=0 page_size: 50 key: sessions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSession post: description: Create a new Session summary: Create a new Session tags: - ProxyV1Session 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' examples: create: value: service_sid: KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: open unique_name: 'Order #1234' date_started: '2015-07-30T20:00:00Z' date_ended: '2015-07-30T20:00:00Z' date_last_interaction: '2015-07-30T20:00:00Z' date_expiry: '2015-07-30T20:00:00Z' ttl: 3600 mode: voice-and-message closed_reason: '' sid: KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: interactions: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions participants: https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSession requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSessionRequest 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: $ref: '#/components/schemas/session_enum_mode' Status: $ref: '#/components/schemas/session_enum_status' Participants: type: array items: {} description: The Participant objects to include in the new session. examples: create: value: Ttl: 3600 UniqueName: 'Order #1234' servers: - url: https://proxy.twilio.com tags: - name: ProxyV1Index - name: ProxyV1Interaction - name: ProxyV1MessageInteraction - name: ProxyV1Participant - name: ProxyV1PhoneNumber - name: ProxyV1Service - name: ProxyV1Session - name: ProxyV1Version security: - accountSid_authToken: []