UNPKG

2.28 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps } from './common'
3interface ContactButtonProps extends StandardProps {
4 /** 必填。企业唯一编码,一个企业支付宝账号对应一个编码。
5 * @supported alipay
6 */
7 tntInstId: string
8 /** 必填。聊天窗编码,每个聊天窗的唯一编码。
9 * @supported alipay
10 */
11 scene: string
12 /** 选填。咨询按钮大小,正方形设置边长(如25*25 px)。
13 * @supported alipay
14 * @default 25
15 */
16 size?: number | string
17 /** 选填。咨询按钮颜色,默认白底蓝色。
18 * @supported alipay
19 * @default "#00A3FF"
20 */
21 color?: string
22 /** 选填。咨询按钮头像。
23 * @supported alipay
24 */
25 icon?: string
26 /** 选填。支付宝访客用户ID(2088开头)。
27 * 说明: 客服回答问题时,如客户已离开咨询窗口,则通过推送消息到支付宝 card 中提醒客户。
28 * @supported alipay
29 */
30 alipayCardNo?: string
31 /** 选填。该属性主要用于传递一些扩展信息给组件,以实现一些高级功能。该属性值的生成方式为:encodeURIComponent({"字段名":"字段值"}), 其中,字段名和字段值要根据实际使用的功能进行替换。
32 * 目前通过传入扩展信息可支持的 3 个功能:
33 * 1.访客名片。需传 cinfo 和 key 两个扩展字段,代码形如在云客服中进入 设置 > 服务窗配置 > 聊天窗 URL。点击操作栏中的 聊天窗 URL ,获取 tntInstId(企业编码)和 scene(聊天窗编码)。encodeURIComponent({"cinfo":"生成的 cinfo","key":"生成的key"}),cinfo 和 key 的值说明 支付宝小程序接入访客名片;
34 * 2.聊天窗默认带出用户的小程序订单数据。需传 appId 字段,代码形如encodeURIComponent({"appId":"商户小程序appid"})
35 * 3.未读客服消息同步至"我的小程序-我的"。同样需传 appId 字段,代码形如 encodeURIComponent({"appId":"商户小程序appid"})。
36 * @supported alipay
37 */
38 extInfo?: string
39}
40/** 智能客服
41 * @classification open
42 * @supported alipay
43 * @see https://opendocs.alipay.com/mini/component/contact-button
44 */
45declare const ContactButton: ComponentType<ContactButtonProps>
46export { ContactButton, ContactButtonProps }