{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "ip_messaging.v2.service.binding": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "identity": { "type": "string", "nullable": true }, "credential_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true }, "binding_type": { "$ref": "#/components/schemas/binding_enum_binding_type" }, "message_types": { "type": "array", "items": { "type": "string" }, "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "binding_enum_binding_type": { "type": "string", "enum": [ "gcm", "apn", "fcm" ] }, "ip_messaging.v2.service.channel": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/channel_enum_channel_type" }, "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" ] }, "channel_enum_webhook_enabled_type": { "type": "string", "enum": [ "true", "false" ] }, "ip_messaging.v2.service.channel.channel_webhook": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WH[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "type": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "configuration": { "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true } } }, "channel_webhook_enum_type": { "type": "string", "enum": [ "webhook", "trigger", "studio" ] }, "channel_webhook_enum_method": { "type": "string", "enum": [ "GET", "POST" ] }, "ip_messaging.v2.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": { "$ref": "#/components/schemas/credential_enum_push_service" }, "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.v2.service.channel.invite": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "ip_messaging.v2.service.channel.member": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "last_consumed_message_index": { "type": "integer", "nullable": true }, "last_consumption_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "attributes": { "type": "string", "nullable": true } } }, "member_enum_webhook_enabled_type": { "type": "string", "enum": [ "true", "false" ] }, "ip_messaging.v2.service.channel.message": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "to": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "last_updated_by": { "type": "string", "nullable": true }, "was_edited": { "type": "boolean", "nullable": true }, "from": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "index": { "type": "integer", "default": 0 }, "type": { "type": "string", "nullable": true }, "media": { "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "message_enum_order_type": { "type": "string", "enum": [ "asc", "desc" ] }, "message_enum_webhook_enabled_type": { "type": "string", "enum": [ "true", "false" ] }, "ip_messaging.v2.service.role": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/role_enum_role_type" }, "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.v2.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 }, "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 }, "pre_webhook_retry_count": { "type": "integer", "default": 0 }, "post_webhook_retry_count": { "type": "integer", "default": 0 }, "notifications": { "nullable": true }, "media": { "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "ip_messaging.v2.service.user": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "is_online": { "type": "boolean", "nullable": true }, "is_notifiable": { "type": "boolean", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "joined_channels_count": { "type": "integer", "default": 0 }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "user_enum_webhook_enabled_type": { "type": "string", "enum": [ "true", "false" ] }, "ip_messaging.v2.service.user.user_binding": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "identity": { "type": "string", "nullable": true }, "user_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true }, "credential_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true }, "binding_type": { "$ref": "#/components/schemas/user_binding_enum_binding_type" }, "message_types": { "type": "array", "items": { "type": "string" }, "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "user_binding_enum_binding_type": { "type": "string", "enum": [ "gcm", "apn", "fcm" ] }, "ip_messaging.v2.service.user.user_channel": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "user_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true }, "member_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true }, "status": { "$ref": "#/components/schemas/user_channel_enum_channel_status" }, "last_consumed_message_index": { "type": "integer", "nullable": true }, "unread_messages_count": { "type": "integer", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "notification_level": { "$ref": "#/components/schemas/user_channel_enum_notification_level" } } }, "user_channel_enum_channel_status": { "type": "string", "enum": [ "joined", "invited", "not_participating" ] }, "user_channel_enum_notification_level": { "type": "string", "enum": [ "default", "muted" ] } } }, "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", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v2/Services/{ServiceSid}/Bindings": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity" ], "parent": "/Services/{Sid}", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Binding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "BindingType", "in": "query", "description": "", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/binding_enum_binding_type" } } }, { "name": "Identity", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 50.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 50 } }, { "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": { "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v2.service.binding" } }, "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": "ListBindingResponse" }, "examples": { "readFull": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "next_page_url": null, "key": "bindings" }, "bindings": [ { "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2016-10-21T11:37:03Z", "date_updated": "2016-10-21T11:37:03Z", "endpoint": "TestUser-endpoint", "identity": "TestUser", "binding_type": "gcm", "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "message_types": [ "removed_from_channel", "new_message", "added_to_channel", "invited_to_channel" ], "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" } } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "next_page_url": null, "key": "bindings" }, "bindings": [] } } } } }, "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": "ListBinding" } }, "/v2/Services/{ServiceSid}/Bindings/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity" ], "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Binding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.binding" }, "examples": { "fetch": { "value": { "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2016-10-21T11:37:03Z", "date_updated": "2016-10-21T11:37:03Z", "endpoint": "TestUser-endpoint", "identity": "TestUser", "binding_type": "gcm", "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "message_types": [ "removed_from_channel", "new_message", "added_to_channel", "invited_to_channel" ], "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "user": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/TestUser" } } } } } }, "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": "FetchBinding" }, "delete": { "description": "", "summary": "", "tags": [ "IpMessagingV2Binding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteBinding" } }, "/v2/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": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" }, "messages": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" }, "invites": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" }, "webhooks": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel" }, "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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", "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": "", "summary": "", "tags": [ "IpMessagingV2Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/channel_enum_webhook_enabled_type" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteChannel" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/channel_enum_webhook_enabled_type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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:38Z", "created_by": "username", "members_count": 0, "messages_count": 0, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", "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": "" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "CreatedBy": { "type": "string", "description": "" } } }, "examples": { "update": { "value": { "Type": "channel", "FriendlyName": "friendly_name", "UniqueName": "unique_name", "Attributes": "{ \"foo\": \"bar\" }", "DateCreated": "2015-12-16T22:18:37Z", "DateUpdated": "2015-12-16T22:18:38Z", "CreatedBy": "username" } } } } } } } }, "/v2/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": "/v2/Services/{service_sid}/Channels/{channel_sid}/Members" }, "messages": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Messages" }, "invites": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Invites" }, "webhooks": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Channels/{channel_sid}/Webhooks" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/channel_enum_webhook_enabled_type" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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:38Z", "created_by": "username", "members_count": 0, "messages_count": 0, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", "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": { "$ref": "#/components/schemas/channel_enum_channel_type" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "CreatedBy": { "type": "string", "description": "" } } }, "examples": { "create": { "value": { "Type": "public", "FriendlyName": "friendly_name", "UniqueName": "unique_name", "Attributes": "{ \"foo\": \"bar\" }", "DateCreated": "2015-12-16T22:18:37Z", "DateUpdated": "2015-12-16T22:18:38Z", "CreatedBy": "username" } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Channel" ], "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": { "$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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "members": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members", "messages": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages", "invites": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites", "webhooks": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks", "last_message": null } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration" ], "parent": "/Services/{ServiceSid}/Channels/{Sid}", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Webhook" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 5, and the maximum is 5.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 5 } }, { "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": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" } }, "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": "ListChannelWebhookResponse" }, "examples": { "readFull": { "value": { "meta": { "page": 0, "page_size": 5, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", "next_page_url": null, "key": "webhooks" }, "webhooks": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "webhook", "configuration": { "url": "dummy", "method": "GET", "filters": [ "onMessageSent", "onChannelDestroyed" ], "retry_count": 2 }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:50Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "trigger", "configuration": { "url": "dummy", "method": "POST", "filters": [ "keyword1", "keyword2" ], "retry_count": 3 }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:50Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "studio", "configuration": { "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:50Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 5, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0", "previous_page_url": null, "next_page_url": null, "key": "webhooks" }, "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": "ListChannelWebhook" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Webhook" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "webhook", "configuration": { "url": "dummy", "method": "GET", "filters": [ "onMessageSent", "onChannelDestroyed" ], "retry_count": 2 }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:50Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "CreateChannelWebhook", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateChannelWebhookRequest", "properties": { "Type": { "$ref": "#/components/schemas/channel_webhook_enum_type" }, "Configuration.Url": { "type": "string", "description": "" }, "Configuration.Method": { "$ref": "#/components/schemas/channel_webhook_enum_method" }, "Configuration.Filters": { "type": "array", "items": { "type": "string" }, "description": "" }, "Configuration.Triggers": { "type": "array", "items": { "type": "string" }, "description": "" }, "Configuration.FlowSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "description": "" }, "Configuration.RetryCount": { "type": "integer", "description": "" } }, "required": [ "Type" ] }, "examples": { "create": { "value": { "Type": "webhook", "Configuration.Url": "dummy", "Configuration.Method": "GET", "Configuration.Filters": [ "onMessageSent", "onChannelDestroyed" ], "Configuration.RetryCount": 2 } } } } } } } }, "/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "configuration" ], "parent": "/Services/{ServiceSid}/Channels/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Webhook" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "studio", "configuration": { "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:50Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchChannelWebhook" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Webhook" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.channel_webhook" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "trigger", "configuration": { "url": "dummy", "method": "POST", "filters": [ "keyword1", "keyword2" ], "retry_count": 3 }, "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:51Z", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "UpdateChannelWebhook", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateChannelWebhookRequest", "properties": { "Configuration.Url": { "type": "string", "description": "" }, "Configuration.Method": { "$ref": "#/components/schemas/channel_webhook_enum_method" }, "Configuration.Filters": { "type": "array", "items": { "type": "string" }, "description": "" }, "Configuration.Triggers": { "type": "array", "items": { "type": "string" }, "description": "" }, "Configuration.FlowSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^FW[0-9a-fA-F]{32}$", "description": "" }, "Configuration.RetryCount": { "type": "integer", "description": "" } } }, "examples": { "update": { "value": { "Configuration.Url": "dummy", "Configuration.Method": "POST", "Configuration.Triggers": [ "keyword1", "keyword2" ], "Configuration.RetryCount": 5 } } } } } } }, "delete": { "description": "", "summary": "", "tags": [ "IpMessagingV2Webhook" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^WH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteChannelWebhook" } }, "/v2/Credentials": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Credential" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v2.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/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Credentials?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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/v2/Credentials?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Credential" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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/v2/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": { "$ref": "#/components/schemas/credential_enum_push_service" }, "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" } } } } } } } }, "/v2/Credentials/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Credential" ], "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.v2.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/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Credential" ], "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.v2.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/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Credential" ], "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" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" }, "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/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Invite" ], "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" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.invite" }, "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/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Invite" ], "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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/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/v2/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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/INaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://ip-messaging.twilio.com/v2/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/v2/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" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.member" }, "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", "attributes": "{}", "url": "https://ip-messaging.twilio.com/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/member_enum_webhook_enabled_type" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteMember" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/member_enum_webhook_enabled_type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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": 20, "last_consumption_timestamp": "2016-03-24T21:05:52Z", "date_created": "2016-03-24T21:05:50Z", "date_updated": "2016-03-24T21:05:51Z", "attributes": "{}", "url": "https://ip-messaging.twilio.com/v2/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": "" }, "LastConsumptionTimestamp": { "type": "string", "format": "date-time", "description": "" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "Attributes": { "type": "string", "description": "" } } }, "examples": { "updateRoleSid": { "value": { "RoleSid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "DateCreated": "2016-03-24T21:05:50Z", "DateUpdated": "2016-03-24T21:05:51Z", "LastConsumedMessageIndex": 20, "LastConsumptionTimestamp": "2016-03-24T21:05:52Z", "Attributes": "{}" } } } } } } } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/member_enum_webhook_enabled_type" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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", "attributes": "{}", "url": "https://ip-messaging.twilio.com/v2/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": "" }, "LastConsumedMessageIndex": { "type": "integer", "nullable": true, "description": "" }, "LastConsumptionTimestamp": { "type": "string", "format": "date-time", "description": "" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "Attributes": { "type": "string", "description": "" } }, "required": [ "Identity" ] }, "examples": { "create": { "value": { "Identity": "Twilio", "Attributes": "{}" } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Member" ], "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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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", "attributes": "{}", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" }, "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", "last_updated_by": null, "was_edited": false, "from": "system", "attributes": "{}", "body": "Hello", "index": 0, "type": "text", "media": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "fetchMedia": { "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", "last_updated_by": null, "was_edited": false, "from": "system", "attributes": "{}", "body": "Hello", "index": 0, "type": "media", "media": { "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 99999999999999, "content_type": "application/pdf", "filename": "hello.pdf" }, "url": "https://ip-messaging.twilio.com/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/message_enum_webhook_enabled_type" } } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteMessage" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/message_enum_webhook_enabled_type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.channel.message" }, "examples": { "update": { "value": { "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "attributes": "{ \"foo\": \"bar\" }", "date_created": "2015-12-16T22:18:37Z", "date_updated": "2015-12-16T22:18:38Z", "last_updated_by": "username", "was_edited": true, "from": "fromUser", "body": "Hello", "index": 0, "type": "text", "media": null, "url": "https://ip-messaging.twilio.com/v2/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": "" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "LastUpdatedBy": { "type": "string", "description": "" }, "From": { "type": "string", "description": "" } } }, "examples": { "update": { "value": { "Body": "Hello", "Attributes": "{ \"foo\": \"bar\" }", "DateCreated": "2015-12-16T22:18:37Z", "DateUpdated": "2015-12-16T22:18:38Z", "LastUpdatedBy": "username", "From": "fromUser" } } } } } } } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/message_enum_webhook_enabled_type" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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", "last_updated_by": "system", "was_edited": false, "from": "system", "body": "Hello", "index": 0, "type": "text", "media": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "createWithAll": { "value": { "sid": "IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "to": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-12-16T22:18:37Z", "date_updated": "2015-12-16T22:18:38Z", "last_updated_by": "username", "was_edited": true, "from": "system", "attributes": "{\"test\": \"test\"}", "body": "Hello", "index": 0, "type": "text", "media": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "createMedia": { "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", "last_updated_by": "system", "was_edited": false, "from": "system", "body": "Hello", "index": 0, "type": "text", "media": { "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 99999999999999, "content_type": "application/pdf", "filename": "hello.pdf" }, "url": "https://ip-messaging.twilio.com/v2/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": { "From": { "type": "string", "description": "" }, "Attributes": { "type": "string", "description": "" }, "DateCreated": { "type": "string", "format": "date-time", "description": "" }, "DateUpdated": { "type": "string", "format": "date-time", "description": "" }, "LastUpdatedBy": { "type": "string", "description": "" }, "Body": { "type": "string", "description": "" }, "MediaSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ME[0-9a-fA-F]{32}$", "description": "" } } }, "examples": { "create": { "value": { "Body": "Hello" } }, "createWithAll": { "value": { "Body": "Hello", "Attributes": "{\"test\": \"test\"}", "DateCreated": "2015-12-16T22:18:37Z", "DateUpdated": "2015-12-16T22:18:38Z", "LastUpdatedBy": "username" } }, "createMedia": { "value": { "MediaSid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Order", "in": "query", "description": "", "schema": { "$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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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", "last_updated_by": null, "was_edited": false, "from": "system", "attributes": "{}", "body": "Hello", "index": 0, "type": "text", "media": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, { "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", "last_updated_by": null, "was_edited": false, "from": "system", "attributes": "{}", "body": "Hello", "index": 0, "type": "media", "media": { "sid": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 99999999999999, "content_type": "application/pdf", "filename": "hello.pdf" }, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" }, "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/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Role" ], "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": "", "summary": "", "tags": [ "IpMessagingV2Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" }, "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/v2/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" } } } } } } } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.role" }, "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/v2/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": { "$ref": "#/components/schemas/role_enum_role_type" }, "Permission": { "type": "array", "items": { "type": "string" }, "description": "" } }, "required": [ "FriendlyName", "Type", "Permission" ] }, "examples": { "create": { "value": { "FriendlyName": "friendly_name", "Type": "channel", "Permission": "sendMessage" } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Role" ], "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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/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": "/v2/Services/{service_sid}/Channels" }, "roles": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Roles" }, "users": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users" }, "bindings": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Bindings" } }, "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2Service" ], "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "notifications": {}, "post_webhook_url": "post_webhook_url", "pre_webhook_url": "pre_webhook_url", "pre_webhook_retry_count": 2, "post_webhook_retry_count": 3, "reachability_enabled": false, "read_status_enabled": false, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "typing_indicator_timeout": 100, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_filters": [ "webhook_filters" ], "webhook_method": "webhook_method", "media": { "size_limit_mb": 150, "compatibility_message": "media compatibility message" } } } } } }, "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": "", "summary": "", "tags": [ "IpMessagingV2Service" ], "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": "", "summary": "", "tags": [ "IpMessagingV2Service" ], "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "notifications": { "log_enabled": true, "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", "badge_count_enabled": true }, "removed_from_channel": { "enabled": false, "template": "notifications.removed_from_channel.template" } }, "post_webhook_url": "post_webhook_url", "pre_webhook_url": "pre_webhook_url", "pre_webhook_retry_count": 2, "post_webhook_retry_count": 3, "reachability_enabled": false, "read_status_enabled": false, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "typing_indicator_timeout": 100, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_filters": [ "webhook_filters" ], "webhook_method": "webhook_method", "media": { "size_limit_mb": 150, "compatibility_message": "new media compatibility message" } } } } } }, "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.NewMessage.Sound": { "type": "string", "description": "" }, "Notifications.NewMessage.BadgeCountEnabled": { "type": "boolean", "description": "" }, "Notifications.AddedToChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.AddedToChannel.Template": { "type": "string", "description": "" }, "Notifications.AddedToChannel.Sound": { "type": "string", "description": "" }, "Notifications.RemovedFromChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.RemovedFromChannel.Template": { "type": "string", "description": "" }, "Notifications.RemovedFromChannel.Sound": { "type": "string", "description": "" }, "Notifications.InvitedToChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.InvitedToChannel.Template": { "type": "string", "description": "" }, "Notifications.InvitedToChannel.Sound": { "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": "" }, "Limits.ChannelMembers": { "type": "integer", "description": "" }, "Limits.UserChannels": { "type": "integer", "description": "" }, "Media.CompatibilityMessage": { "type": "string", "description": "" }, "PreWebhookRetryCount": { "type": "integer", "description": "" }, "PostWebhookRetryCount": { "type": "integer", "description": "" }, "Notifications.LogEnabled": { "type": "boolean", "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.NewMessage.BadgeCountEnabled": true, "Notifications.RemovedFromChannel.Enabled": false, "Notifications.RemovedFromChannel.Template": "notifications.removed_from_channel.template", "Notifications.LogEnabled": true, "Limits.ChannelMembers": 600, "Limits.UserChannels": 500, "PostWebhookUrl": "post_webhook_url", "PreWebhookUrl": "pre_webhook_url", "PreWebhookRetryCount": 2, "PostWebhookRetryCount": 3, "ReachabilityEnabled": false, "ReadStatusEnabled": false, "TypingIndicatorTimeout": 100, "WebhookFilters": [ "webhook_filters" ], "WebhookMethod": "webhook_method", "Media.CompatibilityMessage": "new media compatibility message" } } } } } } } }, "/v2/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": "/v2/Services/{service_sid}/Channels" }, "roles": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Roles" }, "users": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users" }, "bindings": { "mapping": { "service_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Bindings" } }, "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2Service" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "notifications": {}, "post_webhook_url": "post_webhook_url", "pre_webhook_url": "pre_webhook_url", "pre_webhook_retry_count": 2, "post_webhook_retry_count": 3, "reachability_enabled": false, "read_status_enabled": false, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "typing_indicator_timeout": 100, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_filters": [ "webhook_filters" ], "webhook_method": "webhook_method", "media": { "size_limit_mb": 150, "compatibility_message": "media compatibility message" } } } } } }, "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": "", "summary": "", "tags": [ "IpMessagingV2Service" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/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/v2/Services?PageSize=50&Page=0" }, "services": [] } }, "readFull": { "value": { "meta": { "first_page_url": "https://ip-messaging.twilio.com/v2/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/v2/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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users", "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles", "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "notifications": {}, "post_webhook_url": "post_webhook_url", "pre_webhook_url": "pre_webhook_url", "pre_webhook_retry_count": 2, "post_webhook_retry_count": 3, "reachability_enabled": false, "read_status_enabled": false, "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "typing_indicator_timeout": 100, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "webhook_filters": [ "webhook_filters" ], "webhook_method": "webhook_method", "media": { "size_limit_mb": 150, "compatibility_message": "media compatibility message" } } ] } } } } }, "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" } }, "/v2/Services/{ServiceSid}/Users/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "identity", "date_created" ], "dependentProperties": { "user_channels": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" }, "user_bindings": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user" }, "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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "url": "https://ip-messaging.twilio.com/v2/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": "", "summary": "", "tags": [ "IpMessagingV2User" ], "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": "", "summary": "", "tags": [ "IpMessagingV2User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/user_enum_webhook_enabled_type" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "url": "https://ip-messaging.twilio.com/v2/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" } } } } } } } }, "/v2/Services/{ServiceSid}/Users": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "identity", "date_created" ], "dependentProperties": { "user_channels": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Channels" }, "user_bindings": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v2/Services/{service_sid}/Users/{user_sid}/Bindings" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "X-Twilio-Webhook-Enabled", "in": "header", "description": "The X-Twilio-Webhook-Enabled HTTP request header", "schema": { "$ref": "#/components/schemas/user_enum_webhook_enabled_type" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "url": "https://ip-messaging.twilio.com/v2/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": "", "summary": "", "tags": [ "IpMessagingV2User" ], "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 100.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels", "user_bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings" }, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity", "binding_type" ], "parent": "/Services/{ServiceSid}/Users/{Sid}", "mountName": "user_bindings", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserBinding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "BindingType", "in": "query", "description": "", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/user_binding_enum_binding_type" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 50.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 50 } }, { "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": { "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_binding" } }, "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": "ListUserBindingResponse" }, "examples": { "readFull": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "next_page_url": null, "key": "bindings" }, "bindings": [ { "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2016-10-21T11:37:03Z", "date_updated": "2016-10-21T11:37:03Z", "endpoint": "TestUser-endpoint", "identity": "TestUser", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "binding_type": "gcm", "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "message_types": [ "removed_from_channel", "new_message", "added_to_channel", "invited_to_channel" ], "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0", "next_page_url": null, "key": "bindings" }, "bindings": [] } } } } }, "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": "ListUserBinding" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "endpoint", "identity", "binding_type" ], "parent": "/Services/{ServiceSid}/Users/{Sid}", "mountName": "user_bindings", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserBinding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_binding" }, "examples": { "fetch": { "value": { "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2016-10-21T11:37:03Z", "date_updated": "2016-10-21T11:37:03Z", "endpoint": "TestUser-endpoint", "identity": "TestUser", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "binding_type": "gcm", "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "message_types": [ "removed_from_channel", "new_message", "added_to_channel", "invited_to_channel" ], "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "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": "FetchUserBinding" }, "delete": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserBinding" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^BS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteUserBinding" } }, "/v2/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": "", "summary": "", "tags": [ "IpMessagingV2UserChannel" ], "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 50.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 50 } }, { "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.v2.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/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "joined", "last_consumed_message_index": 5, "unread_messages_count": 5, "notification_level": "default", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ] } }, "readEmpty": { "value": { "meta": { "page": 0, "page_size": 50, "first_page_url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0", "previous_page_url": null, "url": "https://ip-messaging.twilio.com/v2/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" } }, "/v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], "parent": "/Services/{ServiceSid}/Users/{Sid}", "mountName": "user_channels", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserChannel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "joined", "last_consumed_message_index": 5, "unread_messages_count": 5, "notification_level": "default", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member": "https://ip-messaging.twilio.com/v2/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": "FetchUserChannel" }, "delete": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserChannel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteUserChannel" }, "post": { "description": "", "summary": "", "tags": [ "IpMessagingV2UserChannel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v2.service.user.user_channel" }, "examples": { "updateNotificationLevel": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "joined", "last_consumed_message_index": 5, "unread_messages_count": 5, "notification_level": "muted", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, "updateLastConsumedMessageIndex": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "channel_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member_sid": "MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "joined", "last_consumed_message_index": 10, "unread_messages_count": 5, "notification_level": "muted", "url": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "channel": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "member": "https://ip-messaging.twilio.com/v2/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": "UpdateUserChannel", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateUserChannelRequest", "properties": { "NotificationLevel": { "$ref": "#/components/schemas/user_channel_enum_notification_level" }, "LastConsumedMessageIndex": { "type": "integer", "nullable": true, "description": "" }, "LastConsumptionTimestamp": { "type": "string", "format": "date-time", "description": "" } } }, "examples": { "updateNotificationLevel": { "value": { "NotificationLevel": "muted" } }, "updateLastConsumedMessageIndex": { "value": { "LastConsumedMessageIndex": 10 } } } } } } } } }, "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "tags": [ { "name": "IpMessagingV2Binding" }, { "name": "IpMessagingV2Channel" }, { "name": "IpMessagingV2Credential" }, { "name": "IpMessagingV2Invite" }, { "name": "IpMessagingV2Member" }, { "name": "IpMessagingV2Message" }, { "name": "IpMessagingV2Role" }, { "name": "IpMessagingV2Service" }, { "name": "IpMessagingV2User" }, { "name": "IpMessagingV2UserBinding" }, { "name": "IpMessagingV2UserChannel" }, { "name": "IpMessagingV2Webhook" }, { "name": "Ip_messagingV2Version" } ], "security": [ { "accountSid_authToken": [] } ] }