zulip/templates/zerver/api/usage.md

Usage examples

• curl
• Python
• zulip-send
• JavaScript

#### Stream message

curl {{ api_url }}/v1/messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "type=stream" \
    -d "to=Denmark" \
    -d "subject=Castle" \
    -d "content=Something is rotten in the state of Denmark."

Private message

curl {{ api_url }}/v1/messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "type=private" \
    -d "to=hamlet@example.com" \
    -d "content=I come not, friends, to steal away your hearts."

```python #!/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 }}")

Send a stream message

client.send_message({ "type": "stream", "to": "Denmark", "subject": "Castle", "content": "Something is rotten in the state of Denmark." })

Send a private message

client.send_message({ "type": "private", "to": "hamlet@example.com", "content": "I come not, friends, to steal away your hearts." })

Print each message the user receives

This is a blocking call that will run forever

client.call_on_each_message(lambda msg: sys.stdout.write(str(msg) + "\n"))

Print every event relevant to the user

This is a blocking call that will run forever

This will never be reached unless you comment out the previous line

client.call_on_each_event(lambda msg: sys.stdout.write(str(msg) + "\n"))

</div>

<div data-language="zulip-send" markdown="1"> You can use `zulip-send`
(available after you `pip install zulip`) to easily send Zulips from
the command-line, providing the message content via STDIN.

#### Stream message

```bash
zulip-send --stream Denmark --subject Castle \
    --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5

Private message

zulip-send hamlet@example.com \
    --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5

Passing in the message on the command-line

If you'd like, you can also provide the message on the command-line with the -m flag, as follows:

zulip-send --stream Denmark --subject Castle \
    -m "Something is rotten in the state of Denmark." \
    --user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5

You can omit the user and api-key arguments if you have a ~/.zuliprc file.

See also the full API endpoint documentation..

More examples and documentation can be found [here](https://github.com/zulip/zulip-js). ```js const zulip = require('zulip');

const config = { username: 'othello-bot@example.com', apiKey: 'a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5', realm: '{{ api_url }}' };

const client = zulip(config);

// Send a message client.messages.send({ to: 'Denmark', type: 'stream', subject: 'Castle', content: 'Something is rotten in the state of Denmark.' });

// Send a private message client.messages.send({ to: 'hamlet@example.com', type: 'private', content: 'I come not, friends, to steal away your hearts.' });

// Register queue to receive messages for user client.queues.register({ event_types: ['message'] }).then((res) => { // Retrieve events from a queue // Blocking until there is an event (or the request times out) client.events.retrieve({ queue_id: res.queue_id, last_event_id: -1, dont_block: false }).then(console.log); });

</div>

</div>

</div>