easemob-websdk 4.22.0 → 4.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "easemob-websdk",
-  "version": "4.22.0",
+  "version": "4.24.0",
   "description": "Easemob chat web sdk",
   "main": "Easemob-chat.js",
   "typings": "Easemob-chat.d.ts",

package/silent/silent.js

@@ -1 +1 @@
-!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r():"function"==typeof define&&define.amd?define([],r):"object"==typeof exports?exports.websdk=r():e.websdk=r()}(self,(function(){return(self.webpackChunkwebsdk=self.webpackChunkwebsdk||[]).push([[624],{4958:function(e,r,t){t.d(r,{default:function(){return v}});var o={};t.r(o),t.d(o,{clearRemindTypeForConversation:function(){return p},getPushPerformLanguage:function(){return h},getSilentModeForAll:function(){return c},getSilentModeForConversation:function(){return l},getSilentModeForConversations:function(){return d},getSilentModeRemindTypeConversations:function(){return m},setPushPerformLanguage:function(){return f},setSilentModeForAll:function(){return s},setSilentModeForConversation:function(){return u}}),t(8706),t(1629),t(4346),t(8598),t(2062),t(739),t(9432),t(6099),t(3362),t(3500);var n=t(4269),a=t(1156),i=t(7968);function s(e){if(!(e.options instanceof Object))throw Error('Invalid parameter: "options"');var r=e.options.paramType;if("number"!=typeof r||r<0||r>2)throw Error('Invalid parameter: "options of paramType"');if(0===r){if("string"!=typeof e.options.remindType)throw Error('Invalid parameter: "options of remindType"')}else if(1===r){if("number"!=typeof e.options.duration)throw Error('Invalid parameter: "options of duration"')}else if(2===r){var t=e.options,o=t.startTime,s=t.endTime;if(!(o instanceof Object&&Object.keys(o).length))throw Error('Invalid parameter: "options of startTime"');if(!o.hours||"number"!=typeof o.hours||!o.minutes||"number"!=typeof o.minutes)throw Error('Invalid parameter: "options of startTime of hours or minutes"');if(!(s instanceof Object&&Object.keys(s).length))throw Error('Invalid parameter: "options of endTime"');if(!s.hours||"number"!=typeof s.hours||!s.minutes||"number"!=typeof s.minutes)throw Error('Invalid parameter: "options of endTime of hours or minutes"')}var c=a.dO.call(this).error;if(c)return Promise.reject(c);var u=this.context,p=u.accessToken,l=u.orgName,d=u.appName,f=u.userId,h=u.jid,m={};switch(r){case 0:m={type:e.options.remindType};break;case 1:m={ignoreDuration:e.options.duration};break;case 2:var v=e.options;o=v.startTime,s=v.endTime,m={ignoreInterval:"".concat(o.hours,":").concat(o.minutes,"-").concat(s.hours,":").concat(s.minutes)}}var y={url:"".concat(this.apiUrl,"/").concat(l,"/").concat(d,"/users/").concat(f,"/notification/user/").concat(f,"?resource=").concat(h.clientResource),type:"PUT",dataType:"json",data:JSON.stringify(m),headers:{Authorization:"Bearer "+p,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setSilentModeForAll:",e),n.RD.call(this,y)}function c(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/user/").concat(u),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:null==e?void 0:e.success,error:null==e?void 0:e.error};return i.vF.debug("Call getSilentModeForAll:",e),n.RD.call(this,p)}function u(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');if(!(e.options instanceof Object))throw Error('Invalid parameter: "options"');var r=e.options.paramType;if("number"!=typeof r||r<0||r>2)throw Error('Invalid parameter: "options of paramType"');if(0===r){if("string"!=typeof e.options.remindType)throw Error('Invalid parameter: "options of remindType"')}else if(1===r){if("number"!=typeof e.options.duration)throw Error('Invalid parameter: "options of duration"')}else if(2===r){var t=e.options,o=t.startTime,s=t.endTime;if(!(o instanceof Object&&Object.keys(o).length))throw Error('Invalid parameter: "options of startTime"');if(!o.hours||"number"!=typeof o.hours||!o.minutes||"number"!=typeof o.minutes)throw Error('Invalid parameter: "options of startTime of hours or minutes"');if(!(s instanceof Object&&Object.keys(s).length))throw Error('Invalid parameter: "options of endTime"');if(!s.hours||"number"!=typeof s.hours||!s.minutes||"number"!=typeof s.minutes)throw Error('Invalid parameter: "options of endTime of hours or minutes"')}var c=a.dO.call(this).error;if(c)return Promise.reject(c);var u=this.context,p=u.accessToken,l=u.orgName,d=u.appName,f=u.userId,h=u.jid,m="chatgroup",v={};switch(r){case 0:v={type:e.options.remindType};break;case 1:v={ignoreDuration:e.options.duration};break;case 2:var y=e.options;o=y.startTime,s=y.endTime,v={ignoreInterval:"".concat(o.hours,":").concat(o.minutes,"-").concat(s.hours,":").concat(s.minutes)}}"singleChat"===e.type&&(m="user");var g={url:"".concat(this.apiUrl,"/").concat(l,"/").concat(d,"/users/").concat(f,"/notification/").concat(m,"/").concat(e.conversationId,"?resource=").concat(h.clientResource),type:"PUT",dataType:"json",data:JSON.stringify(v),headers:{Authorization:"Bearer "+p,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setSilentModeForConversation:",e),n.RD.call(this,g)}function p(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p=t.jid,l="chatgroup";"singleChat"===e.type&&(l="user");var d={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/").concat(l,"/").concat(e.conversationId,"?resource=").concat(p.clientResource),type:"PUT",dataType:"json",data:JSON.stringify({type:"DEFAULT"}),headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call clearRemindTypeForConversation:",e),n.RD.call(this,d)}function l(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p="chatgroup";"singleChat"===e.type&&(p="user");var l={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/").concat(p,"/").concat(e.conversationId),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call getSilentModeForConversation:",e),n.RD.call(this,l)}function d(e){if(!Array.isArray(e.conversationList))throw Error('Invalid parameter: "conversationList"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p=[],l=[];e.conversationList.forEach((function(e){"singleChat"===e.type?p.push(e.id):l.push(e.id)}));var d=p.length?p.join(","):"",f=l.length?l.join(","):"",h={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification?user=").concat(d,"&group=").concat(f),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call getSilentModeForConversations:",e),n.RD.call(this,h)}function f(e){if("string"!=typeof e.language||!e.language)throw Error('Invalid parameter: "language"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t={translationLanguage:e.language},o=this.context,s=o.accessToken,c=o.orgName,u=o.appName,p=o.userId,l={url:"".concat(this.apiUrl,"/").concat(c,"/").concat(u,"/users/").concat(p,"/notification/language"),type:"PUT",dataType:"json",data:JSON.stringify(t),headers:{Authorization:"Bearer "+s,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setPushPerformLanguage:",e),n.RD.call(this,l)}function h(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/language"),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:null==e?void 0:e.success,error:null==e?void 0:e.error};return i.vF.debug("Call getPushPerformLanguage:",e),n.RD.call(this,p)}function m(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);if("number"!=typeof e.pageSize)throw Error('Invalid parameter: "pageSize"');var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={limit:e.pageSize||10,cursor:e.cursor};e.cursor||delete p.cursor;var l={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/mute/type"),type:"GET",dataType:"json",data:p,headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"}};return i.vF.debug("Call getSilentModeRemindTypeConversations:",e),n.RD.call(this,l).then((function(e){return e.data?{data:{conversations:e.data.map((function(e){return"user"in e?{conversationId:e.user,type:"singleChat",remindType:e.value}:{conversationId:e.group,type:"groupChat",remindType:e.value}})),cursor:e.cursor},type:e.type}:e}))}var v=o}},function(e){var r=e(e.s=4958);return r.default}])}));
+!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r():"function"==typeof define&&define.amd?define([],r):"object"==typeof exports?exports.websdk=r():e.websdk=r()}(self,(function(){return(self.webpackChunkwebsdk=self.webpackChunkwebsdk||[]).push([[624],{4958:function(e,r,t){t.d(r,{default:function(){return v}});var o={};t.r(o),t.d(o,{clearRemindTypeForConversation:function(){return p},getPushPerformLanguage:function(){return h},getSilentModeForAll:function(){return c},getSilentModeForConversation:function(){return l},getSilentModeForConversations:function(){return d},getSilentModeRemindTypeConversations:function(){return m},setPushPerformLanguage:function(){return f},setSilentModeForAll:function(){return s},setSilentModeForConversation:function(){return u}}),t(8706),t(1629),t(4346),t(8598),t(2062),t(739),t(9432),t(6099),t(3362),t(3500);var n=t(4269),a=t(1156),i=t(7968);function s(e){if(!(e.options instanceof Object))throw Error('Invalid parameter: "options"');var r=e.options.paramType;if("number"!=typeof r||r<0||r>2)throw Error('Invalid parameter: "options of paramType"');if(0===r){if("string"!=typeof e.options.remindType)throw Error('Invalid parameter: "options of remindType"')}else if(1===r){if("number"!=typeof e.options.duration)throw Error('Invalid parameter: "options of duration"')}else if(2===r){var t=e.options,o=t.startTime,s=t.endTime;if(!(o instanceof Object&&Object.keys(o).length))throw Error('Invalid parameter: "options of startTime"');if("number"!=typeof o.hours||"number"!=typeof o.minutes)throw Error('Invalid parameter: "options of startTime of hours or minutes"');if(!(s instanceof Object&&Object.keys(s).length))throw Error('Invalid parameter: "options of endTime"');if("number"!=typeof s.hours||"number"!=typeof s.minutes)throw Error('Invalid parameter: "options of endTime of hours or minutes"')}var c=a.dO.call(this).error;if(c)return Promise.reject(c);var u=this.context,p=u.accessToken,l=u.orgName,d=u.appName,f=u.userId,h=u.jid,m={};switch(r){case 0:m={type:e.options.remindType};break;case 1:m={ignoreDuration:e.options.duration};break;case 2:var v=e.options;o=v.startTime,s=v.endTime,m={ignoreInterval:"".concat(o.hours,":").concat(o.minutes,"-").concat(s.hours,":").concat(s.minutes)}}var y={url:"".concat(this.apiUrl,"/").concat(l,"/").concat(d,"/users/").concat(f,"/notification/user/").concat(f,"?resource=").concat(h.clientResource),type:"PUT",dataType:"json",data:JSON.stringify(m),headers:{Authorization:"Bearer "+p,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setSilentModeForAll:",e),n.RD.call(this,y)}function c(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/user/").concat(u),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:null==e?void 0:e.success,error:null==e?void 0:e.error};return i.vF.debug("Call getSilentModeForAll:",e),n.RD.call(this,p)}function u(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');if(!(e.options instanceof Object))throw Error('Invalid parameter: "options"');var r=e.options.paramType;if("number"!=typeof r||r<0||r>2)throw Error('Invalid parameter: "options of paramType"');if(0===r){if("string"!=typeof e.options.remindType)throw Error('Invalid parameter: "options of remindType"')}else if(1===r){if("number"!=typeof e.options.duration)throw Error('Invalid parameter: "options of duration"')}else if(2===r){var t=e.options,o=t.startTime,s=t.endTime;if(!(o instanceof Object&&Object.keys(o).length))throw Error('Invalid parameter: "options of startTime"');if("number"!=typeof o.hours||"number"!=typeof o.minutes)throw Error('Invalid parameter: "options of startTime of hours or minutes"');if(!(s instanceof Object&&Object.keys(s).length))throw Error('Invalid parameter: "options of endTime"');if("number"!=typeof s.hours||"number"!=typeof s.minutes)throw Error('Invalid parameter: "options of endTime of hours or minutes"')}var c=a.dO.call(this).error;if(c)return Promise.reject(c);var u=this.context,p=u.accessToken,l=u.orgName,d=u.appName,f=u.userId,h=u.jid,m="chatgroup",v={};switch(r){case 0:v={type:e.options.remindType};break;case 1:v={ignoreDuration:e.options.duration};break;case 2:var y=e.options;o=y.startTime,s=y.endTime,v={ignoreInterval:"".concat(o.hours,":").concat(o.minutes,"-").concat(s.hours,":").concat(s.minutes)}}"singleChat"===e.type&&(m="user");var g={url:"".concat(this.apiUrl,"/").concat(l,"/").concat(d,"/users/").concat(f,"/notification/").concat(m,"/").concat(e.conversationId,"?resource=").concat(h.clientResource),type:"PUT",dataType:"json",data:JSON.stringify(v),headers:{Authorization:"Bearer "+p,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setSilentModeForConversation:",e),n.RD.call(this,g)}function p(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p=t.jid,l="chatgroup";"singleChat"===e.type&&(l="user");var d={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/").concat(l,"/").concat(e.conversationId,"?resource=").concat(p.clientResource),type:"PUT",dataType:"json",data:JSON.stringify({type:"DEFAULT"}),headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call clearRemindTypeForConversation:",e),n.RD.call(this,d)}function l(e){if("string"!=typeof e.conversationId||!e.conversationId)throw Error('Invalid parameter: "conversationId"');if("string"!=typeof e.type||!e.type)throw Error('Invalid parameter: "type"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p="chatgroup";"singleChat"===e.type&&(p="user");var l={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/").concat(p,"/").concat(e.conversationId),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call getSilentModeForConversation:",e),n.RD.call(this,l)}function d(e){if(!Array.isArray(e.conversationList))throw Error('Invalid parameter: "conversationList"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p=[],l=[];e.conversationList.forEach((function(e){"singleChat"===e.type?p.push(e.id):l.push(e.id)}));var d=p.length?p.join(","):"",f=l.length?l.join(","):"",h={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification?user=").concat(d,"&group=").concat(f),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call getSilentModeForConversations:",e),n.RD.call(this,h)}function f(e){if("string"!=typeof e.language||!e.language)throw Error('Invalid parameter: "language"');var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t={translationLanguage:e.language},o=this.context,s=o.accessToken,c=o.orgName,u=o.appName,p=o.userId,l={url:"".concat(this.apiUrl,"/").concat(c,"/").concat(u,"/users/").concat(p,"/notification/language"),type:"PUT",dataType:"json",data:JSON.stringify(t),headers:{Authorization:"Bearer "+s,"Content-Type":"application/json"},success:e.success,error:e.error};return i.vF.debug("Call setPushPerformLanguage:",e),n.RD.call(this,l)}function h(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/language"),type:"GET",dataType:"json",headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"},success:null==e?void 0:e.success,error:null==e?void 0:e.error};return i.vF.debug("Call getPushPerformLanguage:",e),n.RD.call(this,p)}function m(e){var r=a.dO.call(this).error;if(r)return Promise.reject(r);if("number"!=typeof e.pageSize)throw Error('Invalid parameter: "pageSize"');var t=this.context,o=t.accessToken,s=t.orgName,c=t.appName,u=t.userId,p={limit:e.pageSize||10,cursor:e.cursor};e.cursor||delete p.cursor;var l={url:"".concat(this.apiUrl,"/").concat(s,"/").concat(c,"/users/").concat(u,"/notification/mute/type"),type:"GET",dataType:"json",data:p,headers:{Authorization:"Bearer "+o,"Content-Type":"application/json"}};return i.vF.debug("Call getSilentModeRemindTypeConversations:",e),n.RD.call(this,l).then((function(e){return e.data?{data:{conversations:e.data.map((function(e){return"user"in e?{conversationId:e.user,type:"singleChat",remindType:e.value}:{conversationId:e.group,type:"groupChat",remindType:e.value}})),cursor:e.cursor},type:e.type}:e}))}var v=o}},function(e){var r=e(e.s=4958);return r.default}])}));

package/types/index.d.ts

@@ -15,6 +15,14 @@ import * as ReactionType from './reactionApi';
 import * as ThreadType from './threadApi';
 import * as TranslationType from './translation';
 import * as SilentModeType from './silentModeApi';
+import type {
+	MessageSearchKeywordListMatchType,
+	MessageSearchOption,
+	MessageSearchScope,
+	SearchMeta,
+	ServerSearchMessage,
+	ServerSearchMessagesResult,
+} from './indexApi';
 export type {
 	ContactType,
 	GroupType,
@@ -29,4 +37,10 @@ export type {
 	Message,
 	Error,
 	Common,
+	MessageSearchKeywordListMatchType,
+	MessageSearchOption,
+	MessageSearchScope,
+	SearchMeta,
+	ServerSearchMessage,
+	ServerSearchMessagesResult,
 };

package/types/indexApi.d.ts

@@ -4,6 +4,8 @@ import {
 	MessageBody,
 	ModifiedMsgInfo,
 	ExcludeAckMessageBody,
+	ChatType,
+	MessageType,
 } from './message';
 interface UpdateOwnUserInfoParams {
 	/** The nickname. */
@@ -127,6 +129,99 @@ interface HistoryMessages {
 	isLast: boolean;
 }
 
+/**
+ * The multiple-keyword match type for server message search.
+ * `or` means any keyword can match, and `and` means all keywords must match.
+ * 服务端消息搜索的多关键词匹配关系。
+ * `or` 表示命中任意关键词即可，`and` 表示必须命中全部关键词。
+ */
+type MessageSearchKeywordListMatchType = 'or' | 'and';
+
+/**
+ * The search scope for server message search.
+ * `none` searches only the message body, `with` searches both body and extensions,
+ * and `only` searches only extension fields.
+ * 服务端消息搜索范围。
+ * `none` 仅搜索消息体，`with` 同时搜索消息体和扩展字段，
+ * `only` 仅搜索扩展字段。
+ */
+type MessageSearchScope = 'none' | 'with' | 'only';
+
+/**
+ * A WebSDK message object mapped from one server-side search hit.
+ * 由单条服务端搜索命中结果映射得到的 WebSDK 消息对象。
+ */
+type ServerSearchMessage = ExcludeAckMessageBody & {
+	/** The conversation ID of the matched message. */
+	/** 命中消息所属的会话 ID。 */
+	conversationId?: string;
+	/** Highlight fragments returned by the server. */
+	/** 服务端返回的高亮片段。 */
+	highlight?: string[];
+	/** Summary text returned by the server for quick display. */
+	/** 服务端返回的摘要文本，用于快速展示。 */
+	text?: string;
+};
+
+/**
+ * The paged result returned by server-side message search.
+ * 服务端消息搜索返回的分页结果。
+ */
+interface ServerSearchMessagesResult {
+	/** The server search result messages. */
+	/** 服务端搜索结果消息列表。 */
+	messages: ServerSearchMessage[];
+	/** The current page number. */
+	/** 当前页码。 */
+	pageNum: number;
+	/** The requested page size echoed by the SDK. */
+	/** SDK 回填的请求页大小。 */
+	pageSize: number;
+	/** The total number of pages. */
+	/** 总页数。 */
+	totalPages: number;
+	/** Whether the current page is the last page. */
+	/** 当前页是否为最后一页。 */
+	isLast: boolean;
+	/** The request trace id returned by the server. */
+	/** 服务端返回的请求追踪 ID。 */
+	requestId?: string;
+	/** The server response timestamp in milliseconds. */
+	/** 服务端响应时间戳，单位为毫秒。 */
+	timestamp: number;
+}
+
+/**
+ * The options for server-side message search.
+ * 用于配置服务端消息搜索请求的参数集合。
+ */
+interface MessageSearchOption {
+	/** The keyword list for search. */
+	/** 搜索关键词列表。 */
+	keywordList: string[];
+	/** The keyword list match type. The valid values are `or` and `and`. The default value is `or`. */
+	/** 多关键词匹配关系，可选值为 `or` 和 `and`。默认值为 `or`。 */
+	keywordListMatchType?: MessageSearchKeywordListMatchType;
+	/** The conversation ID for in-conversation search. */
+	/** 会话内搜索时的会话 ID。 */
+	conversationId?: string;
+	/** The conversation type for filtering. Must be used with conversationId. */
+	/** 会话类型过滤。需要与 conversationId 配合使用。 */
+	conversationType?: ChatType;
+	/** Message body type filters. */
+	/** 消息体类型过滤。 */
+	msgTypes?: MessageType[];
+	/** The start timestamp for query. The unit is millisecond. */
+	/** 查询开始时间戳，单位为毫秒。 */
+	startTime?: number;
+	/** The end timestamp for query. The unit is millisecond. */
+	/** 查询结束时间戳，单位为毫秒。 */
+	endTime?: number;
+	/** The search scope. */
+	/** 搜索范围。 */
+	searchScope?: MessageSearchScope;
+}
+
 interface ServerConversations {
 	/** The conversation list. */
 	conversations: ConversationItem[];
@@ -263,4 +358,9 @@ export type {
 	ConfigurableKey,
 	HistoryMessages,
 	ModifyMsgResult,
+	MessageSearchKeywordListMatchType,
+	MessageSearchScope,
+	ServerSearchMessage,
+	ServerSearchMessagesResult,
+	MessageSearchOption,
 };

package/types/message.d.ts

@@ -124,6 +124,8 @@ interface TextMsgBody {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateTextMsgParameters {
@@ -141,6 +143,8 @@ interface CreateTextMsgParameters {
 	ext?: {
 		[key: string]: any;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface CmdMsgSetParameters {
 	chatType: ChatType;
@@ -180,6 +184,8 @@ interface CmdMsgBody {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateCmdMsgParameters {
@@ -197,6 +203,8 @@ interface CreateCmdMsgParameters {
 	ext?: {
 		[key: string]: any;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface CustomMsgSetParameters {
 	chatType: ChatType;
@@ -245,6 +253,8 @@ interface CustomMsgBody {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateCustomMsgParameters {
@@ -266,6 +276,8 @@ interface CreateCustomMsgParameters {
 	ext?: {
 		[key: string]: any;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface LocationMsgSetParameters {
 	chatType: ChatType;
@@ -311,6 +323,8 @@ interface LocationMsgBody {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateLocationMsgParameters {
@@ -334,6 +348,8 @@ interface CreateLocationMsgParameters {
 	ext?: {
 		[key: string]: any;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface ImgMsgSetParameters {
 	chatType: ChatType;
@@ -381,6 +397,8 @@ interface ImgMsgBody extends ImgMsgSetParameters {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateImgMsgParameters {
@@ -421,6 +439,8 @@ interface CreateImgMsgParameters {
 		/** The file name. */
 		filename: string;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface AudioMsgSetParameters {
 	chatType: ChatType;
@@ -467,6 +487,8 @@ interface AudioMsgBody extends AudioMsgSetParameters {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateAudioMsgParameters {
@@ -507,6 +529,8 @@ interface CreateAudioMsgParameters {
 		/** The file type. */
 		filename: string;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface VideoMsgSetParameters {
 	chatType: ChatType;
@@ -557,6 +581,8 @@ interface VideoMsgBody extends VideoMsgSetParameters {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateVideoMsgParameters {
@@ -597,6 +623,8 @@ interface CreateVideoMsgParameters {
 		/** The file name. */
 		filename: string;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface FileMsgSetParameters {
 	chatType: ChatType;
@@ -643,6 +671,8 @@ interface FileMsgBody extends FileMsgSetParameters {
 	broadcast?: boolean;
 	isContentReplaced?: boolean;
 	deliverOnlineOnly?: boolean;
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	modifiedInfo?: ModifiedMsgInfo;
 }
 interface CreateFileMsgParameters {
@@ -679,6 +709,8 @@ interface CreateFileMsgParameters {
 		/** The file name. */
 		filename: string;
 	};
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 }
 interface ReceivedMsgBody {
 	id: string;
@@ -778,6 +810,8 @@ interface CombineMsgBody {
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
 	receiverList?: string[];
+	/** The webhookEnv field in the sending message protocol. */
+	webhookEnv?: string;
 	/** The file URL. */
 	url?: string;
 	/** The secret key required to download the file. */