文档中心 > 商家经营工具-开发指引

千牛消息去淘宝Nick改造

更新时间：2023/04/04 访问次数：13770

一、总体改造说明
二、改造内容
三、千牛插件容器（H5）
四、千牛小程序（windmill）容器

一、总体改造说明

应隐私保护合规要求，保障消费者的隐私，需要对千牛相关的应用进行消费者Nick下线处理。

整体盘点千牛相关涉及此次去NICK改造的板块包含：千牛插件、千牛小程序两个核心板块的应用。

二、改造内容

1. 后续不再提供服务使用的相关API接口下线，服务商需要从自己功能上REVIEW和处理解除对待下线API的依赖；

2. 目前对外包含Nick的API，新增SecurityUID和BizDomain 用于替代Nick做用户身份为一识别（PS：改造和兼容阶段，涉及入参的API请暂时保留NICK入参字段，统一下线NICK时间关注后续平台公告）

3. 后续不再提供服务使用的相关事件下线，服务商需要从自己功能上REVIEW和处理解除对待下线事件的依赖；

4. 目前对外提供服务包含NICK的相关事件下，新增SecurityUID 用于替代Nick做用户身份为一识别。

核心改造细节：

1）原参数里带nick的，都准备下线，不允许做核心链路串流程使用，老nick字段完成新老替换后即刻下线；

2）用SecurityUID+BizDomain替换原来的nick；

3）SecurityUID的定义，三方指ISV，OpenUID；

4）兼容期过后，新版本SecurityUID+bizDomain(如果有)将替换原nick为必选字段；

5）改造和兼容阶段，涉及入参的API请务必暂时保留NICK入参字段，否则老版本客户端将无法兼容；

6）具体改造涉及API，事件实例等内容描述详见如下文档，请服务商参考文档说明进行系统调整和适配改造。

调试客户端：https://download.alicdn.com/wangwang/qianniu_(9.09.20N).exe。

三、千牛插件容器（H5）

1. 下线API （请仔细排查是否有在使用，如果有请安排下线，禁止使用）

id	type	code	eventName
37	category	pcww.jiaoyiguanli	orderRemarks
38	category	pcww.jiaoyiguanli	priceChange
39	category	pcww.jiaoyiguanli	postageFree
40	category	pcww.jiaoyiguanli	checkLogistics
48	module	module_wangwang.chat	suggestIntelligentReply
51	category	pc.cuxiaoguanli	sendCoupons
55	category	pcww.cuxiaoguanli	sendCouponsByWW
96	module	module_component.crm_label	crmLabel
115	module	module_wangwang.chat	getTradeFocus
116	module	module_wangwang.chat	chat
122	module	module_wangwang.chat	setContactReaded
114	module	module_wangwang.chat	getContactInfo
120	module	module_wangwang.chat	openHistoryMsg
121	module	module_wangwang.chat	sendMsg
206	category	pcww.jiaoyiguanli	remindPay
207	category	pcww.shangpinguanli	itemToUser
362	module	module_wangwang.chat	getChatContactList
399	module	module_component.select_ent_employee	selectEnterpriseEmployee
448	module	module_wangwang.chat	getLiveActiveUser
		pc.21817572	alingCallout

2. API改动

1）交易列表 (tradeList)

2）核对地址 (checkAddress)

3）打开聊天记录 (openChatRecord)

151

appkey

pc.23052006

openChatRecord

入参

改动说明	参数名	必传	类型	示例	描述
即将下线	employeeNick	否	string	测试账号	员工昵称，如果不传取当前免登用户
即将下线	customerNick	否后期会下线，请用 customerSecurityUID	string	测试账号	客户昵称 customerNick 和 employeeNick 二选一不带cntaobao前缀
	start	否	string	2013-04-01	开始时间
	end	否	string	2014-04-01	结束时间
