Get channel ID
GET https://zulip.tf.uni-freiburg.de/api/v1/get_stream_id
Get the unique ID of a given channel.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get the ID of a given channel name.
result = client.get_stream_id(name)
print(result)
More examples and documentation can be found here.
const zulipInit = require("zulip-js");
// Pass the path to your zuliprc file here.
const config = { zuliprc: "zuliprc" };
(async () => {
const client = await zulipInit(config);
// Get the ID of a given channel
console.log(await client.streams.getStreamId("Denmark"));
})();
curl -sSX GET -G https://zulip.tf.uni-freiburg.de/api/v1/get_stream_id \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode stream=Denmark
Parameters
stream string required
Example: "Denmark"
The name of the channel to access.
Response
Return values
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:
{
"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"
}