Call Events

CALL_INCOMING

EVENT CALL_INCOMING

Sent to all members of a conversation when someone initiates a call. The recipient should display an incoming call UI.

Field	Type	Description
`conversation_id`	`string`	Conversation ID where the call is being initiated
`initiator_id`	`string`	ID of the user who started the call
`initiator_name`	`string`	Username of the caller
`initiator_avatar`	`string?`	Avatar attachment ID of the caller

{
  "type": "CALL_INCOMING",
  "data": {
    "conversation_id": "019cf96a-24e8-72c5-830f-75e85355de00",
    "initiator_id": "019cf96a-3d5b-72c5-830f-75e85355d078",
    "initiator_name": "MARCROCK22",
    "initiator_avatar": "9bd6da82-c850-424b-89a0-9e4733263a45"
  }
}

CALL_ACCEPTED

EVENT CALL_ACCEPTED

Sent to all members of the conversation when someone accepts the call.

Field	Type	Description
`conversation_id`	`string`	Conversation ID
`user_id`	`string`	ID of the user who accepted the call

{
  "type": "CALL_ACCEPTED",
  "data": {
    "conversation_id": "019cf96a-24e8-72c5-830f-75e85355de00",
    "user_id": "019cf96a-13d7-72c5-830f-75e85355dd00"
  }
}

CALL_DECLINED

EVENT CALL_DECLINED

Sent to all members of the conversation when someone declines the call.

Field	Type	Description
`conversation_id`	`string`	Conversation ID
`user_id`	`string`	ID of the user who declined the call

{
  "type": "CALL_DECLINED",
  "data": {
    "conversation_id": "019cf96a-24e8-72c5-830f-75e85355de00",
    "user_id": "019cf96a-13d7-72c5-830f-75e85355dd00"
  }
}

CALL_ENDED

EVENT CALL_ENDED

Sent to all members of the conversation when a call ends.

Field	Type	Description
`conversation_id`	`string`	Conversation ID

{
  "type": "CALL_ENDED",
  "data": {
    "conversation_id": "019cf96a-24e8-72c5-830f-75e85355de00"
  }
}