免打擾是指當您工作或休息時,希望減少消息推送提醒而設置的一種模式。類似微信設置免打擾,針對個人或者群組設置免打擾后,將不會收到消息推送,但是仍然可以接收到該消息。此接口需結合應用層實現。僅專有云提供
1、請求地址
POST /{SoftVersion}/Application/{appId}/IM/SetDisturb?sig={SigParameter}
2、請求包頭
請參閱《鑒權說明》
3、請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 必選 | 當前個人賬號 |
type | String | 必選 | 1:設置免打擾 2:取消免打擾 |
setAccount | String | 必選 | 設置的賬號,個人賬號或者群組ID |
3、1 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/SetDisturb?sig=C1F20E7A9733CABCDE HTTP/1.1 Host: 192.168.0.1:8883 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmOAwN6MjAxMzAyMDExNTABCE= {"userName":"18210349745", "type":"1", "setAccount":"15810771821"}
4、響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
statusMsg | String | 必選 | 請求狀態碼描述,取值:success(成功)。 |
4.1、響應示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000","statusMsg":"success"}
1、請求地址
POST /{SoftVersion}/Application/{appId}/IM/GetDisturb?sig={SigParameter}
2、請求包頭
請參閱《鑒權說明》
3、請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 必選 | 當前個人賬號 |
pageNo | String | 可選 | 頁碼,缺省是1 |
pageSize | String | 可選 | 分頁記錄數 缺省是100 |
3、1 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/GetDisturb?sig=155EAA68C5DFB6B762 Host: 192.168.0.1:8883 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDE= {"userName":"account1","pageNo":"1","pageSize":"1"}
4、響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功) |
totalSize | int | 必選 | 總記錄數 |
result | List | 必選 | 結果集 |
4.1、響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"000000", "totalSize ":"50", "result":["result1","result2","result3"] }
文檔更新時間:2016年11月23日