components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: ip_messaging.v1.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 default: 0 messages_count: type: integer default: 0 url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true channel_enum_channel_type: type: string enum: - public - private ip_messaging.v1.credential: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true type: type: string $ref: '#/components/schemas/credential_enum_push_service' nullable: true sandbox: 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 credential_enum_push_service: type: string enum: - gcm - apn - fcm ip_messaging.v1.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 ip_messaging.v1.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 ip_messaging.v1.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 was_edited: type: boolean nullable: true from: type: string nullable: true body: type: string nullable: true index: type: integer default: 0 url: type: string format: uri nullable: true message_enum_order_type: type: string enum: - asc - desc ip_messaging.v1.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 role_enum_role_type: type: string enum: - channel - deployment ip_messaging.v1.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true default_service_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true default_channel_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true default_channel_creator_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true read_status_enabled: type: boolean nullable: true reachability_enabled: type: boolean nullable: true typing_indicator_timeout: type: integer default: 0 consumption_report_interval: type: integer default: 0 limits: nullable: true webhooks: nullable: true pre_webhook_url: type: string nullable: true post_webhook_url: type: string nullable: true webhook_method: type: string nullable: true webhook_filters: type: array items: type: string nullable: true notifications: nullable: true url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true ip_messaging.v1.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 default: 0 links: type: object format: uri-map nullable: true url: type: string format: uri nullable: true ip_messaging.v1.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 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 user_channel_enum_channel_status: type: string enum: - joined - invited - not_participating info: title: Twilio - Ip_messaging 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}/Channels/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name dependentProperties: members: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members messages: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages invites: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1Channel 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.v1.service.channel' examples: fetch: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "foo": "bar" }' type: public date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:37Z' created_by: system members_count: 0 messages_count: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites last_message: null 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: FetchChannel delete: description: '' tags: - IpMessagingV1Channel 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: DeleteChannel post: description: '' tags: - IpMessagingV1Channel 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.v1.service.channel' examples: update: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "foo": "bar" }' type: public date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:37Z' created_by: system members_count: 0 messages_count: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites last_message: null 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: UpdateChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateChannelRequest properties: FriendlyName: type: string description: '' UniqueName: type: string description: '' Attributes: type: string description: '' examples: update: value: Type: channel FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "foo": "bar" }' /v1/Services/{ServiceSid}/Channels: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name dependentProperties: members: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Members messages: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Messages invites: mapping: service_sid: service_sid channel_sid: sid resource_url: /v1/Services/{service_sid}/Channels/{channel_sid}/Invites parent: /Services/{Sid} pathType: list post: description: '' tags: - IpMessagingV1Channel 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.v1.service.channel' examples: create: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "foo": "bar" }' type: public date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:37Z' created_by: system members_count: 0 messages_count: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites last_message: null 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: CreateChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateChannelRequest properties: FriendlyName: type: string description: '' UniqueName: type: string description: '' Attributes: type: string description: '' Type: type: string $ref: '#/components/schemas/channel_enum_channel_type' description: '' examples: create: value: Type: public FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "foo": "bar" }' get: description: '' tags: - IpMessagingV1Channel 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: type: object properties: channels: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.channel' 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: ListChannelResponse examples: readFull: value: channels: - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "foo": "bar" }' type: public date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:37Z' created_by: system members_count: 0 messages_count: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: members: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members messages: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages invites: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites last_message: null meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 next_page_url: null key: channels readEmpty: value: channels: [] meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 next_page_url: null key: channels 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: ListChannel /v1/Credentials: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list get: description: '' tags: - IpMessagingV1Credential 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: type: object properties: credentials: type: array items: $ref: '#/components/schemas/ip_messaging.v1.credential' 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: ListCredentialResponse examples: readFull: value: credentials: - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 next_page_url: null key: credentials readEmpty: value: credentials: [] meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Credentials?PageSize=50&Page=0 next_page_url: null key: credentials 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: ListCredential post: description: '' tags: - IpMessagingV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' examples: create: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateCredential requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCredentialRequest properties: Type: type: string $ref: '#/components/schemas/credential_enum_push_service' description: '' FriendlyName: type: string description: '' Certificate: type: string description: '' PrivateKey: type: string description: '' Sandbox: type: boolean description: '' ApiKey: type: string description: '' Secret: type: string description: '' required: - Type examples: create: value: Type: apn /v1/Credentials/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance get: description: '' tags: - IpMessagingV1Credential parameters: - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' examples: fetch: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchCredential post: description: '' tags: - IpMessagingV1Credential parameters: - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.credential' examples: update: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://ip-messaging.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: UpdateCredential requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateCredentialRequest properties: FriendlyName: type: string description: '' Certificate: type: string description: '' PrivateKey: type: string description: '' Sandbox: type: boolean description: '' ApiKey: type: string description: '' Secret: type: string description: '' examples: update: value: FriendlyName: Test slow create delete: description: '' tags: - IpMessagingV1Credential parameters: - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCredential /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1Invite 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.v1.service.channel.invite' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' identity: identity role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchInvite delete: description: '' tags: - IpMessagingV1Invite 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 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: list post: description: '' tags: - IpMessagingV1Invite 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.v1.service.channel.invite' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' identity: identity role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateInvite requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInviteRequest properties: Identity: type: string description: '' RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' required: - Identity examples: create: value: Identity: identity RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' tags: - IpMessagingV1Invite 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 examples: readEmpty: value: - identity readFull: value: - identity - 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: type: object properties: invites: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.invite' 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: ListInviteResponse examples: readEmpty: value: invites: [] meta: first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 key: invites next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 readFull: value: invites: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa created_by: created_by date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' identity: identity role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&PageSize=50&Page=0 key: invites next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?Identity=identity&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: ListInvite /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1Member 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: ^MB[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' examples: fetch: value: sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_consumed_message_index: null last_consumption_timestamp: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchMember delete: description: '' tags: - IpMessagingV1Member 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: ^MB[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMember post: description: '' tags: - IpMessagingV1Member 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: ^MB[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' examples: updateRoleSid: value: sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_consumed_message_index: null last_consumption_timestamp: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa updateLastConsumedMessageIndex: value: sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_consumed_message_index: 666 last_consumption_timestamp: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: UpdateMember requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateMemberRequest properties: RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' LastConsumedMessageIndex: type: integer nullable: true description: '' examples: updateRoleSid: value: RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa updateLastConsumedMessageIndex: value: LastConsumedMessageIndex: 666 /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: list post: description: '' tags: - IpMessagingV1Member 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.v1.service.channel.member' examples: create: value: sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_consumed_message_index: null last_consumption_timestamp: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateMember requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateMemberRequest properties: Identity: type: string description: '' RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' required: - Identity examples: create: value: Identity: Twilio get: description: '' tags: - IpMessagingV1Member 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: type: object properties: members: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.member' 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: ListMemberResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 next_page_url: null key: members members: - sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_consumed_message_index: null last_consumption_timestamp: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0 next_page_url: null key: members members: [] 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: ListMember /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1Message 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 minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ 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.v1.service.channel.message' examples: fetch: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' was_edited: false from: system attributes: '{}' body: Hello index: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchMessage delete: description: '' tags: - IpMessagingV1Message 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 minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMessage post: description: '' tags: - IpMessagingV1Message 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 minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ 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.v1.service.channel.message' examples: update: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{"test": "test"}' date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' was_edited: false from: system body: Hello index: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: UpdateMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateMessageRequest properties: Body: type: string description: '' Attributes: type: string description: '' examples: update: value: Body: Hello /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - from - to - date_created parent: /Services/{ServiceSid}/Channels/{Sid} pathType: list post: description: '' tags: - IpMessagingV1Message 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 minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' examples: create: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: null date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' was_edited: false from: system body: Hello index: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithAttributes: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' was_edited: false from: system attributes: '{}' body: Hello index: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateMessageRequest properties: Body: type: string description: '' From: type: string description: '' Attributes: type: string description: '' required: - Body examples: create: value: Body: Hello createWithAttributes: value: Body: Hello Attributes: '{"test": "test"}' get: description: '' tags: - IpMessagingV1Message 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 minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ 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: type: object properties: messages: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.channel.message' 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: ListMessageResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 next_page_url: null key: messages messages: - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' was_edited: false from: system attributes: '{}' body: Hello index: 0 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 next_page_url: null key: messages messages: [] 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: ListMessage /v1/Services/{ServiceSid}/Roles/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type parent: /Services/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1Role 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.v1.service.role' examples: fetch: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: channel user type: channel permissions: - sendMessage - leaveChannel - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchRole delete: description: '' tags: - IpMessagingV1Role 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 post: description: '' tags: - IpMessagingV1Role 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.v1.service.role' examples: update: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: channel user type: channel permissions: - sendMessage - leaveChannel - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: UpdateRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateRoleRequest properties: Permission: type: array items: type: string description: '' required: - Permission examples: update: value: Permission: sendMessage /v1/Services/{ServiceSid}/Roles: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - type parent: /Services/{Sid} pathType: list post: description: '' tags: - IpMessagingV1Role 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.v1.service.role' examples: create: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: channel user type: channel permissions: - sendMessage - leaveChannel - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateRoleRequest properties: FriendlyName: type: string description: '' Type: type: string $ref: '#/components/schemas/role_enum_role_type' description: '' Permission: type: array items: type: string description: '' required: - FriendlyName - Type - Permission examples: create: value: FriendlyName: friendly_name Type: channel Permission: sendMessage get: description: '' tags: - IpMessagingV1Role 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: type: object properties: roles: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.role' 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: ListRoleResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: channel user type: channel permissions: - sendMessage - leaveChannel - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: [] 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: ListRole /v1/Services/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: channels: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Channels roles: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Roles users: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Users pathType: instance get: description: '' tags: - IpMessagingV1Service parameters: - name: Sid in: path description: '' 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/ip_messaging.v1.service' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa consumption_report_interval: 100 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name limits: channel_members: 100 user_channels: 250 links: channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles notifications: {} post_webhook_url: post_webhook_url pre_webhook_url: pre_webhook_url reachability_enabled: false read_status_enabled: false sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa typing_indicator_timeout: 100 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_filters: - webhook_filters webhook_method: webhook_method webhooks: {} 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: '' tags: - IpMessagingV1Service parameters: - name: Sid in: path description: '' 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 post: description: '' tags: - IpMessagingV1Service parameters: - name: Sid in: path description: '' 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/ip_messaging.v1.service' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa consumption_report_interval: 100 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name limits: channel_members: 500 user_channels: 600 links: channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles notifications: added_to_channel: enabled: false template: notifications.added_to_channel.template invited_to_channel: enabled: false template: notifications.invited_to_channel.template new_message: enabled: false template: notifications.new_message.template removed_from_channel: enabled: false template: notifications.removed_from_channel.template post_webhook_url: post_webhook_url pre_webhook_url: pre_webhook_url reachability_enabled: false read_status_enabled: false sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa typing_indicator_timeout: 100 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_filters: - webhook_filters webhook_method: webhook_method webhooks: on_channel_add: format: webhooks.on_channel_add.format method: webhooks.on_channel_add.method url: webhooks.on_channel_add.url on_channel_added: format: webhooks.on_channel_added.format method: webhooks.on_channel_added.method url: webhooks.on_channel_added.url on_channel_destroy: format: webhooks.on_channel_destroy.format method: webhooks.on_channel_destroy.method url: webhooks.on_channel_destroy.url on_channel_destroyed: format: webhooks.on_channel_destroyed.format method: webhooks.on_channel_destroyed.method url: webhooks.on_channel_destroyed.url on_channel_update: format: webhooks.on_channel_update.format method: webhooks.on_channel_update.method url: webhooks.on_channel_update.url on_channel_updated: format: webhooks.on_channel_updated.format method: webhooks.on_channel_updated.method url: webhooks.on_channel_updated.url on_member_add: format: webhooks.on_member_add.format method: webhooks.on_member_add.method url: webhooks.on_member_add.url on_member_added: format: webhooks.on_member_added.format method: webhooks.on_member_added.method url: webhooks.on_member_added.url on_member_remove: format: webhooks.on_member_remove.format method: webhooks.on_member_remove.method url: webhooks.on_member_remove.url on_member_removed: format: webhooks.on_member_removed.format method: webhooks.on_member_removed.method url: webhooks.on_member_removed.url on_message_remove: format: webhooks.on_message_remove.format method: webhooks.on_message_remove.method url: webhooks.on_message_remove.url on_message_removed: format: webhooks.on_message_removed.format method: webhooks.on_message_removed.method url: webhooks.on_message_removed.url on_message_send: format: webhooks.on_message_send.format method: webhooks.on_message_send.method url: webhooks.on_message_send.url on_message_sent: format: webhooks.on_message_sent.format method: webhooks.on_message_sent.method url: webhooks.on_message_sent.url on_message_update: format: webhooks.on_message_update.format method: webhooks.on_message_update.method url: webhooks.on_message_update.url on_message_updated: format: webhooks.on_message_updated.format method: webhooks.on_message_updated.method url: webhooks.on_message_updated.url 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: FriendlyName: type: string description: '' DefaultServiceRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' DefaultChannelRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' DefaultChannelCreatorRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' ReadStatusEnabled: type: boolean description: '' ReachabilityEnabled: type: boolean description: '' TypingIndicatorTimeout: type: integer description: '' ConsumptionReportInterval: type: integer description: '' Notifications.NewMessage.Enabled: type: boolean description: '' Notifications.NewMessage.Template: type: string description: '' Notifications.AddedToChannel.Enabled: type: boolean description: '' Notifications.AddedToChannel.Template: type: string description: '' Notifications.RemovedFromChannel.Enabled: type: boolean description: '' Notifications.RemovedFromChannel.Template: type: string description: '' Notifications.InvitedToChannel.Enabled: type: boolean description: '' Notifications.InvitedToChannel.Template: type: string description: '' PreWebhookUrl: type: string format: uri description: '' PostWebhookUrl: type: string format: uri description: '' WebhookMethod: type: string format: http-method enum: - GET - POST description: '' WebhookFilters: type: array items: type: string description: '' Webhooks.OnMessageSend.Url: type: string format: uri description: '' Webhooks.OnMessageSend.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMessageUpdate.Url: type: string format: uri description: '' Webhooks.OnMessageUpdate.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMessageRemove.Url: type: string format: uri description: '' Webhooks.OnMessageRemove.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelAdd.Url: type: string format: uri description: '' Webhooks.OnChannelAdd.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelDestroy.Url: type: string format: uri description: '' Webhooks.OnChannelDestroy.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelUpdate.Url: type: string format: uri description: '' Webhooks.OnChannelUpdate.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMemberAdd.Url: type: string format: uri description: '' Webhooks.OnMemberAdd.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMemberRemove.Url: type: string format: uri description: '' Webhooks.OnMemberRemove.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMessageSent.Url: type: string format: uri description: '' Webhooks.OnMessageSent.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMessageUpdated.Url: type: string format: uri description: '' Webhooks.OnMessageUpdated.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMessageRemoved.Url: type: string format: uri description: '' Webhooks.OnMessageRemoved.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelAdded.Url: type: string format: uri description: '' Webhooks.OnChannelAdded.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelDestroyed.Url: type: string format: uri description: '' Webhooks.OnChannelDestroyed.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnChannelUpdated.Url: type: string format: uri description: '' Webhooks.OnChannelUpdated.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMemberAdded.Url: type: string format: uri description: '' Webhooks.OnMemberAdded.Method: type: string format: http-method enum: - GET - POST description: '' Webhooks.OnMemberRemoved.Url: type: string format: uri description: '' Webhooks.OnMemberRemoved.Method: type: string format: http-method enum: - GET - POST description: '' Limits.ChannelMembers: type: integer description: '' Limits.UserChannels: type: integer description: '' examples: update: value: ConsumptionReportInterval: 100 DefaultChannelCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultChannelRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa FriendlyName: friendly_name Notifications.AddedToChannel.Enabled: false Notifications.AddedToChannel.Template: notifications.added_to_channel.template Notifications.InvitedToChannel.Enabled: false Notifications.InvitedToChannel.Template: notifications.invited_to_channel.template Notifications.NewMessage.Enabled: false Notifications.NewMessage.Template: notifications.new_message.template Notifications.RemovedFromChannel.Enabled: false Notifications.RemovedFromChannel.Template: notifications.removed_from_channel.template Limits.ChannelMembers: 600 Limits.UserChannels: 500 PostWebhookUrl: post_webhook_url PreWebhookUrl: pre_webhook_url ReachabilityEnabled: false ReadStatusEnabled: false TypingIndicatorTimeout: 100 WebhookFilters: - webhook_filters WebhookMethod: webhook_method Webhooks.OnChannelAdd.Format: webhooks.on_channel_add.format Webhooks.OnChannelAdd.Method: webhooks.on_channel_add.method Webhooks.OnChannelAdd.Url: webhooks.on_channel_add.url Webhooks.OnChannelAdded.Format: webhooks.on_channel_added.format Webhooks.OnChannelAdded.Method: webhooks.on_channel_added.method Webhooks.OnChannelAdded.Url: webhooks.on_channel_added.url Webhooks.OnChannelDestroy.Format: webhooks.on_channel_destroy.format Webhooks.OnChannelDestroy.Method: webhooks.on_channel_destroy.method Webhooks.OnChannelDestroy.Url: webhooks.on_channel_destroy.url Webhooks.OnChannelDestroyed.Format: webhooks.on_channel_destroyed.format Webhooks.OnChannelDestroyed.Method: webhooks.on_channel_destroyed.method Webhooks.OnChannelDestroyed.Url: webhooks.on_channel_destroyed.url Webhooks.OnChannelUpdate.Format: webhooks.on_channel_update.format Webhooks.OnChannelUpdate.Method: webhooks.on_channel_update.method Webhooks.OnChannelUpdate.Url: webhooks.on_channel_update.url Webhooks.OnChannelUpdated.Format: webhooks.on_channel_updated.format Webhooks.OnChannelUpdated.Method: webhooks.on_channel_updated.method Webhooks.OnChannelUpdated.Url: webhooks.on_channel_updated.url Webhooks.OnMemberAdd.Format: webhooks.on_member_add.format Webhooks.OnMemberAdd.Method: webhooks.on_member_add.method Webhooks.OnMemberAdd.Url: webhooks.on_member_add.url Webhooks.OnMemberAdded.Format: webhooks.on_member_added.format Webhooks.OnMemberAdded.Method: webhooks.on_member_added.method Webhooks.OnMemberAdded.Url: webhooks.on_member_added.url Webhooks.OnMemberRemove.Format: webhooks.on_member_remove.format Webhooks.OnMemberRemove.Method: webhooks.on_member_remove.method Webhooks.OnMemberRemove.Url: webhooks.on_member_remove.url Webhooks.OnMemberRemoved.Format: webhooks.on_member_removed.format Webhooks.OnMemberRemoved.Method: webhooks.on_member_removed.method Webhooks.OnMemberRemoved.Url: webhooks.on_member_removed.url Webhooks.OnMessageRemove.Format: webhooks.on_message_remove.format Webhooks.OnMessageRemove.Method: webhooks.on_message_remove.method Webhooks.OnMessageRemove.Url: webhooks.on_message_remove.url Webhooks.OnMessageRemoved.Format: webhooks.on_message_removed.format Webhooks.OnMessageRemoved.Method: webhooks.on_message_removed.method Webhooks.OnMessageRemoved.Url: webhooks.on_message_removed.url Webhooks.OnMessageSend.Format: webhooks.on_message_send.format Webhooks.OnMessageSend.Method: webhooks.on_message_send.method Webhooks.OnMessageSend.Url: webhooks.on_message_send.url Webhooks.OnMessageSent.Format: webhooks.on_message_sent.format Webhooks.OnMessageSent.Method: webhooks.on_message_sent.method Webhooks.OnMessageSent.Url: webhooks.on_message_sent.url Webhooks.OnMessageUpdate.Format: webhooks.on_message_update.format Webhooks.OnMessageUpdate.Method: webhooks.on_message_update.method Webhooks.OnMessageUpdate.Url: webhooks.on_message_update.url Webhooks.OnMessageUpdated.Format: webhooks.on_message_updated.format Webhooks.OnMessageUpdated.Method: webhooks.on_message_updated.method Webhooks.OnMessageUpdated.Url: webhooks.on_message_updated.url /v1/Services: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: channels: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Channels roles: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Roles users: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/Users pathType: list post: description: '' tags: - IpMessagingV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/ip_messaging.v1.service' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa consumption_report_interval: 100 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name limits: channel_members: 100 user_channels: 250 links: channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles notifications: {} post_webhook_url: post_webhook_url pre_webhook_url: pre_webhook_url reachability_enabled: false read_status_enabled: false sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa typing_indicator_timeout: 100 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_filters: - webhook_filters webhook_method: webhook_method webhooks: {} 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: FriendlyName: type: string description: '' required: - FriendlyName examples: create: value: FriendlyName: friendly_name get: description: '' tags: - IpMessagingV1Service 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: type: object properties: services: type: array items: $ref: '#/components/schemas/ip_messaging.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: meta: first_page_url: https://ip-messaging.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://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 services: [] readFull: value: meta: first_page_url: https://ip-messaging.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://ip-messaging.twilio.com/v1/Services?PageSize=50&Page=0 services: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa consumption_report_interval: 100 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' default_channel_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_channel_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name limits: channel_members: 100 user_channels: 250 links: channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels users: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles notifications: {} post_webhook_url: post_webhook_url pre_webhook_url: pre_webhook_url reachability_enabled: false read_status_enabled: false sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa typing_indicator_timeout: 100 url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_filters: - webhook_filters webhook_method: webhook_method webhooks: {} 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 /v1/Services/{ServiceSid}/Users/{Sid}: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: user_channels: mapping: service_sid: service_sid user_sid: sid resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} pathType: instance get: description: '' tags: - IpMessagingV1User 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.v1.service.user' examples: fetch: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing attributes: null is_online: true is_notifiable: null friendly_name: null joined_channels_count: 0 date_created: '2016-03-24T21:05:19Z' date_updated: '2016-03-24T21:05:19Z' links: user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: FetchUser delete: description: '' tags: - IpMessagingV1User 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 post: description: '' tags: - IpMessagingV1User 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.v1.service.user' examples: update: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing attributes: null is_online: true is_notifiable: null friendly_name: null joined_channels_count: 0 date_created: '2016-03-24T21:05:19Z' date_updated: '2016-03-24T21:05:19Z' links: user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: UpdateUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateUserRequest properties: RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: '' Attributes: type: string description: '' FriendlyName: type: string description: '' examples: update: value: RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Attributes: '{"test":"test"}' FriendlyName: friendly_name /v1/Services/{ServiceSid}/Users: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: user_channels: mapping: service_sid: service_sid user_sid: sid resource_url: /v1/Services/{service_sid}/Users/{user_sid}/Channels parent: /Services/{Sid} pathType: list post: description: '' tags: - IpMessagingV1User 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.v1.service.user' examples: create: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing attributes: null is_online: true is_notifiable: null friendly_name: null joined_channels_count: 0 date_created: '2016-03-24T21:05:19Z' date_updated: '2016-03-24T21:05:19Z' links: user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa 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: CreateUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateUserRequest 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: '' required: - Identity examples: create: value: Identity: jing RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Attributes: '{"test":"test"}' FriendlyName: friendly_name get: description: '' tags: - IpMessagingV1User 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: type: object properties: users: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.user' 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: ListUserResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 next_page_url: null key: users users: - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: jing attributes: null is_online: true is_notifiable: null friendly_name: null date_created: '2016-03-24T21:05:19Z' date_updated: '2016-03-24T21:05:19Z' joined_channels_count: 0 links: user_channels: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 next_page_url: null key: users users: [] 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: ListUser /v1/Services/{ServiceSid}/Users/{UserSid}/Channels: servers: - url: https://ip-messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - channel_sid - status parent: /Services/{ServiceSid}/Users/{Sid} mountName: user_channels pathType: list get: description: '' tags: - IpMessagingV1UserChannel 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: type: object properties: channels: type: array items: $ref: '#/components/schemas/ip_messaging.v1.service.user.user_channel' 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: ListUserChannelResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 next_page_url: null key: channels channels: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa member_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: joined last_consumed_message_index: 5 unread_messages_count: 5 links: channel: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa member: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 previous_page_url: null url: https://ip-messaging.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 next_page_url: null key: channels channels: [] 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: ListUserChannel servers: - url: https://ip-messaging.twilio.com tags: - name: IpMessagingV1Channel - name: IpMessagingV1Credential - name: IpMessagingV1Invite - name: IpMessagingV1Member - name: IpMessagingV1Message - name: IpMessagingV1Role - name: IpMessagingV1Service - name: IpMessagingV1User - name: IpMessagingV1UserChannel security: - accountSid_authToken: []