Record call device reachability

POST https://z.u1v.ru/api/v1/calls/devices/heartbeat

Refresh server-side reachability for a registered call device.

Usage examples

curl

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://z.u1v.ru/api/v1/calls/devices/heartbeat \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode user_id=42 \
    --data-urlencode device_instance_id=device-1 \
    --data-urlencode public_identity=sip:hamlet@sip.example.com \
    --data-urlencode 'metadata={"network": "wifi"}'

Parameters

user_id string required

Example: "42"

Authenticated Zulip user identifier.

device_instance_id string required

Example: "device-1"

Stable application device identifier.

public_identity string required

Example: "sip:hamlet@sip.example.com"

Projected public SIP identity.

metadata object | null optional

Example: {"network": "wifi"}

Optional app-owned reachability metadata.

Response

Example response(s)

Successful response from a UCS extension endpoint. Endpoint-specific fields are returned alongside the standard Zulip success envelope.

{
    "msg": "",
    "result": "success"
}

API documentation home

Messages

Scheduled messages

Message reminders

Drafts

Navigation views

Channels

Users

Invitations

Server & organizations

Real-time events

Interactive bots

Specialty endpoints

Back to Zulip

Record call device reachability

Usage examples

Parameters

Response

Example response(s)