Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-04 18:24:10 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add missing reason property to m.call.hangup

Browse source 
Fixes https://github.com/matrix-org/matrix-doc/issues/1689
This commit is contained in:
Travis Ralston 2019-05-26 22:08:04 -06:00
parent 5c268ef21f
commit 00f97636a2
2 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2031.clarification Normal file
View file

@ -0,0 +1 @@
Add missing ``reason`` to ``m.call.hangup``.

10
event-schemas/schema/m.call.hangup
View file

@ -1,6 +1,6 @@
{ {
"type": "object", "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.", "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. The ``reason`` for the hangup is expected to be provided when there was an error in the call negotiation, such as ``ice_failed`` for when ICE negotiation fails or ``invite_timeout`` for when the other party did not answer in time.",
"allOf": [{ "allOf": [{
"$ref": "core-event-schema/room_event.yaml" "$ref": "core-event-schema/room_event.yaml"
}], }],
@ -15,6 +15,14 @@
"version": { "version": {
"type": "integer", "type": "integer",
"description": "The version of the VoIP specification this message adheres to. This specification is version 0." "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.",
"enum": [
"ice_failed",
"invite_timeout"
]
} }
}, },
"required": ["call_id", "version"] "required": ["call_id", "version"]