監聽配置API
獲取監聽配置
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
請求參數
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 內容類型，值爲application/json |
| Accept | String | Header | 是 | 接受類型，值爲application/json |
| Authorization | String | Header | 是 | Bearer認證，訪問令牌 |
| command | String | Body | 是 | 命令名稱 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令參數 |
param說明
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| project_id | String | Body | 是 | 項目ID |
返回參數
| 參數名 | 類型 | 位置 | 說明 |
|---|---|---|---|
| Content-Type | String | Header | 內容類型，值爲application/json |
| success | Boolean | Body | 判斷請求是否成功 true：成功 false：失敗 |
| timestamp | Integer | Body | 時間戳 |
| result | Object<result> | Body | 返回結果 |
result說明
| 參數名 | 類型 | 位置 | 說明 |
|---|---|---|---|
| listen_list | []String | Body | 監聽列表 booking：預約監聽通知 |
請求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "pr8b5a73f8dd84abaa94dcs248be49b0b"
}
}
成功返回示例
狀態碼：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"listen_list": [
"booking"
]
}
}
失敗返回示例
見 接口失敗返回
開啓監聽配置
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
請求參數
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 內容類型，值爲application/json |
| Accept | String | Header | 是 | 接受類型，值爲application/json |
| Authorization | String | Header | 是 | Bearer認證，訪問令牌 |
| command | String | Body | 是 | 命令名稱 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令參數 |
param說明
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| listen_list | []String | Body | 是 | 開啓監聽列表 booking：預約監聽通知 |
| project_id | String | Body | 是 | 項目ID |
返回參數
| 參數名 | 類型 | 位置 | 說明 |
|---|---|---|---|
| Content-Type | String | Header | 內容類型，值爲application/json |
| success | Boolean | Body | 判斷請求是否成功 true：成功 false：失敗 |
| timestamp | Integer | Body | 時間戳 |
| result | Object | Body | 返回結果 |
請求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "turn_on_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "pr8b5a73f8dd84abaa94dcs248be49b0b",
"listen_list": [
"booking"
]
}
}
成功返回示例
狀態碼：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
失敗返回示例
見 接口失敗返回
關閉監聽配置
接口地址
POST /api/v1.0/invoke/open-ability/method/manager-commands
請求參數
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| Content-Type | String | Header | 是 | 內容類型，值爲application/json |
| Accept | String | Header | 是 | 接受類型，值爲application/json |
| Authorization | String | Header | 是 | Bearer認證，訪問令牌 |
| command | String | Body | 是 | 命令名稱 |
| id | String | Body | 是 | 命令ID |
| param | Object<param> | Body | 是 | 命令參數 |
param說明
| 參數名 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| listen_list | []String | Body | 是 | 關閉監聽列表 booking：預約監聽通知 |
| project_id | String | Body | 是 | 項目ID |
返回參數
| 參數名 | 類型 | 位置 | 說明 |
|---|---|---|---|
| Content-Type | String | Header | 內容類型，值爲application/json |
| success | Boolean | Body | 判斷請求是否成功 true：成功 false：失敗 |
| timestamp | Integer | Body | 時間戳 |
| result | Object | Body | 返回結果 |
請求示例
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "turn_off_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "pr8b5a73f8dd84abaa94dcs248be49b0b",
"listen_list": [
"booking"
]
}
}
成功返回示例
狀態碼：200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
失敗返回示例
見 接口失敗返回