MsgSetC2CReceiveMessageOpt
功能介绍
设置收消息选项
通过设置单聊和群聊的消息接收选项,可以实现类似“微信”或者“QQ”中消息免打扰的功能。
该接口支持批量设置,您可以通过参数 user_id_list 设置一批用户,但一次最大允许设置 30 个用户。
该接口调用频率被限制为1秒内最多调用5次。
具体参数效果可见文档
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
user_id_list | List< string > | 是 | 用户ID列表 |
opt | TIMReceiveMessageOpt | 是 | 接收消息选项 |
callback | NullValueCallback | 是 | 异步回调 |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
user_id_list | List< string > | 是 | 用户ID列表 |
opt | TIMReceiveMessageOpt | 是 | 接收消息选项 |
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:'' // json_params为空字符串""
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 |
user_data | string | ImSDK负责透传的用户自定义数据,未做任何处理 |