Aoba Voice Call Signaling API 1.0.0 documentation

Aoba Voice Call Signaling API 1.0.0

MIT
application/json

WebRTC voice call signaling over XMPP IQ stanzas.

Purpose

This API provides WebRTC call setup and management via XMPP, including:

Call initiation and acceptance
SDP offer/answer exchange
ICE candidate exchange
Call termination and status updates

Transport

Voice call signals are transmitted via XMPP IQ stanzas using the custom namespace urn:xmpp:call:0. This allows call signaling to share the existing XMPP WebSocket connection used for chat messaging.

Call Flow

Caller                                          Callee
  │                                                │
  │  1. call:initiate                             │
  │  ─────────────────────────────────────────►   │
  │                                                │
  │  2. call:accept (or call:reject/call:busy)    │
  │  ◄─────────────────────────────────────────   │
  │                                                │
  │  3. call:offer (SDP)                          │
  │  ─────────────────────────────────────────►   │
  │                                                │
  │  4. call:answer (SDP)                         │
  │  ◄─────────────────────────────────────────   │
  │                                                │
  │  5. call:ice-candidate (multiple, both ways)  │
  │  ◄────────────────────────────────────────►   │
  │                                                │
  │  [WebRTC media connection established]         │
  │                                                │
  │  6. call:mute-change (optional, both ways)    │
  │  ◄────────────────────────────────────────►   │
  │                                                │
  │  7. call:hangup                               │
  │  ◄────────────────────────────────────────►   │
  │                                                │

Signal Types

Signal	Direction	Description
`call:initiate`	Caller → Callee	Start a new call
`call:accept`	Callee → Caller	Accept incoming call
`call:reject`	Callee → Caller	Decline incoming call
`call:offer`	Caller → Callee	WebRTC SDP offer
`call:answer`	Callee → Caller	WebRTC SDP answer
`call:ice-candidate`	Both ways	ICE candidate for NAT traversal
`call:hangup`	Either party	End the call
`call:busy`	Callee → Caller	Callee is on another call
`call:mute-change`	Both ways	Mute state changed

End Reasons

When a call ends (via call:hangup), the reason is included:

completed: Normal hangup after connected call
rejected: Callee declined the call
timeout: No answer within timeout period (30 seconds)
busy: Callee was on another call
failed: ICE/network connection failed
cancelled: Caller cancelled before callee answered

Servers

ws://localhost:8082/wsdevelopment
Local development server
wss://staging.aoba.chat/wssstaging
Staging server (TLS required)
wss://api.aoba.chat/wssproduction
Production server (TLS required)

Operations

SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Initiate a voice call
Start a new voice call with another user. The callee will receive the initiate signal and can respond with accept, reject, or busy.

Operation IDinitiateCall
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Initiate SignalCallInitiate
Start a new voice call
application/json
Message IDCallInitiate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:initiate"
object
Payload for call:initiate signal

callerName
required
string
Display name of the caller

