参数说明 - 网易七鱼 API

网易七鱼系统轻量对接中的参数，不论是 Web SDK、iOS SDK、还是 Android SDK，都由一个用户唯一性标识uid和一个表示用户信息的 JSON 数组data组成。

在 Web SDK 中uid和data都直接出现在 JSON 中。iOS SDK 和 Android SDK 中，各定义了一个保存用户信息的结构体：iOS 中为QYUserInfo，Android 中为YSFUserInfo。iOS SDK 中，QYUserInfo.userId成员为用户唯一性标识字符串，QYUserInfo.data成员为表示用户信息的 JSON 字符串。Android SDK 中，YSFUserInfo.userId成员为用户唯一性标识字符串，YSFUserInfo.data成员为表示用户信息的 JSON 字符串。

下文参数说明中的uid分别对应 Web SDK 中的 JSON 字段 uid、iOS SDK 中的QYUserInfo.userId、Android SDK 中的YSFUserInfo.userId；data分别对应 Web SDK 中的 JSON 字段 data、iOS SDK 中的QYUserInfo.data、Android SDK 中的YSFUserInfo.data。需要特别注意的是，UID长度不能超过64个字符。

参数	类型	必须	说明
`uid`	String	是	用户唯一性标识。
`data`	Array / String	是	用一个数组（或表示 JSON 数组的字符串），表示要显示在客服端的扩展信息。

其中data字段用一个数组（iOS / Android SDK 中是一个表示 JSON 数组的字符串）描述用户的详细信息，数组中每个元素代表一个数据项。数据项以<key, value>对的形式为基础，增加了额外的字段以控制显示样式。数据项定义如下：

字段	类型	必须	说明
`key`	String	是	数据项的名称，用于区别不同的数据。其中`real_name`、`mobile_phone`、`email`为保留字段，分别对应客服工作台用户信息中的“姓名”、“手机”、“邮箱”这三项数据。保留关键字对应的数据项中，`index`、`label`属性将无效，其显示顺序及名称由网易七鱼系统指定。
`value`	Mixed	是	该数据显示的值，类型不做限定，根据实际需要进行设定。
`label`	String	是	该项数据显示的名称。
`index`	Int	否	用于排序，显示数据时数据项按`index`值升序排列；不设定`index`的数据项将排在后面；`index`相同或未设定的数据项将按照其在 JSON 中出现的顺序排列。
`href`	String	否	超链接地址。若指定该值，则该项数据将显示为超链接样式，点击后跳转到其值所指定的 URL 地址。
`hidden`	Boolean	否	仅对`mobile_phone`、`email`两个保留字段有效，表示是否隐藏对应的数据项，`true`为隐藏，`false`为不隐藏。若不指定，默认为`false`不隐藏。

注意： real_name、mobile_phone、email三个保留字段的特别说明：

若使用保留字段，数据将对应显示在“姓名”、“手机”、“邮箱”的位置上，顺序、名称不能指定；

若使用保留字段，“姓名”、“手机”、“邮箱”对应的数据将不可编辑，以传递的数据为准；在不使用保留字段的情况下，这三项内容以客服填写的为准，并且可以修改；

其中mobile_phone、email两项可以通过hidden字段隐藏，real_name不可隐藏；

如果既想通过轻量对接提供“姓名”、“手机”、“邮箱”这三项数据，又希望客服可以修改、维护这些信息，可以避开保留关键字，用不同的key来提供数据；这在访客改变了联系方式，但没有及时更新用户信息的情况下非常有用。

注意： 提交的数据将根据预设的样式直接显示在网易七鱼页面相应的位置上。如果数据敏感、保密性要求高，应当在提交时就做脱敏处理。网易七鱼系统不会对数据做额外的处理。