Created
October 6, 2021 16:34
-
-
Save jurgob/0aa466c0dbdae9f38c564e694b9b53d7 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"$schema": "http://json-schema.org/draft-07/schema#", | |
"$id": "http://json-schema.org/draft-07/schema#", | |
"title": "Core schema meta-schema", | |
"components": { | |
"schemas": { | |
"uuid": { | |
"type": "string" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"conversation_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"asr_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"record_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"stream_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"say_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"session_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"session_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"member_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"leg_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"leg_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"knocking_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"user_id_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"rtc_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"device_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"event_id": { | |
"description": "Event id. This is a progressive integer", | |
"example": "5", | |
"type": "integer" | |
}, | |
"nullable_member_id": { | |
"description": "Member ID", | |
"nullable": true, | |
"example": "MEM-63f61863-4a51-4f6b-86e1-46edebio0391", | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/uuid" | |
} | |
] | |
}, | |
"name_conversation": { | |
"description": "Unique name for a conversation", | |
"example": "customer_chat", | |
"type": "string" | |
}, | |
"name_conversation_v03": { | |
"type": "string", | |
"maxLength": 100 | |
}, | |
"display_name": { | |
"description": "The display name for the conversation. It does not have to be unique", | |
"example": "Customer Chat", | |
"type": "string", | |
"nullable": true | |
}, | |
"display_name_v03": { | |
"type": "string", | |
"maxLength": 50, | |
"nullable": true | |
}, | |
"empty_display_name": { | |
"$ref": "#/components/schemas/display_name" | |
}, | |
"user_name_v03": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"opentok_token": { | |
"type": "string" | |
}, | |
"member_state": { | |
"description": "The state that the member is in. Possible values are `invited`, `joined`, `left`, or `unknown`", | |
"example": "INVITED", | |
"type": "string", | |
"enum": [ | |
"INVITED", | |
"JOINED", | |
"LEFT", | |
"UNKNOWN" | |
] | |
}, | |
"member_state_req": { | |
"type": "string", | |
"enum": [ | |
"INVITED", | |
"JOINED", | |
"LEFT", | |
"UNKNOWN" | |
] | |
}, | |
"member_name": { | |
"description": "Member Name", | |
"example": "some_name", | |
"type": "string" | |
}, | |
"properties": { | |
"type": "object", | |
"properties": { | |
"ttl": { | |
"$ref": "#/components/schemas/ttl" | |
}, | |
"type": { | |
"type": "string" | |
}, | |
"custom_data": { | |
"type": "object" | |
} | |
} | |
}, | |
"properties_v03": { | |
"type": "object", | |
"properties": { | |
"ttl": { | |
"$ref": "#/components/schemas/ttl_v03" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"custom_data": { | |
"type": "object" | |
} | |
} | |
}, | |
"context": { | |
"type": "string", | |
"enum": [ | |
"VAPI" | |
], | |
"description": "field for internal services to allow _meta data injection" | |
}, | |
"member": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"conversation_id": { | |
"type": "string" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/member_state" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id" | |
}, | |
"invited_by": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"initiator": { | |
"type": "object" | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"type": "string" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
}, | |
"href": { | |
"type": "string", | |
"format": "uri" | |
}, | |
"media": { | |
"$ref": "#/components/schemas/media" | |
}, | |
"timestamp": { | |
"type": "object", | |
"properties": { | |
"invited": { | |
"type": "string", | |
"format": "date-time", | |
"description": "Date in ISO format" | |
}, | |
"joined": { | |
"type": "string", | |
"format": "date-time", | |
"description": "Date in ISO format" | |
}, | |
"left": { | |
"type": "string", | |
"format": "date-time", | |
"description": "Date in ISO format" | |
} | |
} | |
}, | |
"isDisabledCallback": { | |
"type": "boolean" | |
}, | |
"leg_ids": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/leg_id" | |
} | |
}, | |
"legs": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/legs" | |
} | |
}, | |
"channel": { | |
"$ref": "#/components/schemas/channel" | |
} | |
}, | |
"required": [ | |
"state", | |
"user_id", | |
"channel" | |
] | |
}, | |
"member_v03": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"conversation_id": { | |
"type": "string" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/member_state" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id" | |
}, | |
"invited_by": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"initiator": { | |
"type": "object" | |
}, | |
"_embedded": { | |
"type": "object", | |
"properties": { | |
"user": { | |
"$ref": "#/components/schemas/user_embedded" | |
} | |
}, | |
"required": [ | |
"user" | |
] | |
}, | |
"_links": { | |
"$ref": "#/components/schemas/_links" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/member_timestamp" | |
}, | |
"media": { | |
"$ref": "#/components/schemas/member_media" | |
}, | |
"channel": { | |
"$ref": "#/components/schemas/channel_v03" | |
} | |
}, | |
"required": [ | |
"state", | |
"_embedded", | |
"_links", | |
"channel" | |
] | |
}, | |
"user_name": { | |
"type": "string" | |
}, | |
"conversation_member": { | |
"type": "object", | |
"properties": { | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"type": "string" | |
}, | |
"user_name": { | |
"type": "string" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/member_state" | |
} | |
}, | |
"required": [ | |
"user_id", | |
"name", | |
"user_name", | |
"state" | |
] | |
}, | |
"conversation_members": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/conversation_member" | |
} | |
}, | |
"state_conversation_all": { | |
"type": "string", | |
"enum": [ | |
"ACTIVE", | |
"INACTIVE", | |
"DELETED" | |
] | |
}, | |
"state_conversation": { | |
"type": "string", | |
"enum": [ | |
"INACTIVE" | |
] | |
}, | |
"channel": { | |
"description": "When a user joins a conversation as a member, they can have one channel per membership. Channels can be one of `app`, `phone`, `sip`, `websocket`, `vbc`", | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"websocket" | |
] | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"cpa": { | |
"type": "boolean" | |
}, | |
"preanswer": { | |
"type": "boolean" | |
}, | |
"ring_timeout": { | |
"type": "number", | |
"format": "float" | |
}, | |
"can_hear": { | |
"$ref": "#/components/schemas/leg_list" | |
}, | |
"can_speak": { | |
"$ref": "#/components/schemas/leg_list" | |
}, | |
"cpa_time": { | |
"type": "number", | |
"format": "float" | |
}, | |
"max_length": { | |
"type": "number", | |
"format": "float" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id" | |
}, | |
"legs": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/legs" | |
} | |
}, | |
"leg_ids": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/leg_id" | |
} | |
}, | |
"leg_settings": { | |
"type": "object" | |
}, | |
"content-type": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"cpa": { | |
"type": "boolean" | |
}, | |
"preanswer": { | |
"type": "boolean" | |
}, | |
"ring_timeout": { | |
"type": "number", | |
"format": "float" | |
}, | |
"can_hear": { | |
"$ref": "#/components/schemas/leg_list" | |
}, | |
"can_speak": { | |
"$ref": "#/components/schemas/leg_list" | |
}, | |
"cpa_time": { | |
"type": "number", | |
"format": "float" | |
}, | |
"max_length": { | |
"type": "number", | |
"format": "float" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id" | |
}, | |
"legs": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/legs" | |
} | |
}, | |
"leg_ids": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/leg_id" | |
} | |
}, | |
"leg_settings": { | |
"type": "object" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app", | |
"phone", | |
"sip", | |
"vbc" | |
] | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
} | |
] | |
}, | |
"channel_v03": { | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint_v03" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id_v03" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"websocket" | |
] | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint_v03" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"cpa": { | |
"type": "boolean" | |
}, | |
"preanswer": { | |
"type": "boolean" | |
}, | |
"ring_timeout": { | |
"type": "number", | |
"format": "float" | |
}, | |
"can_hear": { | |
"$ref": "#/components/schemas/leg_list_v03" | |
}, | |
"can_speak": { | |
"$ref": "#/components/schemas/leg_list_v03" | |
}, | |
"cpa_time": { | |
"type": "number", | |
"format": "float" | |
}, | |
"max_length": { | |
"type": "number", | |
"format": "float" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id_v03" | |
}, | |
"content-type": { | |
"$ref": "#/components/schemas/string_200" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint_v03" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id_v03" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint_v03" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"cpa": { | |
"type": "boolean" | |
}, | |
"preanswer": { | |
"type": "boolean" | |
}, | |
"ring_timeout": { | |
"type": "number", | |
"format": "float" | |
}, | |
"can_hear": { | |
"$ref": "#/components/schemas/leg_list_v03" | |
}, | |
"can_speak": { | |
"$ref": "#/components/schemas/leg_list_v03" | |
}, | |
"cpa_time": { | |
"type": "number", | |
"format": "float" | |
}, | |
"max_length": { | |
"type": "number", | |
"format": "float" | |
}, | |
"knocking_id": { | |
"$ref": "#/components/schemas/knocking_id_v03" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app", | |
"phone", | |
"sip", | |
"vbc" | |
] | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
} | |
] | |
}, | |
"text_string": { | |
"type": "string", | |
"maxLength": 2500 | |
}, | |
"initiator": { | |
"type": "object" | |
}, | |
"media": { | |
"description": "Media Object", | |
"example": { | |
"audio_settings": { | |
"enabled": false, | |
"earmuffed": false, | |
"muted": false | |
} | |
}, | |
"type": "object", | |
"properties": { | |
"audio_settings": { | |
"$ref": "#/components/schemas/audio" | |
}, | |
"audio": { | |
"$ref": "#/components/schemas/audio" | |
} | |
} | |
}, | |
"audio": { | |
"type": "object", | |
"properties": { | |
"enabled": { | |
"type": "boolean" | |
}, | |
"earmuffed": { | |
"type": "boolean" | |
}, | |
"muted": { | |
"type": "boolean" | |
} | |
} | |
}, | |
"member_media": { | |
"type": "object", | |
"properties": { | |
"audio_settings": { | |
"$ref": "#/components/schemas/audio" | |
}, | |
"audio": { | |
"type": "boolean" | |
} | |
} | |
}, | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"in", | |
"out" | |
] | |
}, | |
"full_direction": { | |
"description": "Full direction", | |
"example": "inbound", | |
"type": "string", | |
"enum": [ | |
"inbound", | |
"outbound" | |
] | |
}, | |
"quality": { | |
"type": "object", | |
"properties": { | |
"mos_score": { | |
"type": "number", | |
"format": "float" | |
}, | |
"quality_percentage": { | |
"type": "number", | |
"format": "float" | |
}, | |
"jitter_min_var": { | |
"type": "number", | |
"format": "float" | |
}, | |
"jitter_max_var": { | |
"type": "number", | |
"format": "float" | |
}, | |
"jitter_loss_rate": { | |
"type": "number", | |
"format": "float" | |
}, | |
"jitter_burst_rate": { | |
"type": "number", | |
"format": "float" | |
}, | |
"flaw_total": { | |
"type": "number", | |
"format": "float" | |
}, | |
"packet_cnt": { | |
"type": "number", | |
"format": "float" | |
}, | |
"packet_loss_perc": { | |
"type": "number", | |
"format": "float" | |
} | |
} | |
}, | |
"iso_date": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"knocker_timestamp": { | |
"type": "object", | |
"properties": { | |
"created": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"updated": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"destroyed": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"left": { | |
"$ref": "#/components/schemas/iso_date" | |
} | |
} | |
}, | |
"timestamp": { | |
"description": "Timestamp", | |
"type": "object", | |
"properties": { | |
"created": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"updated": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"destroyed": { | |
"$ref": "#/components/schemas/iso_date" | |
} | |
} | |
}, | |
"member_timestamp": { | |
"type": "object", | |
"properties": { | |
"invited": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"joined": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"left": { | |
"$ref": "#/components/schemas/iso_date" | |
} | |
} | |
}, | |
"reason": { | |
"type": "object", | |
"properties": { | |
"code": { | |
"type": "string" | |
}, | |
"text": { | |
"type": "string" | |
} | |
} | |
}, | |
"reason_v03": { | |
"type": "object", | |
"properties": { | |
"code": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"text": { | |
"$ref": "#/components/schemas/string_200" | |
} | |
} | |
}, | |
"hangup": { | |
"type": "object", | |
"properties": { | |
"direction": { | |
"$ref": "#/components/schemas/full_direction" | |
}, | |
"quality": { | |
"$ref": "#/components/schemas/quality" | |
}, | |
"bandwidth": { | |
"type": "object", | |
"properties": { | |
"bytes_in": { | |
"type": "number", | |
"format": "float" | |
}, | |
"bytes_out": { | |
"type": "number", | |
"format": "float" | |
} | |
}, | |
"required": [ | |
"bytes_in", | |
"bytes_out" | |
] | |
}, | |
"channel": { | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
"reason": { | |
"type": "object", | |
"properties": { | |
"text": { | |
"type": "string" | |
}, | |
"code": { | |
"type": "string" | |
}, | |
"sip_code": { | |
"type": "integer" | |
} | |
}, | |
"required": [ | |
"text", | |
"code", | |
"sip_code" | |
] | |
} | |
}, | |
"required": [ | |
"direction", | |
"quality", | |
"bandwidth", | |
"channel" | |
] | |
}, | |
"answered": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"direction": { | |
"$ref": "#/components/schemas/full_direction" | |
} | |
}, | |
"required": [ | |
"channel", | |
"direction" | |
] | |
}, | |
"date": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"string_200": { | |
"type": "string", | |
"maxLength": 200 | |
}, | |
"string_500": { | |
"type": "string", | |
"maxLength": 500 | |
}, | |
"url_v03": { | |
"type": "string", | |
"format": "uri", | |
"maxLength": 2048 | |
}, | |
"image_url": { | |
"description": "A link to an image for conversations' and users' avatars", | |
"example": "https://example.com/image.png", | |
"type": "string", | |
"format": "uri" | |
}, | |
"href_conversation": { | |
"description": "A link towards a conversation included in Conversation Service API", | |
"example": "https://api.nexmo.com/beta/converations/CON-63f61863-4a51-4f6b-86e1-46edebio0391", | |
"type": "string", | |
"format": "uri" | |
}, | |
"conversation_uuid": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"phone_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"phone" | |
] | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"number": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type", | |
"number" | |
] | |
}, | |
"phone_from_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"phone" | |
] | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"number": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type", | |
"number" | |
] | |
}, | |
"sip_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip" | |
] | |
}, | |
"uri": { | |
"type": "string", | |
"pattern": "^(sip|sips):\\+?([\\w|:.\\-@;,=%&]+)" | |
}, | |
"username": { | |
"type": "string" | |
}, | |
"password": { | |
"type": "string" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
} | |
}, | |
"required": [ | |
"type", | |
"uri" | |
] | |
}, | |
"app_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app" | |
] | |
}, | |
"user": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
"websocket_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"websocket" | |
] | |
}, | |
"uri": { | |
"oneOf": [ | |
{ | |
"type": "string", | |
"pattern": "^(ws|wss):\\/\\/[a-zA-Z0-9~#%@&-_?\\\\/.,:;)(\\][]*$" | |
}, | |
{ | |
"type": "string" | |
} | |
] | |
}, | |
"content-type": { | |
"type": "string" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
} | |
}, | |
"required": [ | |
"type", | |
"uri" | |
] | |
}, | |
"error_code": { | |
"type": "string" | |
}, | |
"vbc_endpoint": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"vbc" | |
] | |
}, | |
"extension": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type", | |
"extension" | |
] | |
}, | |
"date_start": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"date_end": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"page_size": { | |
"description": "The amount of records returned in this response", | |
"type": "number", | |
"format": "float", | |
"minimum": 1, | |
"maximum": 100, | |
"default": 10 | |
}, | |
"record_index": { | |
"description": "Return `page_size` amount of conversations from this index in the response. That is, if your request returns 300 conversations, set `record_index` to 5 in order to return conversations 50 to 59. The default value is 0. That is, the first `page_size` calls.", | |
"type": "number", | |
"format": "float", | |
"minimum": 0 | |
}, | |
"order": { | |
"type": "string", | |
"enum": [ | |
"asc", | |
"desc", | |
"ASC", | |
"DESC" | |
], | |
"description": "Return the records in ascending or descending order.", | |
"default": "asc" | |
}, | |
"userLite": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"name": { | |
"type": "string" | |
}, | |
"href": { | |
"type": "string", | |
"format": "uri" | |
} | |
}, | |
"required": [ | |
"id", | |
"href" | |
] | |
}, | |
"userConversation": { | |
"type": "object", | |
"properties": { | |
"name": { | |
"$ref": "#/components/schemas/name_conversation" | |
}, | |
"image_url": { | |
"$ref": "#/components/schemas/image_url" | |
}, | |
"sequence_number": { | |
"type": "number", | |
"format": "float" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/conversation_uuid" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/member_state" | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/display_name" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/timestamp" | |
}, | |
"href": { | |
"type": "string", | |
"format": "uri" | |
} | |
}, | |
"required": [ | |
"name", | |
"sequence_number", | |
"id", | |
"state", | |
"member_id", | |
"timestamp", | |
"href" | |
] | |
}, | |
"ttl": { | |
"type": "number", | |
"format": "float", | |
"minimum": 0 | |
}, | |
"ttl_v03": { | |
"type": "integer", | |
"minimum": 0 | |
}, | |
"session_ttl": { | |
"type": "integer", | |
"minimum": 1 | |
}, | |
"channel_type": { | |
"description": "Channel type", | |
"example": "phone", | |
"type": "string", | |
"enum": [ | |
"app", | |
"phone", | |
"sip", | |
"websocket", | |
"vbc" | |
] | |
}, | |
"leg": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/channel_type" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"direction": { | |
"$ref": "#/components/schemas/full_direction" | |
}, | |
"rate": { | |
"type": "number", | |
"format": "float" | |
}, | |
"price": { | |
"type": "number", | |
"format": "float" | |
}, | |
"duration": { | |
"type": "number", | |
"format": "float" | |
}, | |
"network": { | |
"type": "string" | |
}, | |
"start_time": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
{ | |
"type": "string" | |
} | |
] | |
}, | |
"end_time": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
{ | |
"type": "string" | |
} | |
] | |
}, | |
"_links": { | |
"$ref": "#/components/schemas/_links" | |
}, | |
"uuid": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"conversation_uuid": { | |
"$ref": "#/components/schemas/conversation_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"status", | |
"from", | |
"to" | |
] | |
}, | |
"leg_v03": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/channel_type" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"direction": { | |
"$ref": "#/components/schemas/full_direction" | |
}, | |
"rate": { | |
"type": "number", | |
"format": "float" | |
}, | |
"price": { | |
"type": "number", | |
"format": "float" | |
}, | |
"duration": { | |
"type": "number", | |
"format": "float" | |
}, | |
"network": { | |
"type": "string" | |
}, | |
"start_time": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
{ | |
"type": "string" | |
} | |
] | |
}, | |
"end_time": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
{ | |
"type": "string" | |
} | |
] | |
}, | |
"_links": { | |
"$ref": "#/components/schemas/_links" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"status", | |
"from", | |
"to", | |
"id" | |
] | |
}, | |
"leg_status": { | |
"description": "Leg status", | |
"example": "answered", | |
"type": "string", | |
"enum": [ | |
"started", | |
"ringing", | |
"answered", | |
"completed", | |
"machine", | |
"failed", | |
"busy", | |
"timeout", | |
"cancelled", | |
"rejected" | |
] | |
}, | |
"leg_status_history": { | |
"type": "object", | |
"properties": { | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"date": { | |
"$ref": "#/components/schemas/date" | |
} | |
}, | |
"required": [ | |
"conversation_id", | |
"member_id", | |
"status", | |
"date" | |
] | |
}, | |
"leg_status_history_knocker": { | |
"type": "object", | |
"properties": { | |
"knocker_id": { | |
"$ref": "#/components/schemas/knocking_id" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"date": { | |
"$ref": "#/components/schemas/date" | |
} | |
}, | |
"required": [ | |
"knocker_id", | |
"status", | |
"date" | |
] | |
}, | |
"legs": { | |
"type": "object", | |
"properties": { | |
"leg_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
} | |
}, | |
"required": [ | |
"leg_id", | |
"status" | |
] | |
}, | |
"asr_done": { | |
"type": "object", | |
"properties": { | |
"results": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/asr_result" | |
}, | |
"nullable": true | |
}, | |
"error": { | |
"type": "string", | |
"nullable": true | |
}, | |
"asr_id": { | |
"$ref": "#/components/schemas/asr_id" | |
}, | |
"call_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"timeout_reason": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"required": [ | |
"results", | |
"error", | |
"asr_id" | |
] | |
}, | |
"asr_record_done": { | |
"type": "object", | |
"properties": { | |
"error": { | |
"type": "string", | |
"nullable": true | |
}, | |
"asr_id": { | |
"$ref": "#/components/schemas/asr_id" | |
}, | |
"call_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"destination_url": { | |
"type": "string", | |
"format": "uri" | |
}, | |
"format": { | |
"type": "string", | |
"enum": [ | |
"mp3", | |
"wav" | |
] | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"size": { | |
"type": "number", | |
"format": "float" | |
}, | |
"media_service_uuid": { | |
"$ref": "#/components/schemas/uuid" | |
} | |
}, | |
"required": [ | |
"error", | |
"asr_id", | |
"call_id", | |
"destination_url", | |
"format", | |
"start_time", | |
"end_time", | |
"size", | |
"media_service_uuid" | |
] | |
}, | |
"asr_result": { | |
"type": "object", | |
"properties": { | |
"word": { | |
"type": "string" | |
}, | |
"confidence": { | |
"type": "number", | |
"format": "float" | |
} | |
}, | |
"required": [ | |
"word", | |
"confidence" | |
] | |
}, | |
"device_registration_v03": { | |
"type": "object", | |
"properties": { | |
"device_type": { | |
"$ref": "#/components/schemas/device_type" | |
}, | |
"device_push_environment": { | |
"type": "string", | |
"enum": [ | |
"sandbox" | |
] | |
}, | |
"tokens": { | |
"type": "object", | |
"properties": { | |
"push": { | |
"$ref": "#/components/schemas/device_token" | |
}, | |
"voip": { | |
"$ref": "#/components/schemas/device_token" | |
} | |
} | |
}, | |
"_links": { | |
"$ref": "#/components/schemas/_links" | |
} | |
}, | |
"required": [ | |
"device_type", | |
"tokens", | |
"_links" | |
] | |
}, | |
"href": { | |
"description": "A link towards a resources included in Conversation Service API", | |
"type": "object", | |
"properties": { | |
"href": { | |
"type": "string", | |
"format": "uri" | |
} | |
} | |
}, | |
"leg_modify_action": { | |
"type": "string", | |
"enum": [ | |
"hangup", | |
"mute", | |
"unmute", | |
"earmuff", | |
"unearmuff", | |
"answer" | |
] | |
}, | |
"leg_list": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/leg_id" | |
} | |
}, | |
"leg_list_v03": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/leg_id_v03" | |
} | |
}, | |
"_links": { | |
"type": "object", | |
"properties": { | |
"self": { | |
"$ref": "#/components/schemas/href" | |
} | |
} | |
}, | |
"audio_error": { | |
"description": "Audio error", | |
"nullable": true, | |
"example": "some_audio_error", | |
"type": "string" | |
}, | |
"user_channel": { | |
"type": "array", | |
"items": { | |
"type": "object" | |
} | |
}, | |
"headers": { | |
"type": "object" | |
}, | |
"string_uri": { | |
"description": "String URI", | |
"example": "https://example.com/", | |
"type": "string" | |
}, | |
"sdp": { | |
"type": "string" | |
}, | |
"channel_lite": { | |
"type": "object", | |
"properties": { | |
"to": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/channel_endpoint" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/channel_type" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
"offer": { | |
"type": "object", | |
"properties": { | |
"sdp": { | |
"$ref": "#/components/schemas/sdp" | |
} | |
}, | |
"required": [ | |
"sdp" | |
] | |
}, | |
"device_type": { | |
"type": "string", | |
"enum": [ | |
"android", | |
"ios" | |
] | |
}, | |
"device_token": { | |
"type": "object", | |
"properties": { | |
"token": { | |
"type": "string" | |
}, | |
"bundle_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"token" | |
] | |
}, | |
"device_token_v03": { | |
"type": "object", | |
"properties": { | |
"token": { | |
"$ref": "#/components/schemas/string_500" | |
}, | |
"bundle_id": { | |
"$ref": "#/components/schemas/string_500" | |
} | |
}, | |
"required": [ | |
"token" | |
] | |
}, | |
"language": { | |
"type": "string", | |
"maxLength": 35 | |
}, | |
"style": { | |
"type": "integer", | |
"minimum": 0, | |
"maximum": 1000 | |
}, | |
"dtmf_pattern": { | |
"pattern": "^([abcdABCD0-9*#pP])+$", | |
"example": "abcd11", | |
"type": "string" | |
}, | |
"channel_endpoint": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/phone_from_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/sip_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/app_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/vbc_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/websocket_endpoint" | |
} | |
] | |
}, | |
"phone_endpoint_v03": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"phone" | |
] | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
}, | |
"number": { | |
"$ref": "#/components/schemas/string_200" | |
} | |
}, | |
"required": [ | |
"type", | |
"number" | |
] | |
}, | |
"sip_endpoint_v03": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip" | |
] | |
}, | |
"uri": { | |
"type": "string", | |
"maxLength": 200, | |
"pattern": "^(sip|sips):\\+?([\\w|:.\\-@;,=%&]+)" | |
}, | |
"username": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"password": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
} | |
}, | |
"required": [ | |
"type", | |
"uri" | |
] | |
}, | |
"app_endpoint_v03": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app" | |
] | |
}, | |
"user": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"type" | |
] | |
}, | |
"websocket_endpoint_v03": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"websocket" | |
] | |
}, | |
"uri": { | |
"oneOf": [ | |
{ | |
"type": "string", | |
"maxLength": 200, | |
"pattern": "^(ws|wss):\\/\\/[a-zA-Z0-9~#%@&-_?\\\\/.,:;)(\\][]*$" | |
}, | |
{ | |
"type": "string", | |
"maxLength": 200 | |
} | |
] | |
}, | |
"content-type": { | |
"$ref": "#/components/schemas/string_200" | |
}, | |
"headers": { | |
"$ref": "#/components/schemas/headers" | |
} | |
}, | |
"required": [ | |
"type", | |
"uri" | |
] | |
}, | |
"channel_endpoint_v03": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/phone_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/sip_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/app_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/vbc_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/websocket_endpoint_v03" | |
} | |
] | |
}, | |
"numbers_v03": { | |
"type": "array", | |
"items": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/phone_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/sip_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/app_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/websocket_endpoint_v03" | |
}, | |
{ | |
"$ref": "#/components/schemas/vbc_endpoint" | |
} | |
] | |
} | |
}, | |
"numbers": { | |
"description": "An object containing number on different channels. ", | |
"type": "array", | |
"items": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/phone_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/sip_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/app_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/websocket_endpoint" | |
}, | |
{ | |
"$ref": "#/components/schemas/vbc_endpoint" | |
} | |
] | |
} | |
}, | |
"event_state": { | |
"oneOf": [ | |
{ | |
"type": "string", | |
"nullable": true | |
}, | |
{ | |
"type": "object" | |
} | |
] | |
}, | |
"level": { | |
"type": "number", | |
"format": "double", | |
"minimum": -1, | |
"maximum": 1 | |
}, | |
"user_embedded": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/display_name_v03" | |
} | |
}, | |
"required": [ | |
"id", | |
"name" | |
] | |
}, | |
"from_user": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"type": "string" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/display_name_v03" | |
}, | |
"image_url": { | |
"type": "string", | |
"format": "uri" | |
}, | |
"custom_data": { | |
"type": "object" | |
} | |
} | |
}, | |
"from_member": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
} | |
} | |
}, | |
"event_embedded": { | |
"type": "object", | |
"properties": { | |
"from_user": { | |
"$ref": "#/components/schemas/from_user" | |
}, | |
"from_member": { | |
"$ref": "#/components/schemas/from_member" | |
} | |
} | |
}, | |
"transcription": { | |
"type": "boolean" | |
}, | |
"transcription_url": { | |
"type": "string", | |
"format": "uri", | |
"nullable": true | |
}, | |
"ApplicationResponse": { | |
"properties": { | |
"id": { | |
"type": "string", | |
"example": "78d335fa323d01149c3dd6f0d48968cf", | |
"description": "The application's ID" | |
}, | |
"name": { | |
"type": "string", | |
"example": "My Application", | |
"description": "Friendly identifier for your application. This is not unique" | |
}, | |
"capabilities": { | |
"type": "object", | |
"description": "Configuration for the products available in this application", | |
"properties": { | |
"voice": { | |
"type": "object", | |
"description": "Voice related configuration", | |
"properties": { | |
"webhooks": { | |
"type": "object", | |
"properties": { | |
"answer_url": { | |
"type": "object", | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://example.com/webhooks/answer", | |
"description": "The URL that Nexmo requests when a call is placed/received. Must return an NCCO" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "POST", | |
"description": "The HTTP method used to fetch your NCCO from your `answer_url`" | |
} | |
} | |
}, | |
"fallback_answer_url": { | |
"type": "object", | |
"description": "If your `answer_url` is offline or returns a HTTP error code, Nexmo will make a request to a\n`fallback_answer_url` if it is set and if a\n`fallback_url` is not set. This URL must return an NCCO.\n", | |
"x-nexmo-developer-collection-description-shown": true, | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://fallback.example.com/webhooks/answer" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "GET", | |
"enum": [ | |
"GET", | |
"POST" | |
] | |
} | |
} | |
}, | |
"fallback_url": { | |
"type": "object", | |
"description": "If your `answer_url` is offline or returns a HTTP error code, Nexmo will make a request to a\n`fallback_url` if it is set. This URL must return an NCCO.\n", | |
"x-nexmo-developer-collection-description-shown": true, | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://fallback.example.com/webhooks/answer" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "GET", | |
"enum": [ | |
"GET", | |
"POST" | |
] | |
} | |
} | |
}, | |
"event_url": { | |
"type": "object", | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://example.com/webhooks/event", | |
"description": "The URL that Nexmo sends events related to your call to" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "POST", | |
"description": "The HTTP method used to send events to your server" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"messages": { | |
"type": "object", | |
"description": "Messages / Dispatch related configuration", | |
"properties": { | |
"webhooks": { | |
"type": "object", | |
"properties": { | |
"inbound_url": { | |
"type": "object", | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://example.com/webhooks/inbound", | |
"description": "The URL that Nexmo forwards inbound messages to on your server" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "POST", | |
"description": "The HTTP method used to send inbound messages to your server" | |
} | |
} | |
}, | |
"status_url": { | |
"type": "object", | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://example.com/webhooks/status", | |
"description": "The URL that Nexmo sends events related to your messages to" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "POST", | |
"description": "The HTTP method used to send events to your server (always `POST`)" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"rtc": { | |
"type": "object", | |
"description": "RTC / Conversation Service related configuration", | |
"properties": { | |
"webhooks": { | |
"type": "object", | |
"properties": { | |
"event_url": { | |
"type": "object", | |
"properties": { | |
"address": { | |
"type": "string", | |
"example": "https://example.com/webhooks/event" | |
}, | |
"http_method": { | |
"type": "string", | |
"example": "POST" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"vbc": { | |
"type": "object", | |
"description": "Specify the `vbc` capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object." | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"type": [ | |
"object" | |
], | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"maxLength": 100, | |
"pattern": "^custom:[\\w\\-:]+" | |
}, | |
"body": { | |
"type": "object" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"body", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:play" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"queue": { | |
"type": "boolean" | |
}, | |
"level": { | |
"$ref": "#/components/schemas/level" | |
}, | |
"loop": { | |
"type": "integer" | |
}, | |
"stream_url": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/string_uri" | |
} | |
}, | |
"play_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"level", | |
"loop", | |
"stream_url", | |
"play_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:play:stop" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"play_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"play_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:say" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"level": { | |
"$ref": "#/components/schemas/level" | |
}, | |
"loop": { | |
"type": "integer" | |
}, | |
"queue": { | |
"type": "boolean" | |
}, | |
"voice_name": { | |
"type": "string" | |
}, | |
"language": { | |
"$ref": "#/components/schemas/language" | |
}, | |
"style": { | |
"$ref": "#/components/schemas/style" | |
}, | |
"text": { | |
"type": "string" | |
}, | |
"ssml": { | |
"type": "boolean" | |
}, | |
"say_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"level", | |
"loop", | |
"text", | |
"say_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:say:stop" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"say_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"say_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:dtmf" | |
] | |
}, | |
"body": { | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"digits": { | |
"$ref": "#/components/schemas/dtmf_pattern" | |
}, | |
"digit": { | |
"$ref": "#/components/schemas/dtmf_pattern" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"dtmf_seq": { | |
"type": "integer" | |
}, | |
"dtmf_id": { | |
"type": "string" | |
}, | |
"method": { | |
"type": "string", | |
"enum": [ | |
"in" | |
] | |
}, | |
"duration": { | |
"type": "integer" | |
} | |
}, | |
"required": [ | |
"method", | |
"duration" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"digits": { | |
"$ref": "#/components/schemas/dtmf_pattern" | |
}, | |
"digit": { | |
"$ref": "#/components/schemas/dtmf_pattern" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"dtmf_seq": { | |
"type": "integer" | |
}, | |
"dtmf_id": { | |
"type": "string" | |
}, | |
"duration": { | |
"type": "integer" | |
} | |
} | |
} | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:record" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"validity": { | |
"type": "integer", | |
"minimum": 1 | |
}, | |
"streamed": { | |
"type": "boolean" | |
}, | |
"format": { | |
"type": "string" | |
}, | |
"beep_start": { | |
"type": "boolean" | |
}, | |
"beep_stop": { | |
"type": "boolean" | |
}, | |
"detect_speech": { | |
"type": "boolean" | |
}, | |
"split": { | |
"type": "boolean" | |
}, | |
"multitrack": { | |
"type": "boolean" | |
}, | |
"channels": { | |
"type": "integer", | |
"minimum": 1, | |
"maximum": 32 | |
}, | |
"transcription": { | |
"$ref": "#/components/schemas/transcription" | |
}, | |
"recording_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"recording_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:record:stop" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"record_id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"record_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:ringing:start" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:ringing:stop" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"image" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"representations": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
} | |
} | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:mute:on" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"rtc_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"to": { | |
"$ref": "#/components/schemas/member_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"to" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:mute:off" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"rtc_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"to": { | |
"$ref": "#/components/schemas/member_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"to" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:earmuff:on" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"rtc_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:earmuff:off" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"rtc_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"image:seen" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
}, | |
"required": [ | |
"event_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"image:delivered" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
}, | |
"required": [ | |
"event_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"text": { | |
"$ref": "#/components/schemas/text_string" | |
}, | |
"language": { | |
"type": "string" | |
}, | |
"channels": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"enum": [ | |
"sms", | |
"app" | |
] | |
}, | |
"minItems": 1 | |
}, | |
"edited": { | |
"type": "object", | |
"properties": { | |
"edited_by": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"edited_at": { | |
"$ref": "#/components/schemas/date" | |
} | |
}, | |
"required": [ | |
"edited_by", | |
"edited_at" | |
] | |
} | |
}, | |
"required": [ | |
"text" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text:seen" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
}, | |
"required": [ | |
"event_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text:delivered" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
}, | |
"required": [ | |
"event_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text:typing:on" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"activity": { | |
"type": "integer" | |
}, | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text:typing:off" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"activity": { | |
"type": "integer" | |
}, | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"text:update" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"text": { | |
"$ref": "#/components/schemas/text_string" | |
}, | |
"original_event_id": { | |
"type": "integer" | |
} | |
}, | |
"required": [ | |
"text", | |
"original_event_id" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"member:invited" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"cname": { | |
"type": "string" | |
}, | |
"conversation": { | |
"type": "object", | |
"properties": { | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/name_conversation" | |
}, | |
"image_url": { | |
"$ref": "#/components/schemas/image_url" | |
} | |
}, | |
"required": [ | |
"conversation_id", | |
"name" | |
] | |
}, | |
"invited_by": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/member_id" | |
}, | |
{ | |
"nullable": true | |
} | |
] | |
}, | |
"user": { | |
"type": "object", | |
"properties": { | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"media": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/member_media" | |
}, | |
{ | |
"$ref": "#/components/schemas/media" | |
} | |
] | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
}, | |
"name": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"member_id", | |
"user_id", | |
"media", | |
"name" | |
] | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"media": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/member_media" | |
}, | |
{ | |
"$ref": "#/components/schemas/media" | |
} | |
] | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/member_timestamp" | |
}, | |
"initiator": { | |
"$ref": "#/components/schemas/initiator" | |
}, | |
"invited_by_member": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"media": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/member_media" | |
}, | |
{ | |
"$ref": "#/components/schemas/media" | |
} | |
] | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/member_name" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/member_state" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/member_timestamp" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
} | |
}, | |
"required": [ | |
"channel", | |
"media", | |
"member_id", | |
"name", | |
"state", | |
"timestamp", | |
"user_id" | |
] | |
} | |
}, | |
"required": [ | |
"channel", | |
"media", | |
"timestamp" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"member:joined" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"user": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/member_name" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
} | |
}, | |
"required": [ | |
"id", | |
"user_id", | |
"name" | |
] | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/member_timestamp" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"initiator": { | |
"$ref": "#/components/schemas/initiator" | |
}, | |
"client_ref": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"timestamp", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"member:left" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"timestamp": { | |
"$ref": "#/components/schemas/member_timestamp" | |
}, | |
"user": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/member_name" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"initiator": { | |
"$ref": "#/components/schemas/initiator" | |
}, | |
"reason": { | |
"$ref": "#/components/schemas/reason" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"timestamp", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"conversation:updated" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/name_conversation" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/timestamp" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
}, | |
"image_url": { | |
"$ref": "#/components/schemas/image_url" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/state_conversation_all" | |
} | |
}, | |
"required": [ | |
"id", | |
"name", | |
"timestamp" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"event:delete" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
} | |
}, | |
"required": [ | |
"event_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"type": "integer" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:status" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"price": { | |
"type": "string" | |
}, | |
"rate": { | |
"type": "string" | |
}, | |
"duration": { | |
"type": "string" | |
}, | |
"to": { | |
"type": "string" | |
}, | |
"from": { | |
"type": "string" | |
}, | |
"network_code": { | |
"type": "string" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"request_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"status": { | |
"type": "string", | |
"enum": [ | |
"failed", | |
"busy", | |
"timeout", | |
"cancelled", | |
"rejected" | |
] | |
}, | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"in" | |
] | |
} | |
}, | |
"required": [ | |
"price", | |
"rate", | |
"duration", | |
"to", | |
"from", | |
"channel", | |
"direction", | |
"status" | |
] | |
} | |
}, | |
"required": [ | |
"application_id", | |
"timestamp", | |
"from", | |
"type", | |
"body" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"type": "integer" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/uuid" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:status" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"price": { | |
"type": "string" | |
}, | |
"rate": { | |
"type": "string" | |
}, | |
"duration": { | |
"type": "string" | |
}, | |
"to": { | |
"type": "string" | |
}, | |
"from": { | |
"type": "string" | |
}, | |
"network_code": { | |
"type": "string" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"request_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"status": { | |
"type": "string", | |
"enum": [ | |
"started", | |
"ringing", | |
"answered", | |
"completed", | |
"machine", | |
"failed", | |
"busy", | |
"timeout", | |
"cancelled", | |
"rejected" | |
] | |
}, | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"out" | |
] | |
} | |
}, | |
"required": [ | |
"price", | |
"rate", | |
"duration", | |
"to", | |
"from", | |
"channel", | |
"direction" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type", | |
"body" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"type": "integer" | |
}, | |
"conversation_id": { | |
"type": "string" | |
}, | |
"application_id": { | |
"type": "string" | |
}, | |
"timestamp": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"from": { | |
"type": "string" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:status" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"price": { | |
"type": "string" | |
}, | |
"rate": { | |
"type": "string" | |
}, | |
"duration": { | |
"type": "string" | |
}, | |
"to": { | |
"type": "string" | |
}, | |
"from": { | |
"type": "string" | |
}, | |
"network_code": { | |
"type": "string" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"request_time": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"start_time": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"end_time": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"status": { | |
"type": "string", | |
"enum": [ | |
"started", | |
"ringing", | |
"answered", | |
"completed", | |
"machine" | |
] | |
}, | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"in" | |
] | |
} | |
}, | |
"required": [ | |
"price", | |
"rate", | |
"duration", | |
"to", | |
"from", | |
"channel", | |
"direction" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type", | |
"body" | |
] | |
} | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:status" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"duration": { | |
"type": "string" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"mos": { | |
"type": "number", | |
"format": "float" | |
}, | |
"price": { | |
"type": "string" | |
}, | |
"price_currency": { | |
"type": "string" | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/iso_date" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"duration", | |
"end_time", | |
"mos", | |
"price", | |
"price_currency", | |
"start_time", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:transfer" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"was_member": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"user_id": { | |
"$ref": "#/components/schemas/user_id" | |
}, | |
"transferred_from": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"was_member", | |
"user_id", | |
"transferred_from", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:hangup" | |
] | |
}, | |
"body": { | |
"$ref": "#/components/schemas/hangup" | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:hangup" | |
] | |
}, | |
"body": { | |
"$ref": "#/components/schemas/hangup" | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:answered" | |
] | |
}, | |
"body": { | |
"$ref": "#/components/schemas/answered" | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:answered" | |
] | |
}, | |
"body": { | |
"$ref": "#/components/schemas/answered" | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:machine" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string" | |
}, | |
"confidence": { | |
"type": "integer" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"type", | |
"confidence", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"member:media" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"audio": { | |
"type": "boolean" | |
}, | |
"media": { | |
"$ref": "#/components/schemas/member_media" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"audio", | |
"media", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:play:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"play_id": { | |
"type": "string" | |
}, | |
"error": { | |
"$ref": "#/components/schemas/audio_error" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"play_id", | |
"channel" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:play:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"play_id": { | |
"type": "string" | |
}, | |
"error": { | |
"$ref": "#/components/schemas/audio_error" | |
} | |
}, | |
"required": [ | |
"play_id" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp" | |
] | |
} | |
] | |
}, | |
{ | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:record:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"recording_id": { | |
"type": "string" | |
}, | |
"destination_url": { | |
"type": "string", | |
"format": "uri" | |
}, | |
"format": { | |
"type": "string" | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/date_start" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/date_end" | |
}, | |
"size": { | |
"type": "number", | |
"format": "float" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"event_id", | |
"recording_id", | |
"destination_url", | |
"format", | |
"start_time", | |
"end_time", | |
"size", | |
"channel" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:record:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"event_id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"recording_id": { | |
"type": "string" | |
}, | |
"destination_url": { | |
"type": "string", | |
"format": "uri" | |
}, | |
"format": { | |
"type": "string" | |
}, | |
"start_time": { | |
"$ref": "#/components/schemas/date_start" | |
}, | |
"end_time": { | |
"$ref": "#/components/schemas/date_end" | |
}, | |
"size": { | |
"type": "number", | |
"format": "float" | |
} | |
}, | |
"required": [ | |
"event_id", | |
"recording_id", | |
"destination_url", | |
"format", | |
"start_time", | |
"end_time", | |
"size" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp" | |
] | |
} | |
] | |
}, | |
{ | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:transcribe:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"request_id": { | |
"type": "string" | |
}, | |
"recording_id": { | |
"type": "string" | |
}, | |
"transcription_url": { | |
"$ref": "#/components/schemas/transcription_url" | |
}, | |
"error": { | |
"$ref": "#/components/schemas/audio_error" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"request_id", | |
"recording_id", | |
"channel" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:transcribe:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"request_id": { | |
"type": "string" | |
}, | |
"recording_id": { | |
"type": "string" | |
}, | |
"transcription_url": { | |
"$ref": "#/components/schemas/transcription_url" | |
}, | |
"error": { | |
"$ref": "#/components/schemas/audio_error" | |
} | |
}, | |
"required": [ | |
"request_id", | |
"recording_id" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/event_state" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp" | |
] | |
} | |
] | |
}, | |
{ | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:ringing" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"outbound" | |
] | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"direction", | |
"channel" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from", | |
"id", | |
"conversation_id" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"sip:ringing" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"direction": { | |
"type": "string", | |
"enum": [ | |
"inbound" | |
] | |
} | |
}, | |
"required": [ | |
"direction", | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
} | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:say:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"say_id": { | |
"type": "string" | |
}, | |
"error": { | |
"$ref": "#/components/schemas/audio_error" | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"say_id" | |
] | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:speaking:on" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:speaking:off" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"channel" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"leg:status:update" | |
] | |
}, | |
"body": { | |
"oneOf": [ | |
{ | |
"type": "object", | |
"properties": { | |
"leg_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app" | |
] | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"statusHistory": { | |
"type": "array", | |
"items": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/leg_status_history" | |
}, | |
{ | |
"$ref": "#/components/schemas/leg_status_history_knocker" | |
} | |
] | |
} | |
} | |
}, | |
"required": [ | |
"leg_id", | |
"type", | |
"status" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"leg_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/leg_status" | |
}, | |
"statusHistory": { | |
"type": "array", | |
"items": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/leg_status_history" | |
}, | |
{ | |
"$ref": "#/components/schemas/leg_status_history_knocker" | |
} | |
] | |
} | |
}, | |
"direction": { | |
"$ref": "#/components/schemas/full_direction" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"phone", | |
"sip", | |
"websocket", | |
"vbc" | |
] | |
} | |
}, | |
"required": [ | |
"leg_id", | |
"type", | |
"status", | |
"direction" | |
] | |
} | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:asr:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"asr": { | |
"$ref": "#/components/schemas/asr_done" | |
} | |
}, | |
"required": [ | |
"channel", | |
"asr" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"audio:asr:record:done" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
}, | |
"asr": { | |
"$ref": "#/components/schemas/asr_record_done" | |
} | |
}, | |
"required": [ | |
"channel", | |
"asr" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"conversation:created" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/name_conversation" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/timestamp" | |
}, | |
"state": { | |
"$ref": "#/components/schemas/state_conversation_all" | |
}, | |
"display_name": { | |
"$ref": "#/components/schemas/empty_display_name" | |
}, | |
"image_url": { | |
"$ref": "#/components/schemas/image_url" | |
} | |
}, | |
"required": [ | |
"id", | |
"name", | |
"timestamp", | |
"state" | |
] | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"conversation:deleted" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"name": { | |
"$ref": "#/components/schemas/name_conversation" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/timestamp" | |
}, | |
"reason": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"id", | |
"name", | |
"timestamp", | |
"reason" | |
] | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app:knocking:cancel" | |
] | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"user": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"reason": { | |
"$ref": "#/components/schemas/reason" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/knocker_timestamp" | |
} | |
}, | |
"required": [ | |
"user", | |
"timestamp" | |
] | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"app:knocking" | |
] | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"user": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"$ref": "#/components/schemas/user_id" | |
} | |
}, | |
"required": [ | |
"id" | |
] | |
}, | |
"channel": { | |
"oneOf": [ | |
{ | |
"$ref": "#/components/schemas/channel_lite" | |
}, | |
{ | |
"$ref": "#/components/schemas/channel" | |
} | |
] | |
} | |
}, | |
"required": [ | |
"user", | |
"channel" | |
] | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"from" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:terminate" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"member_id", | |
"rtc_id" | |
] | |
}, | |
"session_destination": { | |
"$ref": "#/components/schemas/session_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"conversation_id", | |
"session_destination" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:offer" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"sdp": { | |
"type": "string" | |
}, | |
"member_id": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"leg_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"member_leg_id": { | |
"$ref": "#/components/schemas/leg_id" | |
}, | |
"media_settings": { | |
"type": "object" | |
}, | |
"name": { | |
"type": "string" | |
} | |
}, | |
"required": [ | |
"sdp", | |
"leg_id", | |
"member_leg_id" | |
] | |
}, | |
"session_destination": { | |
"$ref": "#/components/schemas/session_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"conversation_id", | |
"session_destination" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"rtc:answer" | |
] | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"answer": { | |
"type": "string" | |
}, | |
"rtc_id": { | |
"$ref": "#/components/schemas/rtc_id" | |
} | |
}, | |
"required": [ | |
"answer", | |
"rtc_id" | |
] | |
}, | |
"isFromMB": { | |
"type": "boolean" | |
}, | |
"session_destination": { | |
"$ref": "#/components/schemas/session_id" | |
} | |
}, | |
"required": [ | |
"type", | |
"application_id", | |
"timestamp", | |
"conversation_id", | |
"isFromMB", | |
"session_destination" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"mixer:publisher:created" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"mixer:publisher:destroyed" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"mixer:subscriber:created" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"type": { | |
"type": "string", | |
"enum": [ | |
"mixer:subscriber:destroyed" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": {} | |
}, | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/nullable_member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
} | |
}, | |
"required": [ | |
"type", | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp" | |
] | |
}, | |
{ | |
"type": "object", | |
"properties": { | |
"params": { | |
"type": "object" | |
}, | |
"id": { | |
"$ref": "#/components/schemas/event_id" | |
}, | |
"conversation_id": { | |
"$ref": "#/components/schemas/conversation_id" | |
}, | |
"application_id": { | |
"$ref": "#/components/schemas/application_id" | |
}, | |
"timestamp": { | |
"$ref": "#/components/schemas/date" | |
}, | |
"from": { | |
"$ref": "#/components/schemas/member_id" | |
}, | |
"_embedded": { | |
"$ref": "#/components/schemas/event_embedded" | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"message:received" | |
] | |
}, | |
"body": { | |
"type": "object", | |
"properties": { | |
"message": { | |
"type": "object" | |
} | |
}, | |
"required": [ | |
"message" | |
] | |
} | |
}, | |
"required": [ | |
"id", | |
"conversation_id", | |
"application_id", | |
"timestamp", | |
"from", | |
"type" | |
] | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment