unlisten
stable

Allows to interrupt a stream.

Usage

To interrupt a stream, you can unlisten with the original req_id like this:

Request example:

{"type": "unlisten", "data": {"req_id": "your-request-id"}}

Arguments

req_id required string
The req_id passed to previous commands which included listen=true.

Responses

{"type":"unlistened","data":{"success":true}}

If unlistened fails, you will receive a normal error message.