matrix-spec/data/event-schemas/schema/m.call.select_answer.yaml
Kévin Commaille ba960f8d32
Improve "Voice over IP" module of CS API (#2374)
* Convert m.call.* schemas syntax to YAML

For consistency.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Clarify user ID format in m.call.invite

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add links to definitions

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Improve call schemas

To look more consistent with other schemas.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Clarify URI format in GET /voip/turnServer

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Fix regex

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2026-05-12 16:36:31 +01:00

24 lines
1.2 KiB
YAML

$schema: https://json-schema.org/draft/2020-12/schema
type: object
description: This event is sent by the caller's client once it has decided which other client to talk to, by selecting one of multiple possible incoming `m.call.answer` events. Its `selected_party_id` field indicates the answer it's chosen. The `call_id` and `party_id` of the caller is also included. If the callee's client sees a `select_answer` for an answer with party ID other than the one it sent, it ends the call and informs the user the call was answered elsewhere. It does not send any events. Media can start flowing before this event is seen or even sent. Clients that implement previous versions of this specification will ignore this event and behave as they did before.
x-addedInMatrixVersion: '1.7'
x-weight: 50
allOf:
- $ref: core-event-schema/room_event.yaml
properties:
content:
type: object
allOf:
- $ref: core-event-schema/call_event.yaml
properties:
selected_party_id:
type: string
description: The `party_id` field from the answer event that the caller chose.
required:
- selected_party_id
type:
type: string
enum:
- m.call.select_answer