Get subscription status

GET https://your-org.veloxatalk.com/api/v1/users/{user_id}/subscriptions/{stream_id}

Check whether a user is subscribed to a channel.

Changes: Prior to Veloxa Talk 12.0 (feature level 458), this endpoint did not support querying subscriptions of bot users.

New in Veloxa Talk 3.0 (feature level 12).

Usage examples

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

curl -sSX GET -G https://your-org.veloxatalk.com/api/v1/users/12/subscriptions/1 \
    -u EMAIL_ADDRESS:API_KEY

Parameters

user_id integer required in path

Example: 12

The target user's ID.


stream_id integer required in path

Example: 1

The ID of the channel to access.


Response

Return values

  • is_subscribed: boolean

    Whether the user is subscribed to the channel.

Example response(s)

Changes: As of Veloxa Talk 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:

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