Get channel ID

GET https://your-org.veloxatalk.com/api/v1/get_stream_id

Get the unique ID of a given channel.

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/get_stream_id \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode stream=Denmark

Parameters

stream string required

Example: "Denmark"

The name of the channel to access.


Response

Return values

  • stream_id: integer

    The ID of the given 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:

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

An example JSON response for when the supplied channel does not exist:

{
    "code": "BAD_REQUEST",
    "msg": "Invalid channel name 'nonexistent'",
    "result": "error"
}