# 电商平台

# 1、电商平台企业列表查询

1. 接口说明:

通过接口调用形式查询电商平台企业列表

1. 接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/open/getTenantList

b) 请求方式

接口通过Http + post 的形式,通过Http作为协议,post作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 string 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
token 必选 string token = MD5(unionCode+ts+email+unionKey) unionKey:加密私钥由智齿提供
email 必选 string 平台超管邮箱唯一
startDate 非必选 string 2018-09-04
endDate 非必选 string 2018-09-04
inputStatus 非必选 string 搜索类型:1-商户企业名称,2- 商户联系账号,3-商户超管电话,4-外部id(1,2,3为模糊匹配,4为完全匹配)
inputValue 非必选 String 对应inputStatus的搜索值
openStatus 必选 string 商户状态:-1:全部,1:开启 0:停用
pageNo 非必选 Integer 开始页
pageSize 非必选 Integer 每页展示几条

d) 响应参数

返回示例:

{
    "pageNo": 1,
    "pageCount": 1,
    "totalCount": 3,
    "pageSize": null,
    "items": [
        {
            "companyId": "3b9577c3ddaa49bda857a0ab8593b7ba",
            "companyName": "青樱格格02",
            "email": "02@120.com",
            "contactTel": "13100000000",
            "contactName": "",
            "serviceNum": 0,
            "maxServiceCount": 0,
            "createTime": "2018-08-29",
            "endTime": "2099-12-31",
            "tenantStatus": true,
            "appKey": "8748cd7faeb1401ab3d97cf45013afc4",
            "services": null,
            "customerCode": null,
            "customfieldsCode": null,
            "customfieldsName": null,
            "provinceId": null,
            "provinceName": null,
            "cityId": null,
            "cityName": null,
            "areaId": null,
            "areaName": null
        },
        {
            "companyId": "42fb9905aa7f4eff9639d732c9c3aa85",
            "companyName": "还珠格格03",
            "email": "03@120.com",
            "contactTel": "13100000000",
            "contactName": "",
            "serviceNum": 0,
            "maxServiceCount": 0,
            "createTime": "2018-08-29",
            "endTime": "2099-12-31",
            "tenantStatus": false,
            "appKey": "1deb109104334977ae654d3a9096d942",
            "services": null,
            "customerCode": null,
            "customfieldsCode": null,
            "customfieldsName": null,
            "provinceId": null,
            "provinceName": null,
            "cityId": null,
            "cityName": null,
            "areaId": null,
            "areaName": null
        },
        {
            "companyId": "bc0af7e208164b6a8aa83f7722cb22ed",
            "companyName": "青樱格格01",
            "email": "01@120.com",
            "contactTel": "13100000000",
            "contactName": "",
            "serviceNum": 0,
            "maxServiceCount": 0,
            "createTime": "2018-08-29",
            "endTime": "2099-12-31",
            "tenantStatus": true,
            "appKey": "1d7fe2633d944e459646f4eb0973d0ba",
            "services": null,
            "customerCode": null,
            "customfieldsCode": null,
            "customfieldsName": null,
            "provinceId": null,
            "provinceName": null,
            "cityId": null,
            "cityName": null,
            "areaId": null,
            "areaName": null
        }

    ],

    "item": null,
    "retCode": "200000",
    "retMsg": "成功"

}

# 2、添加企业

1.接口说明:

通过接口调用形式添加电商平台商户。

2.接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/open/addTenant.json

b) 请求方式

接口通过Https + post 的形式,通过Https作为协议,post作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 String 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
companyName 必选 String 公司名称
email 必选 String 客服邮箱,需要保证唯一
maxCount 必选 Integer 指定最大客服数量
password 必选 String 客服登录密码
contactName 非必选 String 联系人
contactTel 非必选 String 联系电话
token 必选 String token = MD5(unionCode+ts+email+unionKey)unionKey:加密私钥由智齿提供
customerCode 必选 String 商户在平台里面的唯一id
icon 非必选 String 商户图标

d) 响应参数

返回示例:

{

    "retCode": "200000",
    "retMsg": "成功!",
    "msg":{
        "appKey": "XXXX",
        "contactName": "联系人",
        "sysNum" : "xxxx"
    }
}
{"retCode":"999999","retMsg":"customerCode已存在!","msg":null}
{"retCode":"200007","retMsg":"在线客服数量不足","msg":null}

# 3、电商平台修改企业

1.接口说明:

通过接口调用形式修改电商平台商户。

2.接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/open/updateTenant.json

b) 请求方式

