Refresh SIP bearer credentials

POST https://z.u1v.ru/api/v1/calls/sip-bearer/refresh

Refresh short-lived SIP bearer credentials for the active account.

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/sip-bearer/refresh \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode refresh_token=refresh-token \
    --data-urlencode refresh_handle=refresh-handle \
    --data-urlencode sip_identity=sip:hamlet@sip.example.com \
    --data-urlencode scope=sip:register

Parameters

refresh_token string | null optional

Example: "refresh-token"

Opaque refresh token issued by the call-control service.

refresh_handle string | null optional

Example: "refresh-handle"

Opaque server-side refresh handle.

sip_identity string | null optional

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

Expected SIP identity used to prevent identity substitution.

scope string | null optional

Example: "sip:register"

Optional requested credential scope.

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

Refresh SIP bearer credentials

Usage examples

Parameters

Response

Example response(s)