callerAvatar
string
format: uri
URL of caller's avatar image

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Initiate call
{ "type": "call:initiate", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:00Z", "payload": { "callerName": "Alice", "callerAvatar": "https://example.com/avatars/alice.jpg" } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive incoming call
Receive notification of an incoming voice call. Respond with accept, reject, or busy within the timeout period (30 seconds).

Operation IDreceiveCallInitiate
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Initiate SignalCallInitiate
Start a new voice call
application/json
Message IDCallInitiate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:initiate"
object
Payload for call:initiate signal

callerName
required
string
Display name of the caller

callerAvatar
string
format: uri
URL of caller's avatar image

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Initiate call
{ "type": "call:initiate", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:00Z", "payload": { "callerName": "Alice", "callerAvatar": "https://example.com/avatars/alice.jpg" } }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Accept incoming call
Accept an incoming call. The caller will then send an SDP offer.

Operation IDacceptCall
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Accept SignalCallAccept
Accept an incoming call
application/json
Message IDCallAccept
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:accept"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - Accept call
{ "type": "call:accept", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2025-12-08T10:30:05Z", "payload": {} }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Reject incoming call
Decline an incoming call.

Operation IDrejectCall
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Reject SignalCallReject
Decline an incoming call
application/json
Message IDCallReject
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:reject"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - Reject call
{ "type": "call:reject", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2025-12-08T10:30:05Z", "payload": {} }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Send busy signal
Indicate that you're already on another call.

Operation IDsendBusy
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Busy SignalCallBusy
Recipient is on another call
application/json
Message IDCallBusy
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:busy"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
Examples
#1 Example - Busy signal
{ "type": "call:busy", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2025-12-08T10:30:02Z", "payload": {} }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Send SDP offer
Send WebRTC SDP offer after call is accepted. This contains the caller's media capabilities.

Operation IDsendOffer
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
SDP Offer SignalCallOffer
WebRTC SDP offer
application/json
Message IDCallOffer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:offer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - SDP offer
{ "type": "call:offer", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:06Z", "payload": { "sdp": "v=0\\r\\no=- 123456 2 IN IP4 127.0.0.1\\r\\n...", "type": "offer" } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive SDP offer
Receive the caller's SDP offer.

Operation IDreceiveOffer
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
SDP Offer SignalCallOffer
WebRTC SDP offer
application/json
Message IDCallOffer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:offer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - SDP offer
{ "type": "call:offer", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:06Z", "payload": { "sdp": "v=0\\r\\no=- 123456 2 IN IP4 127.0.0.1\\r\\n...", "type": "offer" } }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Send SDP answer
Send WebRTC SDP answer in response to offer. This contains the callee's media capabilities.

Operation IDsendAnswer
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
SDP Answer SignalCallAnswer
WebRTC SDP answer
application/json
Message IDCallAnswer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:answer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - SDP answer
{ "type": "call:answer", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2025-12-08T10:30:07Z", "payload": { "sdp": "v=0\\r\\no=- 654321 2 IN IP4 127.0.0.1\\r\\n...", "type": "answer" } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive SDP answer
Receive the callee's SDP answer.

Operation IDreceiveAnswer
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
SDP Answer SignalCallAnswer
WebRTC SDP answer
application/json
Message IDCallAnswer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:answer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - SDP answer
{ "type": "call:answer", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "recipientId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2025-12-08T10:30:07Z", "payload": { "sdp": "v=0\\r\\no=- 654321 2 IN IP4 127.0.0.1\\r\\n...", "type": "answer" } }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Send ICE candidate
Send an ICE candidate for NAT traversal. Multiple candidates may be sent in both directions during connection establishment.

Operation IDsendIceCandidate
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
ICE Candidate SignalCallIceCandidate
ICE candidate for NAT traversal
application/json
Message IDCallIceCandidate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:ice-candidate"
object
Payload for ICE candidate signal

candidate
required
string
ICE candidate string

sdpMid
required
string
Media stream identification tag

sdpMLineIndex
required
integer
Index of the media description in the SDP

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - ICE candidate
{ "type": "call:ice-candidate", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:08Z", "payload": { "candidate": "candidate:1 1 UDP 2122194687 192.168.1.100 54321 typ host", "sdpMid": "0", "sdpMLineIndex": 0 } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive ICE candidate
Receive an ICE candidate from the other party.

Operation IDreceiveIceCandidate
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
ICE Candidate SignalCallIceCandidate
ICE candidate for NAT traversal
application/json
Message IDCallIceCandidate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:ice-candidate"
object
Payload for ICE candidate signal

candidate
required
string
ICE candidate string

sdpMid
required
string
Media stream identification tag

sdpMLineIndex
required
integer
Index of the media description in the SDP

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - ICE candidate
{ "type": "call:ice-candidate", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:08Z", "payload": { "candidate": "candidate:1 1 UDP 2122194687 192.168.1.100 54321 typ host", "sdpMid": "0", "sdpMLineIndex": 0 } }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
End the call
Terminate the call. Include the reason and optional duration if the call was connected.

Operation IDsendHangup
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Hangup SignalCallHangup
End the call
application/json
Message IDCallHangup
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:hangup"
object
Payload for call:hangup signal

reason
required
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
duration
integer
Call duration in seconds (only if call was connected)

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Normal hangup
{ "type": "call:hangup", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:35:00Z", "payload": { "reason": "completed", "duration": 294 } }

#2 Example - Call cancelled
{ "type": "call:hangup", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:10Z", "payload": { "reason": "cancelled" } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive hangup
Receive notification that the other party ended the call.

Operation IDreceiveHangup
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Call Hangup SignalCallHangup
End the call
application/json
Message IDCallHangup
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:hangup"
object
Payload for call:hangup signal

reason
required
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
duration
integer
Call duration in seconds (only if call was connected)

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Normal hangup
{ "type": "call:hangup", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:35:00Z", "payload": { "reason": "completed", "duration": 294 } }

#2 Example - Call cancelled
{ "type": "call:hangup", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:30:10Z", "payload": { "reason": "cancelled" } }
SEND /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Send mute state change
Notify the other party of your mute state change.

Operation IDsendMuteChange
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Mute Change SignalCallMuteChange
Mute state changed
application/json
Message IDCallMuteChange
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:mute-change"
object
Payload for call:mute-change signal

muted
required
boolean
Whether the sender is now muted

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Muted
{ "type": "call:mute-change", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:32:00Z", "payload": { "muted": true } }

#2 Example - Unmuted
{ "type": "call:mute-change", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:33:00Z", "payload": { "muted": false } }
RECEIVE /xmpp
Voice call signaling via XMPP IQ stanzas.

Namespace: urn:xmpp:call:0 Authentication: JWT token must be present in auth_token cookie.

Voice call signals are embedded in XMPP IQ stanzas and share the same WebSocket connection as chat messages. The signal payload is JSON-encoded within the IQ stanza.

IQ Stanza Format:

<iq type="set" to="{recipientJID}" id="{messageId}"> <call xmlns="urn:xmpp:call:0"> {JSON signal payload} </call> </iq>
Receive mute state change
Receive notification of the other party's mute state.

Operation IDreceiveMuteChange
Available only on servers:
object
method
GET
object
Cookie
string
Must contain auth_token={jwt}

Sec-WebSocket-Protocol
string
WebSocket subprotocol

Const:"xmpp"
Additional properties are allowed.
Accepts the following message:
Mute Change SignalCallMuteChange
Mute state changed
application/json
Message IDCallMuteChange
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:mute-change"
object
Payload for call:mute-change signal

muted
required
boolean
Whether the sender is now muted

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example - Muted
{ "type": "call:mute-change", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:32:00Z", "payload": { "muted": true } }

#2 Example - Unmuted
{ "type": "call:mute-change", "callId": "550e8400-e29b-41d4-a716-446655440000", "senderId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "timestamp": "2025-12-08T10:33:00Z", "payload": { "muted": false } }

Messages

#1Call Initiate SignalCallInitiate
Start a new voice call
- application/json
Message IDCallInitiate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:initiate"
object
Payload for call:initiate signal

callerName
required
string
Display name of the caller

callerAvatar
string
format: uri
URL of caller's avatar image

Additional properties are allowed.
Additional properties are allowed.
#2Call Accept SignalCallAccept
Accept an incoming call
- application/json
Message IDCallAccept
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:accept"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
#3Call Reject SignalCallReject
Decline an incoming call
- application/json
Message IDCallReject
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:reject"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
#4SDP Offer SignalCallOffer
WebRTC SDP offer
- application/json
Message IDCallOffer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:offer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
#5SDP Answer SignalCallAnswer
WebRTC SDP answer
- application/json
Message IDCallAnswer
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:answer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
#6ICE Candidate SignalCallIceCandidate
ICE candidate for NAT traversal
- application/json
Message IDCallIceCandidate
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:ice-candidate"
object
Payload for ICE candidate signal

candidate
required
string
ICE candidate string

sdpMid
required
string
Media stream identification tag

sdpMLineIndex
required
integer
Index of the media description in the SDP

Additional properties are allowed.
Additional properties are allowed.
#7Call Hangup SignalCallHangup
End the call
- application/json
Message IDCallHangup
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:hangup"
object
Payload for call:hangup signal

reason
required
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
duration
integer
Call duration in seconds (only if call was connected)

Additional properties are allowed.
Additional properties are allowed.
#8Call Busy SignalCallBusy
Recipient is on another call
- application/json
Message IDCallBusy
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:busy"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
#9Mute Change SignalCallMuteChange
Mute state changed
- application/json
Message IDCallMuteChange
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:mute-change"
object
Payload for call:mute-change signal

muted
required
boolean
Whether the sender is now muted

Additional properties are allowed.
Additional properties are allowed.

Schemas

SignalType
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
EndReason
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
Payload for call:initiate signal

callerName
required
string
Display name of the caller

callerAvatar
string
format: uri
URL of caller's avatar image

Additional properties are allowed.
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
object
Payload for ICE candidate signal

candidate
required
string
ICE candidate string

sdpMid
required
string
Media stream identification tag

sdpMLineIndex
required
integer
Index of the media description in the SDP

Additional properties are allowed.
object
Payload for call:hangup signal

reason
required
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
duration
integer
Call duration in seconds (only if call was connected)

Additional properties are allowed.
object
Payload for call:mute-change signal

muted
required
boolean
Whether the sender is now muted

Additional properties are allowed.
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:initiate"
object
Payload for call:initiate signal

callerName
required
string
Display name of the caller

callerAvatar
string
format: uri
URL of caller's avatar image

Additional properties are allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:accept"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:reject"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:offer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:answer"
object
Payload for SDP offer/answer signals

sdp
required
string
Session Description Protocol data

type
required
string
SDP type

Allowed values:
"offer"
"answer"
Additional properties are allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:ice-candidate"
object
Payload for ICE candidate signal

candidate
required
string
ICE candidate string

sdpMid
required
string
Media stream identification tag

sdpMLineIndex
required
integer
Index of the media description in the SDP

Additional properties are allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:hangup"
object
Payload for call:hangup signal

reason
required
string
Reason for call ending

Allowed values:
"completed"
"rejected"
"timeout"
"busy"
"failed"
"cancelled"
duration
integer
Call duration in seconds (only if call was connected)

Additional properties are allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:busy"
object
Empty payload for signals that don't need additional data

Additional properties are NOT allowed.
Additional properties are allowed.
allOf
object
Base schema for all call signals

type
required
string
Type of call signal

Allowed values:
"call:initiate"
"call:accept"
"call:reject"
"call:offer"
"call:answer"
"call:ice-candidate"
"call:hangup"
"call:busy"
"call:mute-change"
callId
required
string
format: uuid
Unique identifier for this call session

senderId
required
string
format: uuid
UUID of the user sending the signal

recipientId
required
string
format: uuid
UUID of the user receiving the signal

timestamp
required
string
format: date-time
ISO 8601 timestamp of the signal

required
object
Signal-specific payload data

Additional properties are allowed.
Additional properties are allowed.
object
type
string
Const:"call:mute-change"
object
Payload for call:mute-change signal

muted
required
boolean
Whether the sender is now muted

Additional properties are allowed.
Additional properties are allowed.

Aoba Voice Call Signaling API 1.0.0

Purpose

Transport

Call Flow

Signal Types

End Reasons

Servers

Operations

SEND /xmpp

Examples

#1 Example - Initiate call

RECEIVE /xmpp

Examples

#1 Example - Initiate call

SEND /xmpp

Examples

#1 Example - Accept call

SEND /xmpp

Examples

#1 Example - Reject call

SEND /xmpp

Examples

#1 Example - Busy signal

SEND /xmpp

Examples

#1 Example - SDP offer

RECEIVE /xmpp

Examples

#1 Example - SDP offer

SEND /xmpp

Examples

#1 Example - SDP answer

RECEIVE /xmpp

Examples

#1 Example - SDP answer

SEND /xmpp

Examples

#1 Example - ICE candidate

RECEIVE /xmpp

Examples

#1 Example - ICE candidate

SEND /xmpp

Examples

#1 Example - Normal hangup

#2 Example - Call cancelled

RECEIVE /xmpp

Examples

#1 Example - Normal hangup

#2 Example - Call cancelled

SEND /xmpp

Examples

#1 Example - Muted

#2 Example - Unmuted

RECEIVE /xmpp

Examples

#1 Example - Muted

#2 Example - Unmuted

Messages

Schemas