接口通过Https + post 的形式,通过Https作为协议,post作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 String 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
companyName 必选 String 公司名称
maxCount 必选 Integer 指定最大客服数量
contactName 非必选 String 联系人
contactTel 非必选 String 联系电话
token 必选 String token = MD5(unionCode+ts+email+unionKey) unionKey:加密私钥由智齿提供
customerCode 必选 String 商户在平台里面的唯一id
email 必选 String 商户的超管邮箱

d) 响应参数

返回示例:

{"retCode":"200000","retMsg":"成功","msg":null}
{"retCode":"999999","retMsg":"商户不存在!","msg":null}
{"retCode":"200007","retMsg":"在线客服数量不足","msg":null}

# 4、修改客服

1.接口说明:

通过接口调用形式修改客户。

2.接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/open/updateServiceInfoConfim.json

b) 请求方式

接口通过Https + post 的形式,通过Https作为协议,post作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 String 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
token 必选 String token = MD5(unionCode+ts+email+unionKey)unionKey:加密私钥由智齿提供
customerCode 必选 String 商户在平台里面的唯一id
serviceNick 必选 String 客服昵称
serviceName 必选 String 客服真实姓名
phoneNo 必选 Integer 手机号码
maxAcceptNum 必选 Integer 坐席接待上限
email 必选 String 客服邮箱,唯一

d) 响应参数

返回示例:

{"retCode":"200000","retMsg":"成功","msg":null}
{"retCode":"999999","retMsg":"商户不存在!","msg":null}
{"retCode":"999999","retMsg":"客户邮箱未激活,请激活后再次尝试修改客户信息!","msg":null}

# 5、添加客服

1.接口说明:

通过接口调用形式添加客户。

2.接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/open/addServiceInfoConfim.json

b) 请求方式

接口通过Https + post 的形式,通过Https作为协议,post作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 String 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
token 必选 String token = MD5(unionCode+ts+email+unionKey)unionKey:加密私钥由智齿提供
customerCode 必选 String 商户在平台里面的唯一id
nick 必选 String 客服昵称
name 必选 String 客服真实姓名
email 必选 String 客服邮箱,唯一
roleId 必选 String 客户角色ID(5555:工单客服、2222:在线管理员、1111:在线客服、8888:工单管理员)
password 非必选 String 客服密码

d) 响应参数

返回示例:

{"retCode":"200000","retMsg":"成功","msg":null}
{"retCode":"999999","retMsg":"商户不存在!","msg":null}
{"retCode":"999998","retMsg":"请求失败!登录已失效,请重新登录!","msg":null}

# 6、客服会话统计查询接口

接口说明:

接口作用:获取平台下的所有商户的所有客服会话统计。

请求方式:

POST

请求参数:

参数 类型 必填 名称 备注
unionCode String 平台id
ts String 时间戳 时间戳,秒,例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 签名 md5(unionCode+unionKey+ts) sign签名, unionKey为秘钥
type String 类型 7 会话统计 8 响应时间统计
date String 日期 日期(yyyy-MM-dd)

返回参数:

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

item对象:

参数 类型 名称 备注
unionCode String 平台ID
createTime String 创建时间
taskType String 任务类型
resultDate String 日期
file_path String 文件路径
description String 描述

请求示例:

{
 	"unionCode":"10004",
    "ts":"1569397773",
    "sign":"dldnscb2e9c740dba4b75a34d5358802",
    "type":"7",
    "date":"2020-01-05"
}

返回示例:


