开发指南

# 套电机器人

# 1、接口声明

在调用接口时必须在https请求的header中携带"token"参数。

token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token，开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时，需定时刷新，或根据接口返回的token失效提示，进行重新获取。请求token接口，无论token是否存在，都会返回新的token，并重置token的过期时间(目前24小时)。

token使用方式说明：
1、开发者需要统一获取和管理token，在调用智齿客服各个业务开放接 口时都应该使用同一个的token，不应该每个业务都刷新获取新的 token，否则容易导致token失效，影响接口的正常调用；
2、目前token的有效期通过返回的expire_in来传达，目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示，进行重新获取token。

# 2、接口调用

# 2.1、获取访问token编码

接口说明：

获取API开放接口token，此token仅适用于智齿开放平台 5.0版本全部API接口 。API接口中的参数 appid, app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

https://www.sobot.com/api/get_token

请求参数：

参数 类型 必填 名称 备注
appid String 是 接口凭证Id 第三方用户接口调用唯一凭证id
create_time String 是 时间戳 时间戳,秒，例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 是 签名 md5(appid+create_time+app_key) sign签名,app_key为密钥

返回参数：

参数 类型 必填 名称
ret_code String 是 返回编码
ret_msg String 是 返回信息
item Object 否 返回对象

item对象：

参数 类型 必填 名称 备注
token String 是 token编码
expires_in String 是 凭证有效时间 单位：秒

时间戳转换参考工具：

http://tool.chinaz.com/Tools/unixtime.aspx

sign签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

# 2.2、查询访问记录

接口说明：

  • 接口类型：主动调用接口
  • 接口作用：可通过调用该接口来获取访问记录数据
  • 请求方式：POST
  • 请求地址：https://www.sobot.com/api/wb/5/data/get_visit_track_result_info_list

请求参数：

参数 类型 必填 名称 备注
visitorid String 否 访客id 与其他参数互斥出现，保证传参只有一个参数
userid String 否 客户id 与其他参数互斥出现，保证传参只有一个参数
cid String 否 会话id 与其他参数互斥出现，保证传参只有一个参数
visit_track_record_id String 否 访问id 与其他参数互斥出现，保证传参只有一个参数

返回参数：

参数 类型 必填 名称 备注
ret_code String 是 返回编码
ret_msg String 是 返回信息
items Object 否 返回对象

items对象：

参数 类型 名称 备注
visit_start_time Long 访问时间
search_engine String 访问来源 1.百度自然搜索 2.百度付费搜索 3.360搜索 4.Sougou搜索 5.神马 6.必应 7.google搜索 8.其他搜索引擎 9.直接访问 10.外部链接 11.百度其他来源
companyid String 公司id
source String 网站类型 0.桌面网站 4.移动网站 12.百度
sem_word String 关键词
search_word String 搜索词
visit_track_record_id String 访问ID
cids String 会话ID 多个会话id以,分隔
visitorid String 访客ID
region String 投放区域
transformation_stage String 转化阶段 0. "" 1.未发起会话 2.发起会话未咨询 3.咨询未留资 4.老客户留资 5新客户留资
wx String 微信号
tel String 手机号
userid String 客户ID
land_page_url String 着陆页
ip String IP
ip_home String IP归属地
country String 国家
province String 省
city String 市

请求示例：

curl https://www.sobot.com/api/wb/5/data/get_visit_track_result_info_list
-X POST 
-H 'content-type: application/json' 
-H 'token: uac37cb1e9c740dba4b75a34d54n88a2' 
-d '{   "userid":"ffb4fccb6c3a48a6b185ob5de171b6bb"
    }'

返回示例：

{   
  "items":[ 
    {
      "visit_track_record_id":"8d7752c2-6e2c-4141-a3e8-46c2dd0f4f0a",
      "transformation_stage":"1",
      "land_page_url":"http://www.sobot.com/chat/frame/v2/index.html",
      "source":"0",
      "tel":"13693687878",
      "cids":",66ba27c42e684f0e9f71a13d7a48f3d6",
      "ip_home":"中国北京北京市",
      "wx":"niuchen",
      "search_engine":"9",
      "visit_start_time":1616087592158,
      "ip":"219.142.251.154",
      "sem_word":"公司",
      "userid":"ffb4fccb6c3a48a6b185ob5de171b6bb",
      "companyid":"40402937595b4bc084c31633d89876a3",
      "search_word":"有限公司",
      "region":"佛山",
      "country":"中国",
      "province":"广东省",
      "region":"佛山市",
      "visitorid":"268b904ad7414513b09d55b70b6d3e6e"
    }
  ],  
  "ret_code":"000000",   
  "ret_msg":"成功"
}

← 电商平台 →