api接口

2020-01-01 16:36:03

客服系统接口文档

  • 客服系统接口文档

    • 商户分组信息

    • 用户与客服系统建立连接

    • 自定义推送url

商户分组信息

  • 请求URL

客服系统域名/api/group/[business_id]

  • 请求方式

GET

  • 请求参数

请求参数参数类型参数说明
business_idInteger,不可为空客服系统ID
  • 返回参数

返回参数参数类型参数说明
codeInteger执行结果code
messageString执行结果
errorCodeInteger错误码
  • 返回示例

{
    code: 0,
    msg: [
    {
        id: 11,
        groupname: "test1"
    },
    {
        id: 12,
        groupname: "多商户分组1"
        }
    ]
}

用户与客服系统建立连接

  • 请求URL

客服系统域名/index/index/home?visiter_id=&visiter_name=&avatar=&business_id=&groupid=&product=

  • 请求方式

GET

  • 请求参数

请求参数参数类型参数说明
visiter_idString,可为空用户ID
visiter_nameString,可为空用户昵称
avatarString,可为空用户头像
business_idInteger,不可为空客服系统ID
groupidInteger,可为空分组ID 从 商户分组信息 获取
productJSON 可为空{"pid":1,"title":" Apple MacBook Air ","img":"图片链接地址","info":"13.3英寸笔记本电脑 银色(2017款Core i5 处理器/8GB内存/128GB闪存 MQD32CH/A)","price":"¥7588.00","url":"网址"}

自定义推送url

  • 推送URL用户自定义


  • 推送参数

请求参数参数说明
visiter_id用户ID
content发送聊天内容
business_id客服系统ID
service_id客服ID
direction发送方向 to_visiter 或 to_service
timestamp时间戳
group客服分组
state访客状态 online 或 offline
service_name客服昵称
service_url客服链接
  • 返回参数

对接方自定义