HomeDocumentationAPI Reference
Log In
API Reference

Subscribe

Method Name

subscribe

Subscribe to a list of channels.

Parameters

channelsarray of stringsrequired
A list of channels names to subscribe to

Response

idstring or integerrequired
resultobjectrequired
result.current_subscriptionsarray of stringsrequired
A list of channels subscribed to after the subscribe operation.
result.statusobjectrequired
A mapping of channel ⭢ status.
Successful subscriptions will have status ok.
Failed subscriptions will contain an error message.

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}