创建机器人会话

POST

/openapi/robot/session/create

简要描述：

初始化机器人会话，用于记录访客当前咨询信息，在这一通会话结束(调用方主动调用关闭会话接口/访客消息触发转人工客服/访客长时间未说话自动超时关闭)前，这个访客与机器人的聊天消息都记录在这一通会话中。

对接入七鱼机器人会话的访客，七鱼也会给访客生成一个身份，用于在七鱼系统中标志该访客。七鱼的用户身份，由接入方传入的uid + productId 两个参数来唯一确定，其中uid表示访客身份，productId表示应用身份。每个七鱼用户在同一时间只会存在一个机器人会话。

创建成功后返回相应会话信息，欢迎语，常见问题数据；

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://qiyukf.com/openapi/robot/session/create?appKey=&time=&checksum=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uid": "string",
    "productId": "string",
    "fromType": "string",
    "robotId": 0,
    "welcomeTemplateId": 0,
    "questionTemplateId": "string",
    "fromPage": "string"
}'

响应示例

{
    "code": 200,
    "message": "哈哈",
    "data": {
        "sessionId": 62927,
        "userId": 43412123,
        "robotId": 34351,
        "robotName": "机器人昵称",
        "robotLogoUrl": "http://ysf.nosdn.qiyukf.com/xxxxx",
        "welcome": {
            "msgType": "text",
            "msgBody": {
                "content": "这是欢迎语"
            }
        },
        "commonQuestions": {
            "questionGuide": "常见问题引导语文案",
            "questionList": [
                {
                    "id": 243244,
                    "question": "常见问题1",
                    "type": 1
                }
            ]
        }
    }
}

请求参数

Query 参数

appKey

string

必需

企业的appKey，1064deea1c3624c9ee26d1de5ce8481f

默认值:

time

string

必需

当前 UTC 时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数,1463217187

默认值:

checksum

string

必需

SHA1(appSecret + md5 + time), 三个参数拼接的字符串，进行SHA1哈希计算，转化成16进制字符(String，小写).示例2f13932c4b7c6888b12360a85261a11b8b543f64

默认值:

Body 参数application/json

uid

string

必需

访客在调用方系统里的标志，用于唯一确定用户身份

productId

string

可选

当前咨询应用唯一标识，可以是 Android 应用的包名，iOS 应用的 bundleid，微信公众号appid等。调用方系统如果有多个应用需要接入七鱼时，对不同应用需保证该字段值的唯一性。未指定时取默认值“qyopen”

fromType

string

可选

当前访客咨询来源渠道。未指定时取默认值“WEB”

robotId

integer

可选

机器人id，存在多个机器人时指定当前接入的机器人，未指定时取设置的默认机器人

welcomeTemplateId

integer

可选

指定七鱼机器人欢迎语模版id，如果指定了模版且模版生效，则取当前模版配置的欢迎语，否则按“fromType”取相应渠道默认模版

questionTemplateId

string

可选

指定七鱼机器人常见问题模版id，如果指定了模版且模版生效，则取当前模版配置的常见问题数据；否则按“fromType-productId-fromPage”来匹配相应模版；

fromPage

string

可选

当前访客咨询来源页面

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

sessionId

integer

必需

当前访客咨询对应的七鱼会话id

userId

integer

必需

当前访客在七鱼系统里的用户id

robotId

integer

必需

当前会话所属机器人id

robotName

string

机器人名字

必需

robotLogoUrl

string

机器人头像图片地址

可选

welcome

object

必需

欢迎语内容，这里的消息类型支持：text/richtext，字段格式详细介绍见通用数据结构说明

commonQuestions

object

可选

机器人会话常见问题模版

修改于 2022-01-25 06:29:56

会话类接口

常见问题