Message: update / voipStatus (app -> client)

Update the VoIP status (e.g. when a call has been started).

This message SHALL be sent by the app in case the VoIP status has been changed. This may happen in case the user's Threema ID is being called, it has picked up a call, etc.

Args

Field	Description	Type	Optional	Nullable
type	The status type	String	False	False

Data

Models

VoipRinging

Field	Description	Type	Optional	Nullable	Default
identity	The identity of the call partner	String	False	False

VoipStarted

Field	Description	Type	Optional	Nullable	Default
identity	The identity of the call partner	String	False	False
outgoing	Whether this is an outgoing (`true`) or incoming (`false`) call	Boolean	False	False

VoipFinished

Field	Description	Type	Optional	Nullable
identity	The identity of the call partner	String	False	False
outgoing	Whether this is an outgoing (`true`) or incoming (`false`) call	Boolean	False	False
duration	The call duration in seconds	Integer	False	False

VoipRejected

Field Description Type Optional Nullable Default

identity

The identity of the call partner

String

False

outgoing

Whether this is an outgoing (true) or incoming (false) call

Boolean

False

reason

The reject reason

Allowed values: "busy", "timeout", "rejected", "unknown"

String

False

VoipMissed

Field	Description	Type	Optional	Nullable	Default
identity	The identity of the call partner	String	False	False

VoipAborted

Field	Description	Type	Optional	Nullable	Default
identity	The identity of the call partner	String	False	False