{
    "item": {
        "filePath":"https://sobot-test.oss-cn-beijing.aliyuncs.com/expo105-1.zip",
        "unionCode":"10004",
        "createTime": "1573027669037",
        "resultDate": "2020-01-05",
        "taskType": "7"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

# 7、客服响应时间统计查询接口

接口说明:

接口作用:获取平台下的所有商户的所有客服响应时间。

请求方式:

POST

请求参数:

参数 类型 必填 名称 备注
unionCode String 平台id
ts String 时间戳 时间戳,秒,例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 签名 md5(unionCode+unionKey+ts) sign签名, unionKey为秘钥
type String 类型 7 会话统计 8 响应时间统计
date String 日期 日期(yyyy-MM-dd)

返回参数:

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

item对象:

参数 类型 名称 备注
unionCode String 平台ID
createTime String 创建时间
taskType String 任务类型
resultDate String 日期
filePath String 文件路径
description String 描述

请求示例:

 {
 	"unionCode":"10004",
    "ts":"1569397773",
    "sign":"dldnscb2e9c740dba4b75a34d5358802",
    "type":"7",
    "date":"2020-01-05"
}

返回示例:


{
    "item": {
        "filePath":"https://sobot-test.oss-cn-beijing.aliyuncs.com/expo105-1.zip",
        "unionCode":"10004",
        "reateTime": "1573027669037",
        "resultDate": "2020-01-05",
        "taskType": "8"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

# 8、批量获取子商户appKey信息查询

接口说明:

接口作用:获取平台下子商户的appKey和appId。

请求方式:

POST

请求地址:

https://www.sobot.com/tenantpro/getBatchAppKey

请求参数:

参数 类型 必填 名称 备注
unionCode String 平台id
ts String 时间戳 时间戳,秒,例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 签名 md5(unionCode+unionKey+ts) sign签名, unionKey为秘钥

返回参数:

参数 类型 必填 名称 备注
ret_code String 返回编码
ret_msg String 返回信息
data Object 返回对象
time String 请求时间

data 对象:

参数 类型 名称 备注
appId String appId
appKey String appKey
companyId String 公司ID
companyName String 公司名称

请求示例:

{
 	"unionCode":"10004",
    "ts":"1569397773",
    "sign":"dldnscb2e9c740dba4b75a34d5358802"
}

返回示例:

{
    "10004": {
        "data": [
            {
                "appId": "3cb9c7b8dd914621ae3db8bef000d0",
                "appKey": "d14N6QO9e3p6",
                "companyId": "be7f05de11a54390c3f3ec35e6010b",
                "companyName": "测试二号"
            },
            {
                "appId": "b17989cdf9b2428db63b90672b756015",
                "appKey": "wJH5gW65e98x",
                "companyId": "32d5fedaf268441dbde6d3eb23a17cee",
                "companyName": "测试三号"
            },
            {
                "appId": "f6bbd4bce5924fde807dbd7ccc17af53",
                "appKey": "u11zt3o3Q09s",
                "companyId": "6f77727bdb074a128fc43d8788ee5a09",
                "companyName": "测试一号"
            },
            {
                "appId": "f7a989d7cc9a4d3eb1429aca75cd99a7",
                "appKey": "08q99Y41kDo7",
                "companyId": "b9fb3a4594634cefa470dbd3f9a21815",
                "companyName": "主商户"
            }
        ],
        "time": "2020-04-01 10:39:21"
    },
    "retCode": "000000",
    "retMsg": "操作成功"
} 

# 9、客服状态明细接口

1.接口说明:

通过接口获取客服明细状态列表。

2.接口信息:

a) 请求URL

https://www.sobot.com/tenantpro/coutomer/getStaffLogInfos

b) 请求方式

接口通过Https + get的形式,通过Https作为协议,get作为传输方式

c) 请求参数

字段名 是否必选 数据类型 说明
unionCode 必选 String 第三方平台唯一编码,智齿提供
ts 必选 long 当前时间戳,用于token的验证,单位为毫秒
token 必选 String token = MD5(unionCode+ts+unionKey)unionKey:加密私钥由智齿提供
startTime 非必选 long 开始时间,精确到ms 查询最多查询一周的数据。前台传参分为4种情况: 1)startTime,endTime都不为空时, 如果时间范围超过1周, 以结束时间为准, 向前推一周重置开始时间; 2)startTime,endTime都为空时, 结束时间为当前时间,开始时间为当前时间向前推一周; 3)startTime不为空了, endTime为空时,结束时间为开始时间向后推一周; 4)startTime为空, endTime不为空时, startTime为endTime向前推一周。
endTime 非必选 long 结束时间,精确到ms

d) 响应参数

返回示例:

{
    "items":[
        {
            "companyId":"9e73cc58f2f7472d993e6772c250ed99",
            "companyStaffInfos":[
                {
                    "staffId":"53df8dee9a9e4fdda236faf6351e7a8d",
                    "staffLogInfos":[
                        {
                            "datetime":1571037571921,
                            "datetimeFormat":"2019-10-14 15:19:31",
                            "source":0,
                            "operationAction":"在线"
                        }
                    ]
                }
            ]
        }
    ],
    "retCode":"200000",
    "retMsg":"成功"
}

3.响应信息备注:

items:

字段名 数据类型 说明
companyId String 商户id
companyStaffInfos List 商户的客服信息集合

companyStaffInfos:

字段名 数据类型 说明
staffId String 客服id
staffLogInfos List 此客服日志信息集合

staffLogInfos:

字段名 数据类型 说明
datetime Long 操作时间(时间戳)
datetimeFormat String 操作时间(格式化后)
source int 渠道 0-pc,2-app
operationAction String 客服状态