获取访客信息 - 尘锋SCRM开放平台

POST {host}/open-kf/spi/v1/contacts/get

Content-Type: application/json

本接口需要对接放按照要求提供

请求参数

请求参数名	类型	说明	是否必须
chat_id	`string`	会话ID	false
sender_id	`string`	消息发送者ID	true

请求参数示例
json - Request-Example:

 {
    "chat_id": "chat_xxxx", 
    "sender_id": "wmAJ2GCAAAme1XQRC-NI-q0_ZM9ukoAw"
}

成功响应

响应参数名	类型	说明
code	`int32`	响应码
msg	`string`	消息提示
data	`object`	数据信息
data.sender_id	`string`	发送者ID
data.nickname	`string`	昵称
data.gender	`int32`	性别。0 未知，1 男，2 女
data.avatar	`string`	头像
data.sender_type	`int32`	发送者类型。0 客服/员工，1 客户，2 AI附身客服/员工
data.channel	`int32`	接入渠道 0: 其他 1：网页、2：小程序、3：微博、4：百度营销、5：SDK、6：微信客服、7：移动端、8：企微客服渠道、9：飞书渠道

data.ip	`string`	访客IP
data.region	`string`	访问地区
data.key_word	`string`	关键词
data.os	`string`	操作系统
data.browser	`string`	浏览器

成功响应示例

 {
    "code": 0,
    "msg": "success"
    "data": {
        "sender_id": "xxxx",
        "nickname": "昵称",
        "avatar": "https://xxx.png",
        "gender": 1,
        "sender_type": 0, 
        "channel": 1,
        "ip": "127.0.0.1", 
        "region": "北京",
        "key_word": "你好",
        "os": "ios"
    }
}

错误响应示例

 {
    "code": 4126,
    "msg": "",
}