设置免打扰

免打扰是指当您工作或休息时,希望减少消息推送提醒而设置的一种模式。类似微信设置免打扰,针对个人或者群组设置免打扰后,将不会收到消息推送,但是仍然可以接收到该消息。此接口需结合应用层实现。仅专有云提供

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日