The Twilio IP Messaging API is a communication platform that allows developers to easily integrate real-time chat functionality into their applications. With this API, users can create and manage chat rooms, send and receive messages, and implement rich media such as images and videos within the conversation. It also provides features for message delivery status, typing indicators, and message history retrieval.
components:
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:
type: string
$ref: '#/components/schemas/binding_enum_binding_type'
nullable: true
message_types:
type: array
items:
type: string
nullable: true
url:
type: string
format: uri
nullable: true
links:
type: object
format: uri-map
nullable: true
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:
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
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:
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.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
nullable: true
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:
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.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
nullable: true
consumption_report_interval:
type: integer
nullable: true
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
nullable: true
post_webhook_retry_count:
type: integer
nullable: true
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
nullable: true
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:
type: string
$ref: '#/components/schemas/user_binding_enum_binding_type'
nullable: true
message_types:
type: array
items:
type: string
nullable: true
url:
type: string
format: uri
nullable: true
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:
type: string
$ref: '#/components/schemas/user_channel_enum_channel_status'
nullable: true
last_consumed_message_index:
type: integer
nullable: true
unread_messages_count:
type: integer
nullable: true
links:
type: object
format: uri-map
nullable: true
url:
type: string
format: uri
nullable: true
notification_level:
type: string
$ref: '#/components/schemas/user_channel_enum_notification_level'
nullable: true
user_channel_enum_channel_status:
type: string
enum:
- joined
- invited
- not_participating
user_channel_enum_notification_level:
type: string
enum:
- default
- muted
ListBindingResponse:
type: object
properties:
bindings:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.binding'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateChannelRequest:
type: object
properties:
FriendlyName:
type: string
description: ''
UniqueName:
type: string
description: ''
Attributes:
type: string
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
CreatedBy:
type: string
description: ''
CreateChannelRequest:
type: object
properties:
FriendlyName:
type: string
description: ''
UniqueName:
type: string
description: ''
Attributes:
type: string
description: ''
Type:
type: string
$ref: '#/components/schemas/channel_enum_channel_type'
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
CreatedBy:
type: string
description: ''
ListChannelResponse:
type: object
properties:
channels:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.channel'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
ListChannelWebhookResponse:
type: object
properties:
webhooks:
type: array
items:
$ref: >-
#/components/schemas/ip_messaging.v2.service.channel.channel_webhook
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
CreateChannelWebhookRequest:
type: object
required:
- Type
properties:
Type:
type: string
$ref: '#/components/schemas/channel_webhook_enum_type'
description: ''
Configuration.Url:
type: string
description: ''
Configuration.Method:
type: string
$ref: '#/components/schemas/channel_webhook_enum_method'
description: ''
Configuration.Filters:
type: array
items:
type: string
description: ''
Configuration.Triggers:
type: array
items:
type: string
description: ''
Configuration.FlowSid:
type: string
minLength: 34
maxLength: 34
pattern: ^FW[0-9a-fA-F]{32}$
description: ''
Configuration.RetryCount:
type: integer
description: ''
UpdateChannelWebhookRequest:
type: object
properties:
Configuration.Url:
type: string
description: ''
Configuration.Method:
type: string
$ref: '#/components/schemas/channel_webhook_enum_method'
description: ''
Configuration.Filters:
type: array
items:
type: string
description: ''
Configuration.Triggers:
type: array
items:
type: string
description: ''
Configuration.FlowSid:
type: string
minLength: 34
maxLength: 34
pattern: ^FW[0-9a-fA-F]{32}$
description: ''
Configuration.RetryCount:
type: integer
description: ''
ListCredentialResponse:
type: object
properties:
credentials:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.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
CreateCredentialRequest:
type: object
required:
- Type
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: ''
UpdateCredentialRequest:
type: object
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: ''
CreateInviteRequest:
type: object
required:
- Identity
properties:
Identity:
type: string
description: ''
RoleSid:
type: string
minLength: 34
maxLength: 34
pattern: ^RL[0-9a-fA-F]{32}$
description: ''
ListInviteResponse:
type: object
properties:
invites:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.channel.invite'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateMemberRequest:
type: object
properties:
RoleSid:
type: string
minLength: 34
maxLength: 34
pattern: ^RL[0-9a-fA-F]{32}$
description: ''
LastConsumedMessageIndex:
type: integer
nullable: true
description: ''
LastConsumptionTimestamp:
type: string
format: date-time
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
Attributes:
type: string
description: ''
CreateMemberRequest:
type: object
required:
- Identity
properties:
Identity:
type: string
description: ''
RoleSid:
type: string
minLength: 34
maxLength: 34
pattern: ^RL[0-9a-fA-F]{32}$
description: ''
LastConsumedMessageIndex:
type: integer
nullable: true
description: ''
LastConsumptionTimestamp:
type: string
format: date-time
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
Attributes:
type: string
description: ''
ListMemberResponse:
type: object
properties:
members:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.channel.member'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateMessageRequest:
type: object
properties:
Body:
type: string
description: ''
Attributes:
type: string
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
LastUpdatedBy:
type: string
description: ''
From:
type: string
description: ''
CreateMessageRequest:
type: object
properties:
From:
type: string
description: ''
Attributes:
type: string
description: ''
DateCreated:
type: string
format: date-time
description: ''
DateUpdated:
type: string
format: date-time
description: ''
LastUpdatedBy:
type: string
description: ''
Body:
type: string
description: ''
MediaSid:
type: string
minLength: 34
maxLength: 34
pattern: ^ME[0-9a-fA-F]{32}$
description: ''
ListMessageResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.channel.message'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateRoleRequest:
type: object
required:
- Permission
properties:
Permission:
type: array
items:
type: string
description: ''
CreateRoleRequest:
type: object
required:
- FriendlyName
- Type
- Permission
properties:
FriendlyName:
type: string
description: ''
Type:
type: string
$ref: '#/components/schemas/role_enum_role_type'
description: ''
Permission:
type: array
items:
type: string
description: ''
ListRoleResponse:
type: object
properties:
roles:
type: array
items:
$ref: '#/components/schemas/ip_messaging.v2.service.role'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateServiceRequest:
type: object
properties:
FriendlyName:
type: string
description: ''
DefaultServiceRoleSid:
type: string
minLength: 34
maxLength: 34
pattern: ^RL[0-9a-fA-F]{32}$
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/ip-message-openapi-original.yml