Update a pending conference invite

POST https://z.u1v.ru/api/v1/calls/conferences/invites/action

Cancel, stop, or retry one pending conference invitation.

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/conferences/invites/action \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode owner_user_id=42 \
    --data-urlencode room_id=room-1 \
    --data-urlencode action=cancel \
    --data-urlencode invite_id=invite-1 \
    --data-urlencode invitee_user_id=43

Parameters

owner_user_id string required

Example: "42"

Conference owner Zulip user identifier.

room_id string required

Example: "room-1"

Conference room identifier.

action string required

Example: "cancel"

Requested pending-invite action. Must be one of: "cancel", "stop_calling", "retry".

invite_id string | null optional

Example: "invite-1"

Optional server-issued invitation identifier.

invitee_user_id integer | null optional

Example: 43

Optional invited Zulip user identifier.

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

Update a pending conference invite

Usage examples

Parameters

Response

Example response(s)