TIMMsgBatchSend
功能介绍
群发消息,该接口不支持向群组发送消息。
批量发送消息的接口,每个UserID发送成功与否,通过回调cb返回。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
msgBatchSendParams | MsgBatchSendParams | 是 | 群发消息的参数 |
返回模板
Promise<commonResult<Array<BatchSendResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<BatchSendResult> | undefined;
json_params?: Array<BatchSendResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | Array< BatchSendResult > | undefined | 根据具具体接口返回 |
json_params | Array< BatchSendResult > | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { MsgBatchSendParams } from "im_electron_sdk/dist/interfaces";
let userId = ''
let param: MsgBatchSendParams = {
params: {
msg_batch_send_param_identifier_array: [userId],
msg_batch_send_param_msg: {
message_elem_array: [{
elem_type: 3,
text_elem_content: ""
}],
message_sender: ""
}
},
user_data: ""
}
const {code} = await timRenderInstance.TIMMsgBatchSend(param);
if(code == 0){
// 成功
}