{ "components": { "schemas": { "ip_messaging.v1.service.channel": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "unique_name": { "type": "string", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "type": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "members_count": { "type": "integer", "nullable": true }, "messages_count": { "type": "integer", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "channel_enum_channel_type": { "type": "string", "enum": [ "public", "private" ] }, "ip_messaging.v1.credential": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_service", "nullable": true }, "sandbox": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "credential_enum_push_service": { "type": "string", "enum": [ "gcm", "apn", "fcm" ] }, "ip_messaging.v1.service.channel.invite": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "created_by": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "ip_messaging.v1.service.channel.member": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "last_consumed_message_index": { "type": "integer", "nullable": true }, "last_consumption_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "ip_messaging.v1.service.channel.message": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "to": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "was_edited": { "type": "boolean", "nullable": true }, "from": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "index": { "type": "integer", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "message_enum_order_type": { "type": "string", "enum": [ "asc", "desc" ] }, "ip_messaging.v1.service.role": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "type": { "type": "string", "$ref": "#/components/schemas/role_enum_role_type", "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "role_enum_role_type": { "type": "string", "enum": [ "channel", "deployment" ] }, "ip_messaging.v1.service": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "default_service_role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "default_channel_role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "default_channel_creator_role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "read_status_enabled": { "type": "boolean", "nullable": true }, "reachability_enabled": { "type": "boolean", "nullable": true }, "typing_indicator_timeout": { "type": "integer", "nullable": true }, "consumption_report_interval": { "type": "integer", "nullable": true }, "limits": { "nullable": true }, "webhooks": { "nullable": true }, "pre_webhook_url": { "type": "string", "nullable": true }, "post_webhook_url": { "type": "string", "nullable": true }, "webhook_method": { "type": "string", "nullable": true }, "webhook_filters": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notifications": { "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "ip_messaging.v1.service.user": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^US[0-9a-fA-F]{32}$", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "attributes": { "type": "string", "nullable": true }, "friendly_name": { "type": "string", "nullable": true }, "role_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "nullable": true }, "identity": { "type": "string", "nullable": true }, "is_online": { "type": "boolean", "nullable": true }, "is_notifiable": { "type": "boolean", "nullable": true }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_updated": { "type": "string", "format": "date-time", "nullable": true }, "joined_channels_count": { "type": "integer", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "ip_messaging.v1.service.user.user_channel": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$", "nullable": true }, "channel_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$", "nullable": true }, "member_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$", "nullable": true }, "status": { "type": "string", "$ref": "#/components/schemas/user_channel_enum_channel_status", "nullable": true }, "last_consumed_message_index": { "type": "integer", "nullable": true }, "unread_messages_count": { "type": "integer", "nullable": true }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "user_channel_enum_channel_status": { "type": "string", "enum": [ "joined", "invited", "not_participating" ] } }, "securitySchemes": { "accountSid_authToken": { "type": "http", "scheme": "basic" } } }, "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.56.1" }, "openapi": "3.0.1", "paths": { "/v1/Services/{ServiceSid}/Channels/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "pathType": "instance", "dependentProperties": { "members": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" }, "messages": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" }, "invites": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, "parent": "/Services/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchChannel", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteChannel", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateChannel", "x-maturity": [ "GA" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/v1/Services/{ServiceSid}/Channels": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "pathType": "list", "dependentProperties": { "members": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Members" }, "messages": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Messages" }, "invites": { "mapping": { "service_sid": "service_sid", "channel_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels/{channel_sid}/Invites" } }, "parent": "/Services/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateChannel", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateChannelRequest", "properties": { "FriendlyName": { "type": "string", "description": "" }, "UniqueName": { "type": "string", "description": "" }, "Attributes": { "type": "string", "description": "" }, "Type": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "get": { "description": "", "tags": [ "IpMessagingV1Channel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Type", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string", "$ref": "#/components/schemas/channel_enum_channel_type" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListChannelResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListChannel", "x-maturity": [ "GA" ] } }, "/v1/Credentials": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "list" }, "get": { "description": "", "tags": [ "IpMessagingV1Credential" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.credential" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListCredentialResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListCredential", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Credential" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateCredential", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateCredentialRequest", "properties": { "Type": { "type": "string", "$ref": "#/components/schemas/credential_enum_push_service", "description": "" }, "FriendlyName": { "type": "string", "description": "" }, "Certificate": { "type": "string", "description": "" }, "PrivateKey": { "type": "string", "description": "" }, "Sandbox": { "type": "boolean", "description": "" }, "ApiKey": { "type": "string", "description": "" }, "Secret": { "type": "string", "description": "" } }, "required": [ "Type" ] } } } } } }, "/v1/Credentials/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "instance" }, "get": { "description": "", "tags": [ "IpMessagingV1Credential" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchCredential", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Credential" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.credential" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateCredential", "x-maturity": [ "GA" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } }, "delete": { "description": "", "tags": [ "IpMessagingV1Credential" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteCredential", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], "pathType": "instance", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchInvite", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteInvite", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], "pathType": "list", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateInvite", "x-maturity": [ "GA" ], "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" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1Invite" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "invites": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.invite" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListInviteResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListInvite", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], "pathType": "instance", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMember", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteMember", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateMember", "x-maturity": [ "GA" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Members": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "date_created" ], "pathType": "list", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateMember", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateMemberRequest", "properties": { "Identity": { "type": "string", "description": "" }, "RoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "description": "" } }, "required": [ "Identity" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1Member" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "Identity", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.member" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMemberResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMember", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "from", "to", "date_created" ], "pathType": "instance", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMessage", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteMessage", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IM[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateMessage", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateMessageRequest", "properties": { "Body": { "type": "string", "description": "" }, "Attributes": { "type": "string", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/v1/Services/{ServiceSid}/Channels/{ChannelSid}/Messages": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "from", "to", "date_created" ], "pathType": "list", "parent": "/Services/{ServiceSid}/Channels/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateMessage", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateMessageRequest", "properties": { "Body": { "type": "string", "description": "" }, "From": { "type": "string", "description": "" }, "Attributes": { "type": "string", "description": "" } }, "required": [ "Body" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1Message" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "ChannelSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Order", "in": "query", "description": "", "schema": { "type": "string", "$ref": "#/components/schemas/message_enum_order_type" } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.channel.message" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListMessageResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListMessage", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Roles/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "instance", "parent": "/Services/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRole", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteRole", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRole", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoleRequest", "properties": { "Permission": { "type": "array", "items": { "type": "string" }, "description": "" } }, "required": [ "Permission" ] } } } } } }, "/v1/Services/{ServiceSid}/Roles": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "type" ], "pathType": "list", "parent": "/Services/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateRole", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateRoleRequest", "properties": { "FriendlyName": { "type": "string", "description": "" }, "Type": { "type": "string", "$ref": "#/components/schemas/role_enum_role_type", "description": "" }, "Permission": { "type": "array", "items": { "type": "string" }, "description": "" } }, "required": [ "FriendlyName", "Type", "Permission" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1Role" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.role" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListRoleResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRole", "x-maturity": [ "GA" ] } }, "/v1/Services/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "instance", "dependentProperties": { "channels": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels" }, "roles": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Roles" }, "users": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Users" } } }, "get": { "description": "", "tags": [ "IpMessagingV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchService", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteService", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateService", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateServiceRequest", "properties": { "FriendlyName": { "type": "string", "description": "" }, "DefaultServiceRoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "description": "" }, "DefaultChannelRoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "description": "" }, "DefaultChannelCreatorRoleSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RL[0-9a-fA-F]{32}$", "description": "" }, "ReadStatusEnabled": { "type": "boolean", "description": "" }, "ReachabilityEnabled": { "type": "boolean", "description": "" }, "TypingIndicatorTimeout": { "type": "integer", "description": "" }, "ConsumptionReportInterval": { "type": "integer", "description": "" }, "Notifications.NewMessage.Enabled": { "type": "boolean", "description": "" }, "Notifications.NewMessage.Template": { "type": "string", "description": "" }, "Notifications.AddedToChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.AddedToChannel.Template": { "type": "string", "description": "" }, "Notifications.RemovedFromChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.RemovedFromChannel.Template": { "type": "string", "description": "" }, "Notifications.InvitedToChannel.Enabled": { "type": "boolean", "description": "" }, "Notifications.InvitedToChannel.Template": { "type": "string", "description": "" }, "PreWebhookUrl": { "type": "string", "format": "uri", "description": "" }, "PostWebhookUrl": { "type": "string", "format": "uri", "description": "" }, "WebhookMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "WebhookFilters": { "type": "array", "items": { "type": "string" }, "description": "" }, "Webhooks.OnMessageSend.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageSend.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMessageUpdate.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageUpdate.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMessageRemove.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageRemove.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelAdd.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelAdd.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelDestroy.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelDestroy.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelUpdate.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelUpdate.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMemberAdd.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMemberAdd.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMemberRemove.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMemberRemove.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMessageSent.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageSent.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMessageUpdated.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageUpdated.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMessageRemoved.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMessageRemoved.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelAdded.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelAdded.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelDestroyed.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelDestroyed.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnChannelUpdated.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnChannelUpdated.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMemberAdded.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMemberAdded.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Webhooks.OnMemberRemoved.Url": { "type": "string", "format": "uri", "description": "" }, "Webhooks.OnMemberRemoved.Method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "" }, "Limits.ChannelMembers": { "type": "integer", "description": "" }, "Limits.UserChannels": { "type": "integer", "description": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/v1/Services": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "list", "dependentProperties": { "channels": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Channels" }, "roles": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Roles" }, "users": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Users" } } }, "post": { "description": "", "tags": [ "IpMessagingV1Service" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateService", "x-maturity": [ "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateServiceRequest", "properties": { "FriendlyName": { "type": "string", "description": "" } }, "required": [ "FriendlyName" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1Service" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListServiceResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListService", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Users/{Sid}": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "instance", "dependentProperties": { "user_channels": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, "parent": "/Services/{Sid}" }, "get": { "description": "", "tags": [ "IpMessagingV1User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchUser", "x-maturity": [ "GA" ] }, "delete": { "description": "", "tags": [ "IpMessagingV1User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteUser", "x-maturity": [ "GA" ] }, "post": { "description": "", "tags": [ "IpMessagingV1User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateUser", "x-maturity": [ "GA" ], "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": "" } } } } } }, "x-twilio": { "addContentTypeIfEmptyForm": true } } }, "/v1/Services/{ServiceSid}/Users": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "list", "dependentProperties": { "user_channels": { "mapping": { "service_sid": "service_sid", "user_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Users/{user_sid}/Channels" } }, "parent": "/Services/{Sid}" }, "post": { "description": "", "tags": [ "IpMessagingV1User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateUser", "x-maturity": [ "GA" ], "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" ] } } } } }, "get": { "description": "", "tags": [ "IpMessagingV1User" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.user" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListUserResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListUser", "x-maturity": [ "GA" ] } }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ "channel_sid", "status" ], "pathType": "list", "parent": "/Services/{ServiceSid}/Users/{Sid}", "mountName": "user_channels" }, "get": { "description": "", "tags": [ "IpMessagingV1UserChannel" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "UserSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "array", "items": { "$ref": "#/components/schemas/ip_messaging.v1.service.user.user_channel" } }, "meta": { "type": "object", "properties": { "first_page_url": { "type": "string", "format": "uri" }, "next_page_url": { "type": "string", "format": "uri", "nullable": true }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri" }, "key": { "type": "string" } } } }, "title": "ListUserChannelResponse" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListUserChannel", "x-maturity": [ "GA" ] } } }, "servers": [ { "url": "https://ip-messaging.twilio.com" } ], "tags": [ { "name": "IpMessagingV1Channel" }, { "name": "IpMessagingV1Credential" }, { "name": "IpMessagingV1Invite" }, { "name": "IpMessagingV1Member" }, { "name": "IpMessagingV1Message" }, { "name": "IpMessagingV1Role" }, { "name": "IpMessagingV1Service" }, { "name": "IpMessagingV1User" }, { "name": "IpMessagingV1UserChannel" } ], "x-maturity": [ { "name": "GA", "description": "This product is Generally Available." } ] }