1.6 KiB

Raw Blame History

Get stream ID

Get the unique ID of a given stream.

GET {{ api_url }}/v1/get_stream_id

Arguments

Note: The following arguments are all URL query parameters.

{generate_api_arguments_table|arguments.json|get-stream-id.md}

Usage examples

curl
Python

curl {{ api_url }}/v1/get_stream_id?stream=Denmark \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

#!/usr/bin/env python

import zulip
import sys

# Keyword arguments 'email' and 'api_key' are not required if you are using ~/.zuliprc
client = zulip.Client(email="othello-bot@example.com",
                      api_key="a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
                      site="{{ api_url }}")

# Get the ID of a given stream
print(client.get_stream_id("Denmark"))

Response

Return values

stream_id: The ID of the given stream.

Example response

A typical successful JSON response may look like:

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

An example of a JSON response for when the supplied stream does not exist:

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

An example of a JSON response for when the stream query parameter is not provided:

{
    "msg":"Missing 'stream' argument",
    "result":"error",
    "var_name":"stream",
    "code":"REQUEST_VARIABLE_MISSING"
}

{!invalid-api-key-json-response.md!}

1.6 KiB Raw Blame History