mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-06 07:53:42 +01:00
57 lines
2.5 KiB
YAML
57 lines
2.5 KiB
YAML
{
|
|
"type": "object",
|
|
"description": "This event is sent by the caller when they wish to establish a call.",
|
|
"allOf": [{
|
|
"$ref": "core-event-schema/room_event.yaml"
|
|
}],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"call_id": {
|
|
"type": "string",
|
|
"description": "A unique identifier for the call."
|
|
},
|
|
"offer": {
|
|
"type": "object",
|
|
"title": "Offer",
|
|
"description": "The session description object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["offer"],
|
|
"description": "The type of session description."
|
|
},
|
|
"sdp": {
|
|
"type": "string",
|
|
"description": "The SDP text of the session description."
|
|
}
|
|
},
|
|
"required": ["type", "sdp"]
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"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. "
|
|
},
|
|
"lifetime": {
|
|
"type": "integer",
|
|
"description": "The time in milliseconds that the invite is valid for. Once the invite age exceeds this value, clients should discard it. They should also no longer show the call as awaiting an answer in the UI."
|
|
},
|
|
"invitee": {
|
|
"type": "string",
|
|
"description": "The ID of the user being called.",
|
|
}
|
|
},
|
|
"required": ["call_id", "offer", "version", "lifetime", "party_id"]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["m.call.invite"]
|
|
}
|
|
}
|
|
}
|