TIMMsgSetC2CReceiveMessageOpt
Introduction
Set C2C receiving message option
You can set the message receiving option for a one-to-one or group chat to implement the notification muting feature.
This API supports batch setting setting user_id_list, maximum set 30 users at one time.
Maximum 5 invoking per second.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| msgSetC2CReceiveMessageOptParams | MsgSetC2CReceiveMessageOptParams | yes | Param of setting C2C receiving message option |
Returned template
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined;
user_data?: string | undefined;
}
Return value details
| name | type | description |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | Request result: Error codes. 0 means success. |
| desc | string ｜ undefined | The description of the error. It will be empty if success. |
| json_param | string ｜ undefined | Return value of calling API |
| json_params | string ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgSetC2CReceiveMessageOptParams } from "im_electron_sdk/dist/interfaces";
let userId = ''
let opt = 0
let param: MsgSetC2CReceiveMessageOptParams = {
params: [userId],
opt: opt,
user_data: "123"
}
const { code } = await timRenderInstance.TIMMsgSetC2CReceiveMessageOpt(param);
if (code == 0) {
// success
}