新增	customerSecurityUID	否	string	customerSecurityUID	客户昵称 customerNick 和 employeeNick 二选一用户安全UID, 二方为加密UID，三方为openUID

调用示例

QN.application.invoke( {
        cmd : 'openChatRecord',
        param : {
                                        employeeNick : 'nick'  ,
                                            customerNick : '测试账号'  ,
                                            start : '2013-04-01'  ,
                                            end : '2014-04-01'  ,
                                            customerSecurityUID : 'customerSecurityUID'  ,
                            
        }
});

4）打开选择订单组件 (selectOrder)

入参

改动说明	参数名	必传	类型	示例	描述
兼容期过后，将下线	chatNick	是	string	卖家账号	// 不带有cntaobao前缀的nick
	hotkey	是	string	hotkey	// 透传API调用中的hotkey字段
	tradeList	是	string	[{"created":"2014-06-16 20:19:05","pic_path":"http:\/\/img02.taobaocdn.com\/bao\/uploaded\/i2\/T1iYa9FJhaXXXXXXXX_!!0-item_pic.jpg","title":"测试宝贝请不要","status":"WAIT_BUYER_PAY","tid":696470982139825},{"created":"2014-06-16 20:19:05","pic_path":"http:\/\/img02.taobaocdn.com\/bao\/uploaded\/i2\/T1iYa9FJhaXXXXXXXX_!!0-item_pic.jpg","title":"测试宝贝请不要拍","status":"WAIT_BUYER_PAY","tid":6964270982139825}]	// tradeList为json对象数组格式化后的字符串，数据由插件根据页面缓存的数据进行组装，组件负责显示与选择的交互。

返回结果

{"tid":1.234567891E10}

属性名	类型	示例	描述
tid	number	12345678910	订单ID

5）打开旺旺聊天窗 (openChat)

入参

改动说明	参数名	必传	类型	示例	描述
即将下线	nick	是	string	cntaobao商家测试账号	聊天的对象的nick，nick前请带上nick域, 所属域可选值为：cntaobao\|cnalichn\|enaliint cntaobao 是淘宝用户 cnalichn 是中文站用户 enaliint 是国际站用户
新增	bizDomain	否	string	taobao	【目前为兼容老端，实际为必填字段】对方聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	sceneParam	否	string	{"toRole":"buyer"}	场景信息，json格式，默认为空身份为买家。当前亮灯对象为买家时： {"toRole":"buyer"} 当前亮灯对象为卖家时： {"toRole":"seller"} 注意： 1.买家：buyer 触达消费者场景，消息会话在手淘，买旺等消费者端透出（即对方如果在手淘上可以收到消息）。 2.卖家：seller 触达商家场景，消息会话不支持在手淘，买旺消费端透出，在千牛商家端透出（即对方如果在手淘上收不到消息）。
新增	securityUID	否	string	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】对方聊天账号的加密UID

调用示例

QN.application.invoke( {
        cmd : 'openChat',
        param : {
                                        nick : 'cntaobao商家测试账号'  ,
                                            bizDomain : 'taobao'  ,
                                            sceneParam : '{"toRole":"buyer"}'  ,
                                            securityUID : '安全UID，三方为openUID，二方为加密UID'  
                            
        }
});

6）获取显示名(displayNick) (getDisplayNick)

入参

改动说明	参数名	必传	类型	示例	描述
即将下线	uids	否	string	["cntaobaokli001","cntaobao寺原"]	snick数组
新增	securityUIDs	否	string	{"security1":"taobao", "security2":"taobao"}	json字符串，内部为map<key, value>形式，key为securityUID，用户安全UID，二方加密UID三方openUID，value为bizDomain，用户聊天域，支持taobao、cub两种

返回结果

{"dnickFromSecurityUIDs":"{\"securityUID1\":\"客户展示名1\",\"security2\":\"寺原\"}","dnicks":"{\"cntaobaokli001\":\"kli001\",\"cntaobao寺原\":\"寺原\"}"}

