mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-25 23:43:43 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
36 lines
1.5 KiB
YAML
36 lines
1.5 KiB
YAML
{
|
|
"type": "object",
|
|
"description": "Sent by either party to signal their termination of the call. This can be sent either once the call has has been established or before to abort the call.",
|
|
"allOf": [{
|
|
"$ref": "core-event-schema/room_event.yaml"
|
|
}],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"description": "The ID of the call this event relates to."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"description": "The version of the VoIP specification this message adheres to. This specification is version 0."
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "Optional error reason for the hangup. This should not be provided when the user naturally ends or rejects the call. When there was an error in the call negotiation, this should be ``ice_failed`` for when ICE negotiation fails or ``invite_timeout`` for when the other party did not answer in time.",
|
|
"enum": [
|
|
"ice_failed",
|
|
"invite_timeout"
|
|
]
|
|
}
|
|
},
|
|
"required": ["call_id", "version"]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["m.call.hangup"]
|
|
}
|
|
}
|
|
}
|