Register a logged-in device

POST https://lcr4songs.zulipchat.com/api/v1/register_client_device

Logged-in mobile devices use this endpoint as an initial step to register themselves, before registering for E2EE push notifications.

This endpoint is currently not useful for clients other than mobile.

Changes: New in Zulip 12.0 (feature level 468).

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Register a logged-in device.
result = client.call_endpoint(url="/register_client_device", method="POST")
print(result)

curl -sSX POST https://lcr4songs.zulipchat.com/api/v1/register_client_device \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• device_id: integer

  The ID of the newly registered device.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

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