改动说明	属性名	类型	示例	描述
即将下线	dnicks	string	{"cntaobaokli001":"kli001","cntaobao寺原":"寺原"}	查询sinck对应的displaynick. 类型是一个key-value的map
新增	dnickFromSecurityUIDs	string	{"securityUID1":"客户展示名1","security2":"寺原"}	查询securityUID对应的displaynick. 类型是一个key-value的map

调用示例

QN.application.invoke( {
        cmd : 'getDisplayNick',
        param : {
                                        uids : '["cntaobaokli001","cntaobao寺原"]'  ,
                                            securityUIDs : '{"security1":"taobao", "security2":"taobao"}'  
                            
        },
        error : function(msg, cmd, param) {
           // 调用失败
        },
        success : function(rsp, cmd, param) {
           // 回调结果
        }
        
});

7）获取当前聊天对象 (getActiveUser)

入参

参数名

必传

类型

示例

描述

返回结果

{"uid":"cntaobaoUserNick","securityUID":"securityUID","bizDomain":"taobao"}

改动说明	属性名	类型	示例	描述
即将下线	uid	string	cntaobaoUserNick	用户nick
新增	bizDomain	string	taobao	当前聊天对象的聊天域 taobao 或 cbu
新增	securityUID	string	securityUID	当前聊天对象的安全UID，二方加密uid，三方openuid

调用示例

QN.application.invoke( {
        cmd : 'getActiveUser',
        param : {
                        
        },
        error : function(msg, cmd, param) {
           // 调用失败
        },
        success : function(rsp, cmd, param) {
           // 回调结果
        }
        
});

8）打开旺旺插件 (openWWPlugin)

入参

	参数名	必传	类型	示例	描述
	appkey	否	string	4272	插件的appkey，和category之间必须填一个。只有插件为group类型，并且与调用方为同一个appkey时，才允许通过appkey直接调用。
	category	否	string	shangpinguanli	插槽类目，和appkey之间必须填一个，如果都存在，category优先appkey
	event	否	string	customEvent	打开插件时透传event参数
