Topic Subscriptions API
This API documentation provides information on operations related to topic subscription and unsubscription, and batch topic subscription and unsubscription.
Subscribe
URI
POST /mqtt/subscribe
Request Message
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| topic | String | Optional | Topic, with at least one of the topics specified | |
| topics | String | Optional | Multiple topics separated by ,. This field is used to subscribe to multiple topics at the same time | |
| clientid | String | Required | Client identifier | |
| qos | Integer | Optional | 0 | QoS level |
Response Message
| Name | Type | Description |
|---|---|---|
| code | Integer | 0 |
Request Example
bash
curl -u app_id:app_secret -X POST -d '{"topic": "d","qos": 1,"clientid": "emqx_c_1"}' {api}/mqtt/subscribecurl -u app_id:app_secret -X POST -d '{"topic": "d","qos": 1,"clientid": "emqx_c_1"}' {api}/mqtt/subscribeResponse Example
JSON
{
"code": 0
}{
"code": 0
}Unsubscribe
URI
POST /mqtt/unsubscribe
Request Message
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| topic | String | Optional | Topic | |
| clientid | String | Required | Client identifier |
Response Message
| Name | Type | Description |
|---|---|---|
| code | Integer | 0 |
Request Example
bash
curl -u app_id:app_secret -X POST -d '{"topic": "a","clientid": "emqx_c_1"}' {api}/mqtt/unsubscribecurl -u app_id:app_secret -X POST -d '{"topic": "a","clientid": "emqx_c_1"}' {api}/mqtt/unsubscribeResponse Example
JSON
{
"code": 0
}{
"code": 0
}Batch Subscribe
URI
POST /mqtt/subscribe_batch
Request Message
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| [].topic | String | Optional | Topic, with at least one of the topics specified | |
| [].topics | String | Optional | Multiple topics separated by ,. This field is used to subscribe to multiple topics at the same time | |
| [].clientid | String | Required | Client identifier | |
| [].qos | Integer | Optional | 0 | QoS level |
Response Message
| Name | Type | Description |
|---|---|---|
| code | Integer | 0 |
| data | Array of Objects | All the subscription information |
| data[].clientid | String | clientid |
| data[].topic | String | Topic |
| data[].code | Integer | 0 |
Request Example
bash
curl -u app_id:app_secret -X POST -d '[{"topic": "a", "qos": 1, "clientid": "testtopic/#"}, {"topic": "topic/a", "qos": 1, "clientid": "emqx_c_1"}]' {api}/mqtt/subscribe_batchcurl -u app_id:app_secret -X POST -d '[{"topic": "a", "qos": 1, "clientid": "testtopic/#"}, {"topic": "topic/a", "qos": 1, "clientid": "emqx_c_1"}]' {api}/mqtt/subscribe_batchResponse Example
JSON
{
"data": [
{
"topic": "a",
"code": 112,
"clientid": "testtopic/#"
},
{
"topic": "topic/a",
"code": 0,
"clientid": "emqx_c_1"
}
],
"code": 0
}{
"data": [
{
"topic": "a",
"code": 112,
"clientid": "testtopic/#"
},
{
"topic": "topic/a",
"code": 0,
"clientid": "emqx_c_1"
}
],
"code": 0
}Batch Unsubscribe
URI
POST /mqtt/unsubscribe_batch
Request Message
| Name | Type | Description |
|---|---|---|
| [].topic | String | Topics, with topics specifying at least one of them |
| [].topics | String | Multiple topics split by ,, use this field to subscribe to multiple topics at the same time |
| [].clientid | String | clientid |
| [].qos | Integer | QoS Level |
Response Message
| Name | Type | Description |
|---|---|---|
| code | Integer | 0 |
| data | Array of Objects | All subscriptions |
| data[].clientid | String | clientid |
| data[].topic | String | Subscription Topics |
| data[].code | Integer | 0 |
Request Example
bash
$ curl -u app_id:app_secret -X POST -d '[{"topic": "a","clientid": "emqx_c_1"}]' {api}/mqtt/unsubscribe_batch$ curl -u app_id:app_secret -X POST -d '[{"topic": "a","clientid": "emqx_c_1"}]' {api}/mqtt/unsubscribe_batchResponse Example
JSON
{
"data": [
{
"topic": "a",
"code": 0,
"clientid": "emqx_c_1"
}
],
"code": 0
}{
"data": [
{
"topic": "a",
"code": 0,
"clientid": "emqx_c_1"
}
],
"code": 0
}