在线会话获取用户信息

POST

/get_user_info

网易七鱼系统在需要获取访客详细信息时，会调用该接口。该接口请求类型不同于token，前端会自动发送两次请求，第一次的请求类型是OPTION，第二次的请求类型是POST，且POST提交数据的方式为application/json。

返回的数据将显示在“当前会话”中右侧用户资料区的“更多信息”标签页下，以及“历史会话”中右侧会话详情区的“更多信息”标签页下。

用户的唯一性标识会被作为请求内容 POST 到该接口。

请求参数：

注意：userid来源于用户发起会话时，调用各端 SDK 的初始化代码时传递给网易七鱼系统的参数中。

**备注：**平台电商中的用户信息对接参数将增加shopid,获取对应商户下的用户信息。

返回参数：

其中data字段用一个数组描述用户的详细信息，数组中每个元素代表一个数据项。数据项以<key, value>对的形式为基础，增加了额外的字段以控制显示样式。

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://qiyukf.com/get_user_info' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appid": "qiyukf",
    "token": "qiyukf_security_token",
    "userid": "zhangsan",
    "staffphone": "057189850000"
}'

响应示例

{
    "rlt": 0,
    "uid": "zhangsan",
    "data": [
        {
            "index": 0,
            "key": "account",
            "label": "账号",
            "value": "zhangsan",
            "href": "url"
        },
        {
            "index": 1,
            "key": "name",
            "label": "姓名",
            "value": "土豪",
            "edit": true,
            "map": "real_name",
            "href": "url"
        },
        {
            "index": 2,
            "key": "phone",
            "label": "手机",
            "value": "13800000000",
            "edit": true,
            "map": "mobile_phone",
            "href": "url"
        },
        {
            "index": 3,
            "key": "email",
            "label": "EMail",
            "value": "13800000000@163.com",
            "edit": true,
            "map": "email",
            "href": "url"
        },
        {
            "index": 4,
            "key": "vip",
            "label": "会员",
            "value": [
                {
                    "id": 0,
                    "name": "类型一"
                },
                {
                    "id": 1,
                    "name": "类型三",
                    "check": true
                },
                {
                    "id": 2,
                    "name": "类型二"
                }
            ],
            "select": true
        }
    ],
    "modify_cb": "url"
}

请求参数

Body 参数application/json

appid

string

必需

企业分配给网易七鱼系统的 appid。

token

string

必需

当前有效的 token。

userid

string

用户的唯一性标识。

必需

staffphone

string

可选

企业和用户联系时使用的中继号码。

示例

返回响应

🟢200成功

application/json

Body

rlt

integer

必需

表明接口调用是否成功。值为0时表示接口调用成功。关于错误码的详细描述，见Appendix I节。

uid

string

可选

get_call_user_info接口返回该字段，用于将同一用户手机号和uid关联，打通呼叫和在线历史咨询记录

data

array [object {8}]

必需

用一个数组表示用户详细信息的数据。

index

integer

可选

用于排序，显示数据时数据项按index值升序排列；不设定index的数据项将排在后面；index相同或未设定的数据项将按照其在 JSON 中出现的顺序排列。

key

string

必需

数据项的名称，用于区别不同的数据。特别地，如果该数据可编辑（见edit字段说明），key将作为请求的内容提交给回调接口。

label

string

必需

该项数据显示的名称。

value

array [object {3}]

必需

该数据显示的值，类型不做限定，根据实际需要进行设定。

href

string

可选

超链接地址。若指定该值，则该项数据将显示为超链接样式，点击后跳转到其值所指定的 URL 地址。

edit

boolean

可选

表示该项数据是否可编辑，true为可编辑，false为不可编辑。可编辑时该项数据的值将显示在一个输入框内，内容被编辑后将调用modify_cb接口提交更新。

map

string

可选

表明该项数据是否与网易七鱼系统中固定的数据项有映射关系。如真实姓名为real_name，手机号为mobile_phone，电子邮箱为email。如果一个数据项指定了正确的map值，则该数据也会同步显示在“当前会话”中右侧用户资料区的“用户资料”标签页下对应的项目中，以及“历史会话”中右侧会话详情区的“用户资料”标签页下对应的项目中。

select

boolean

可选

用于标识该项数据是否为select下拉框。true表示该项数据为select下拉框的形式，且当select选项为true时，value字段应该为一个数组的形式（可以在value中指定初始化check为true的默认选中现，如果没指定则默认选中第一项）。

modify_cb

string

可选

如果企业希望客服可以在网易七鱼系统中更新客户的信息，则在此提供一个接口的地址，用于客户信息修改后回调。接口定义见下。

修改于 2022-01-28 04:24:03

获取 token

呼叫中心获取电话用户信息