新增内容参数	param	是	string	{\"securityUID\":\"xxxxxxaaAAss\"\"bizDomain\":\"taobao\",\"chatNick\":\"cntaobao白金店主\"}	打开插件时透传param参数，其中必需带securityUID（二方加密UID，三方OpenUID），bizDomain（账号聊天域，支持taobao、cbu）参数，chatNick参数【即将下线】【兼容期，兼容期过后废弃】。

调用示例

QN.application.invoke( {
        cmd : 'openWWPlugin',
        param : {
                                        appkey : '4272'  ,
                                            category : 'shangpinguanli'  ,
                                            event : 'customEvent'  ,
                                            param : '{\"securityUID\":\"xxxxxxaaAAss\"\"bizDomain\":\"taobao\",\"chatNick\":\"cntaobao白金店主\"}'  
                            
        }
});

9）向输入框插入文字 (insertText2Inputbox)

入参

改动说明	参数名	必传	类型	示例	描述
即将下线	uid	是	string	cntaobaoTestID	指定插入文字的聊天对象
	text	是	string	\\C0xff0000\\S0xf\\FCourier New\\Thello world!/:^_^	聊天内容
	type	是	number	1	0 表示普通文本 1 表示富文本关于向旺旺输入框插入富文本串的特别说明：每一段富文本以【\T文字内容】结束，目前开放的可修饰的控制符： \C 颜色0xff00ff，以<蓝绿红>的顺序标识，如蓝色：\C0xff0000 \S 字体大小，如10号字体：\S0xa \F 字体，如：\F微软雅黑, \FCourier New \B 黑体 \I 斜体 \U 下划线 \N 用于分隔富文本 '\n'可以直接用于换行 \T 作为一段富文本的结束，\T后跟文字或系统默认表情，如：\Thello/:^_^ \B，\I，\U，如果不主动设置取消，标识后续的文字都会保持这个格式。取消的方式是再次设置同样的标识，例如：\B\T这是粗体\B\T这是取消后的细体，\B\T这是粗体\I\T这是继承了粗体的粗斜体。注意点：由于js中以字符串字面值来支持富文本格式化串，反斜杠需要用'\\'来表示。
新增	securityUID	否	string	xxxxxxxxxx	用户安全UID，二方为加密uid，三方为openuid
新增	bizDomain	否	string	taobao	用户聊天域信息 taobao、cbu

调用示例

QN.application.invoke( {
        cmd : 'insertText2Inputbox',
        param : {
                                        uid : 'cntaobaoTestID'  ,
                                            text : '\\C0xff0000\\S0xf\\FCourier New\\Thello world!/:^_^'  ,
                                            type : 1  ,
                                            securityUID : 'xxxxxxxxxx'  ,
                                            bizDomain : 'taobao'  
                            
        }
});

3. 事件改动

1）wangwang.active_contact_changed

改动说明	参数名	值/返回值	备注
	eventId	wangwang.active_contact_changed	旺旺聊天焦点用户切换对于旺旺插件，如果不监听，每次切换旺旺联系人将刷新callback_url，用户感受延迟体验不好，并造成ISV后台压力。强烈建议使用监听该事件的方式来做，但需要保证内存不泄漏。
新增内容返回	data	{ 'newContact':xxx, 'oldContact':xxx 'newContactNumberId': 'oldContactNumberId': 'oldContactSecurityUID': ‘newContactSecurityUID’ }	参数：原：即将下线string newContact; // 当单聊会话时，为用户NICK，隐私合规（22年8月）后，将不返回数据切勿强依赖使用。当是群是为群ID 即将下线string oldContact; // 当单聊会话时，为用户NICK，隐私合规（22年8月）后，将不返回数据切勿强依赖使用。当是群是为群ID string 即将下线newContactNumberId; // 群或者联系人数字ID 隐私合规（22年8月）后，将不返回数据切勿强依赖使用。 string 即将下线oldContactNumberId; // 群或者联系人数字ID 隐私合规（22年8月）后，将不返回数据切勿强依赖使用。新增参数： string 新增字段oldContactSecurityUID：插件标识联系人UID，当单聊时为安全标识联系人UID，当群聊时为群ID string 新增字段newContactSecurityUID：插件标识联系人UID，当单聊时为安全标识联系人UID，当群聊时为群ID
	msg(reg)
	msg(unreg)

2）wangwang.contact_joined 联系人列表中加入新的接入人

是否改动	参数名	值/返回值	备注
	eventId	wangwang.contact_joined	联系人列表中加入新的接入人
新增部分内容	data	{ 'contact':"新接入的联系人" 'uid' 'securityUID' }	新增字段 securityUID：新加入的联系人安全UID，二方为加密UID，三方为OpenUID 即将下线 contact 即将下线 uid
	msg(reg)
	msg(unreg)

4. 下线事件（请仔细排查是否有在使用，如果有请安排下线，禁止使用）

事件名	备注
wangwang.active_live_contact_changed	直播联系人变化
wangwang.trade_focus
wangwang.contact_closed
wangwang.recvmsgurl.itemid

四、千牛小程序（windmill）容器

1. 下线API（请仔细排查是否有在使用，如果有请安排下线，禁止使用）

my.qn.registerServerCommand	https://yuque.antfin-inc.com/tb-miniapp/pc-api/my.qn.registerservercommamd
my.qn.unregisterServerCommand	https://yuque.antfin-inc.com/tb-miniapp/pc-api/my.qn.unregisterservercommand

2. API改动

1）my.qn.imInsertText2Inputbox

插入消息到IM输入框。

入参

Object 类型，属性如下：

改动说明	属性	类型	是否必须	说明
即将下线	uid	String	是 [目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	指定插入文字的聊天对象
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】对方聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】对方聊天账号的加密UID
	type	Int	是	0 表示普通文本 1 表示富文本
	success	Function	否	调用成功的回调函数
	fail	Function	否	调用失败的回调函数
	complete	Function	否	调用结束的回调函数（调用成功、失败都会执行）

调用示例

my.qn.imInsertText2Inputbox({
      uid:"cntaobao陌环",
    bizDomain:"taobao",
    securityUID:"asdfasdfdsafds",
    text:"我是测试内容",
    type:0,
    success: (res) => {
       console.log(JSON.stringify(res))
    },
    fail: (res) => {
       console.log(JSON.stringify(res))
    }
});

2）my.qn.imInsertImage2Inputbox

功能描述插入图片到IM输入框。

参数/返回值

改动说明	名称	类型	是否必填，默认值	描述
	参数
即将下线	uid	String	是 [目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	指定插入文字的聊天对象
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】对方聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】对方聊天账号的加密UID
	apFilePath	String	是	图片伪路径，由其他小程序API生成
	返回值
	无

调用示例

my.saveImage({
  url: 'https://img.alicdn.com/tfs/TB1_uT8a5ERMeJjSspiXXbZLFXa-143-59.png',
  success: (res) => {
    console.log(res)
    my.qn.imInsertImage2Inputbox({
      uid: 'cnalichnalikjj',      // 昵称
      bizDomain:"taobao",
      securityUID:"asdfasdfdsafds",
      apFilePath: res.apFilePath, // 伪路径
      success: (res) => {
        console.log(res) // {success: true}
      },
    })
  },
});

3）my.qn.imGetActiveUser

功能描述获取当前IM旺旺联系人。

参数/返回值

改动说明	名称	类型	是否必填，默认值	描述
	参数
	/
	返回值
即将下线	user_nick	String	[目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	当前旺旺聊天的对方联系人昵称
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】当前聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】当前聊天账号的加密UID

调用示例

my.qn.imGetActiveUser({
  success: (res) => {
      console.log(res)  // {"user_nick":"cntaobaoXXX","securityUID":"xxxxx", "bizDomain":"taobao"} 
  },
})

4）my.qn.openSOPTransferWindow

打开客服sop任务转交窗口。

入参

Object 类型，属性如下：

	属性	类型	是否必须	说明
即将下线	contactid	string	[目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	联系人id, 带站点信息
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】联系人聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】联系人聊天账号的加密UID
	metaid	String	是	任务 metaid

调用示例

 my.qn.openSOPTransferWindow({
          contactid:"cntaobaotest",
          metaid:"123123",
          securityUID:"xx",
          bizDomain:"taobao",
          success: (res) => {
            this.setData({ btnText: '成功:' +JSON.stringify(res)})
                        },
          fail: (error) => {
            this.setData({ btnText: '失败:' + JSON.stringify(error)});
          },
      });

5）my.qn.openSOPDealWindow

打开客服sop任务处理窗口。

入参

Object 类型，属性如下：

	属性	类型	是否必须	说明
即将下线	contactid	string	是	联系人id, 带站点信息
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】联系人聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】联系人聊天账号的加密UID
	metaid	string	是	任务 metaid
	taskid	string	是	任务 taskid

调用示例

 my.qn.openSOPDealWindow({
          contactid:"cntaobaotest",
          metaid:"123123",
          taskid:"656565",
   securityUID:"xx",
   bizDomain:"taobao",
          success: (res) => {
            this.setData({ btnText: '成功:' +JSON.stringify(res)})
                        },
          fail: (error) => {
            this.setData({ btnText: '失败:' + JSON.stringify(error)});
          },
      });

6）my.qn.openChat

打开聊天窗口并输入待发送的信息。

	属性	类型	必填	描述
即将下线	nick	String	是[目前阶段：nick，uid，bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用uid和bizDomain]	聊天对象的nick，含站点名称，例如cntaobaoXXX（淘宝），chalichnYYY（中文站）等等
	text	String	否	待发送的信息。如果聊天框里已有内容，会追加到光标处（如果焦点正在输入框）或追加到最后。
新增	securityUID	String	是	二方为加密UID，三方为OpenUID
新增	bizDomain	String	是	聊天对象的账号域，目前只支持"taobao", "cbu"
	sceneParam	String	否	场景信息，jsonString，默认为空身份为买家。当前亮灯对象为买家时：{"toRole":"buyer"}当前亮灯对象为卖家时：{"toRole":"seller"} 注意：1.买家：buyer触达消费者场景，消息会话在手淘，买旺等消费者端透出（即对方如果在手淘上可以收到消息）。2.卖家：seller触达商家场景，消息会话不支持在手淘，买旺消费端透出，在千牛商家端透出（即对方如果在手淘上收不到消息）。

调用示例

// 打开聊天窗口并输入待发送的信息
my.qn.openChat({
  nick: 'cnalichnalikjj', // 昵称，要带站点
  text: 'hello',          // 信息，可选
  securityUID:'alikjj的加密UID',
  bizDomain:'taobao',
  success: (res) => {
    console.log(res); // {success: true}
  },
  fail: (res) => {
    console.log(res); // {errorMessage: "nick 错误", error: 3}
  },
});

7）私有协议 - my.qn.OpenChatEx

打开群聊聊天窗口并可以回复或定位到消息，只支持群聊。

改动说明	参数名	必传	类型	示例	描述
	chatId	是	string	0_G_2674567688_1544087053580	聊天会话ID
	chatType	是	string	0	0：为手淘群（目前仅支持）
	msgContent	是	string	被回复消息内容	被回复消息内容，如果为文本，填写文本内容，其他类型填“”
	msgId	是	string	61788855855	被回复消息ID
	msgType	是	string	101	被回复消息类型
	sendUid	是	string	1234568	被回复消息的发送者数字ID
语义改变为用户展示名称，仅用于展示。	sendNick	是	string	devtest	被回复消息发送者的展示名称
	needReplyMsg	是	string	1	0为不需要填充回复，非0填充
	needLocateMsg	是	string	1	0为不定位消息，非0定位

8）my.qn.isInputboxEmpty

功能描述判断指定会话输入框内容是否为空。

入参

	名称	类型	是否必传	描述
即将下线	uid	String	[目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	买家nick
新增	bizDomain	String	是	taobao	【目前为兼容老端，实际为必填字段】买家聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	是	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】买家聊天账号的加密UID

出参

名称	类型	描述
isEmpty	Boolean	是否当前指定买家聊天输入框是否有内容

调用示例

my.qn.isInputboxEmpty({
  uid:"cntaobao商家测试账号",
  securityUID:"xx",
  bizDomain:"taobao",
  success: (res) => {
    console.log(res);
  },
  fail: (res) => {
   console.log(res);
  },
})

9）my.qn.imGetCurrentChatImages

功能描述获取当前会话中的聊天图片，返回最近的最多10张图片地址和用户nick。调用者还需要对nick做校验。

参数/返回值

	名称	类型	是否必填，默认值	描述
	参数
	无
	返回值
	success	bool	是	是否调用成功
即将下线	nick	String	否 [目前阶段：nick，securityUID， bizDomain，均为必填字段隐私保护系统上线全量期（待官方通知）：此字段废除，新逻辑务必使用securityUID和bizDomain]	用户的nick
新增	bizDomain	String	否	taobao	【目前为兼容老端，实际为必填字段】买家聊天域的信息，目前支持 taobao、cbu两种，taobao:淘宝域，cbu 1688域
新增	securityUID	String	否	安全UID，三方为openUID，二方为加密UID	安全UID，三方为openUID，二方为加密UID 【目前为兼容老端，实际为必填字段】买家聊天账号的加密UID
	data	String	否	返回的聊天图片数组，最多10张

调用示例

  my.qn.imGetCurrentChatImages({
      success: (res) => {
        console.log(res) //{"data":"[\"https://img.alicdn.com/imgextra/xxxxxxxxxxxx.jpg\"]","nick":"xxxxxxxx","success":true}
      },
    })

10）my.qn.openWWPlugin

打开旺旺插件通用API。(仅提供给二方使用)预览体验。

入参

Object 类型，属性如下：

改动说明	属性	类型	是否必须	说明
	appkey	String	是	需要打开插件的appkey
	pageName	String	否	打开插件后跳转的页面(功能)
新增内容key	param	String	是	对应传递给小程序(插件)的参数, json字符串格式 {\"securityUID\":\"xxxxxxaaAAss\"\"bizDomain\":\"taobao\",\"chatNick\":\"cntaobao白金店主\"}打开插件时透传param参数，其中必需带securityUID（二方加密UID，三方OpenUID），bizDomain（账号聊天域，支持taobao、cbu）参数，即将下线 chatNick参数【兼容期，兼容期过后废弃】。
	success	Function	否	调用成功的回调函数
	fail	Function	否	调用失败的回调函数
	complete	Function	否	调用结束的回调函数（调用成功、失败都会执行）

调用示例

my.qn.openWWPlugin({
    appkey:"",
    pageName:"千牛通用协议名 会带入到url参数中",
    param:"{\"chatNick\":\"cntaobao王东炜199108\"}"
    success: (res) => {
     console.log(JSON.stringify(res))
    },
    fail: (res) => {
     console.log(JSON.stringify(res))
    }
});

11）my.qn.openWWCategory

打开千牛插件协议槽。

Object 类型，属性如下：

改动说明	属性	类型	是否必须	说明
	category	String	是	插槽名(如 jiaoyiguanli/shangpinguanli/huiyuanguanli等)
	pageName	String	否	千牛通用协议名会带入到url参数中
新增内容key	param	String	是	对应传递给小程序(插件)的参数, json字符串格式 {\"securityUID\":\"xxxxxxaaAAss\"\"bizDomain\":\"taobao\",\"chatNick\":\"cntaobao白金店主\"} 打开插件时透传param参数，其中必需带securityUID（二方加密UID，三方OpenUID），bizDomain（账号聊天域，支持taobao、cbu）参数，即将下线chatNick参数【兼容期，兼容期过后废弃】。
	success	Function	否	调用成功的回调函数
	fail	Function	否	调用失败的回调函数
	complete	Function	否	调用结束的回调函数（调用成功、失败都会执行）

调用示例

my.qn.openWWCategory({
    category:"jiaoyiguanli", //千牛插件的插槽
    pageName:"千牛通用协议名 会带入到url参数中",
    param:"{\"chatNick\":\"cntaobao白金店主\", \"securityUID\":\"\",\"bizDomain\":\"\"}",
   success: (res) => {
     console.log(JSON.stringify(res))
    },
    fail: (res) => {
     console.log(JSON.stringify(res))
    }
});

3. 下线事件（请仔细排查是否有在使用，如果有请安排下线，禁止使用，兼容期过后平台侧将不在返回数据）

以下事件均下线如果有调用，请安排下线。

事件形式：my.qn.onXXXXXXXX

attachWndClose

qtaskChanged",

tradeInfo",

itemInfo",

refundInfo",

qtaskInfo",

taskInfo",

imRecvU2UMsgBatch",

imContactJoined",

imContactClosed",

imTradeFocus",

imRecvMsgUrlItemId",

imFbtOptions",

pluginUpdate",

imActiveLiveContactChanged",

serviceLiveStatusChanged",

getServiceLiveStatusFinish",

serviceLivePushflowInterface"。

4. 事件改动

1）my.qn.onImActiveContactChanged

联系人切换。原插件事件 wangwang.active_contact_changed（不支持工作台小程序）。

改动说明

参数名

值/返回值

备注

新增内容返回

data

{

'newContact':xxx,

'oldContact':xxx

'newContactNumberId':

'oldContactNumberId':

'oldContactSecurityUID':

‘newContactSecurityUID’

}

参数：

原：

即将下线

string newContact; // 当单聊会话时，为用户NICK，隐私合规（22年8月）后，将不返回数据切勿强依赖使用。当是群是为群ID

即将下线

string oldContact; // 当单聊会话时，为用户NICK，隐私合规（22年8月）后，将不返回数据切勿强依赖使用。当是群是为群ID

即将下线

string newContactNumberId; // 群或者联系人数字ID 隐私合规（22年8月）后，将不返回数据切勿强依赖使用。

即将下线

string oldContactNumberId; // 群或者联系人数字ID 隐私合规（22年8月）后，将不返回数据切勿强依赖使用。

新增参数：

string oldContactSecurityUID：插件标识联系人UID，当单聊时为安全标识联系人UID，当群聊时为群ID

string newContactSecurityUID：插件标识联系人UID，当单聊时为安全标识联系人UID，当群聊时为群ID

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

改动说明	参数名	必传	类型	示例	描述
	tradeStatus	否	enum	WAIT_SELLER_SEND_GOODS	交易状态，默认查询所有交易状态的数据，除了默认值外每次只能查询一种状态。可选值： WAIT_BUYER_PAY(等待买家付款) WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) TRADE_FINISHED(交易成功) TRADE_CLOSED(交易关闭) TRADE_REFUND(退款中)
即将下线	buyerNick	否	string	zhangsan	买家nick
	startCreated	否	string	2000-01-01 00:00:00	查询起始时间
	endCreated	否	string	2001-01-01 00:00:00	查询结束时间
新增	securityUID	否	string	AAHBuE68ABXJalyTEL2cIqWI	用户安全UID, 二方为加密UID，三方为openUID

淘宝开放平台

商家经营工具-开发指引

千牛消息去淘宝Nick改造

一、总体改造说明

二、改造内容

三、千牛插件容器（H5）

1. 下线API （请仔细排查是否有在使用，如果有请安排下线，禁止使用）

2. API改动

1）交易列表 (tradeList)

2）核对地址 (checkAddress)

3）打开聊天记录 (openChatRecord)

4）打开选择订单组件 (selectOrder)

5）打开旺旺聊天窗 (openChat)

6）获取显示名(displayNick) (getDisplayNick)

7）获取当前聊天对象 (getActiveUser)

8）打开旺旺插件 (openWWPlugin)

9）向输入框插入文字 (insertText2Inputbox)

3. 事件改动

1）wangwang.active_contact_changed

2）wangwang.contact_joined 联系人列表中加入新的接入人

4. 下线事件（请仔细排查是否有在使用，如果有请安排下线，禁止使用）

四、千牛小程序（windmill）容器

1. 下线API（请仔细排查是否有在使用，如果有请安排下线，禁止使用）

2. API改动

1）my.qn.imInsertText2Inputbox

2）my.qn.imInsertImage2Inputbox

3）my.qn.imGetActiveUser

4）my.qn.openSOPTransferWindow

5）my.qn.openSOPDealWindow

6）my.qn.openChat

7）私有协议 - my.qn.OpenChatEx

8）my.qn.isInputboxEmpty

9）my.qn.imGetCurrentChatImages

10）my.qn.openWWPlugin

11）my.qn.openWWCategory

3. 下线事件（请仔细排查是否有在使用，如果有请安排下线，禁止使用，兼容期过后平台侧将不在返回数据）

4. 事件改动

1）my.qn.onImActiveContactChanged

FAQ