mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-16 08:24:09 +01:00
44 lines
1.5 KiB
YAML
44 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 1. This field is a string such that experimental
|
|
implementations can use non-integer versions. This field was an integer
|
|
in the previous spec version and implementations must accept an integer
|
|
0.
|
|
party_id:
|
|
type: string
|
|
description: 'This identifies the party that sent this event. A client may
|
|
choose to re-use the device ID from end-to-end cryptography for the value
|
|
of this field. '
|
|
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
|
|
- party_id
|
|
type:
|
|
type: string
|
|
enum:
|
|
- m.call.hangup
|
|
|