电商平台

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

1. 接口说明：

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

1. 接口信息：

a) 请求URL

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

b) 请求方式

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

c) 请求参数

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) 请求参数

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) 请求参数

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/addServiceInfoConfim.json

b) 请求方式

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

c) 请求参数

d) 响应参数

返回示例：

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

5、编辑客服

1.接口说明：

通过接口调用形式编辑客服。

2.接口信息：

a) 请求URL

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

b) 请求方式

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

c) 请求参数

d) 响应参数

返回示例：

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

6、删除客服

1.接口说明：

通过接口形式删除客服。

2.接口信息：

a) 请求URL

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

b) 请求方式

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

c) 请求参数

请求示例：

{
    "unionCode":"10004",
    "ts":"158934009028",
    "token":"dldnscb2e9c740dba4b75a34d5358802",
    "customerCode":"7",
    "email":"1024011851@qq.com"
}

d) 响应参数

返回示例：

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

7、客服会话统计查询接口

接口说明：

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

请求方式：

POST

http://ten.sobot.com/tenantpro/tenantReport/tenantExportData

备注：如需使用接口，需提前联系客户经理进行数据整理安排

请求参数：

返回参数：

item对象：

请求示例：

{
 	"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": "成功"
}

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

接口说明：

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

请求方式：

POST

http://ten.sobot.com/tenantpro/tenantReport/tenantExportData

备注：如需使用接口，需提前联系客户经理进行数据整理安排

请求参数：

返回参数：

item对象：

请求示例：

 {
 	"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": "成功"
}

9、批量获取所有子商户appKey信息查询

接口说明：

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

请求方式：

POST

请求地址：

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

请求参数：

返回参数：

data 对象：

请求示例：

{
 	"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": "测试一号"
            },
        ],
        "time": "2020-04-01 10:39:21"
    },
    "retCode": "000000",
    "retMsg": "操作成功"
} 

10、客服状态明细接口

1.接口说明：

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

2.接口信息：

a) 请求URL

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

b) 请求方式

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

c) 请求参数

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:

companyStaffInfos:

staffLogInfos:

11、商户聊天列表

接口说明

• 接口作用：获取客户的商户列表

请求方法

• 请求方式：POST
• 请求类型：application/json
• 请求地址：http://www.sobot.com/chat-third/tenant/5/user/chatIndexPage

请求参数：

响应格式：

{
    "items": [

	    {

	        "unionCode": "10001",

	        "sysNum": "a285455c3f3742a2abc5af9285e6a5fa",

	        "companyName": "公司01",

	        "companyLogo": "https://sobot.com/con3/img01.png",

	        "visitorId": "442bcaceb7c3ee2a60f671605ed6e275",

	        "partnerId": "test001",

	        "lastCid": "032dc4dd38d24f97aeb6b38346854f71",

	        "lastMsgContent": "ko",

	        "lastMsgTime": 1607338626737,

	        "lastMsgType": 0,

	        "unReadNum": 0

	    },
	    {

	        "unionCode": "10001",

	        "sysNum": "dfa71d55d4ce419b8e4db044dc551961",

	        "companyName": "公司02",

	        "companyLogo": "https://sobot.com/con3/img01.png",

	        "visitorId": "2b24b95ac255f1737349cb6ca49ecd3b",

	        "partnerId": "test001",

	        "lastCid": "742babf91b774b63951261712e3dacb8",

	        "lastMsgContent": "ok",

	        "lastMsgTime": 1605614529832,

	        "lastMsgType": 0,

	        "unReadNum": 0

	    }

	],

	"status": 1

}

响应数据备注：

items备注：

12、客服统计接口

接口说明

• 接口作用：获取指定时间范围内平台所有商户的客服统计指标。

请求方法

• 请求方式：POST
• 请求地址：http://www.sobot.com/tenantpro/tenantReport/tenantStaffJobList

备注：如需使用接口，需提前联系客户经理进行数据整理安排

请求参数：

返回参数：

item对象：

请求示例：

{
    "union_code":"10004",
    "ts":"1569397773",
    "sign":"dldnscb2e9c740dba4b75a34d5358802",
    "start_date":"2021-03-02",
    "end_date":"2021-03-02"
}

返回示例：

{
    "items":[
        {
            "staffid":"0a499e5706fb454688abe23ffeb48e6f",
            "companyid":"f2749ad44367485796b3ca8d4777388c",
            "first_response_time_set":1,
            "transfer_first_response_count":0,
            "session_human_visitor_consult":1,
            "first_response_in60s_rate":"100.00%"
        },
        {
            "staffid":"441d1579b6364ab6b9a33b5f5d956852",
            "companyid":"a5b158a28fbf4a2d99ee1c374416573b",
            "first_response_time_set":0,
            "transfer_first_response_count":0,
            "session_human_visitor_consult":4,
            "first_response_in60s_rate":"0.00%"
        },
        {
            "staffid":"99653e9bf9534fd2bd542328ff2b31e1",
            "companyid":"7f9c02497a9a4423b5d2ada26d666951",
            "first_response_time_set":0,
            "transfer_first_response_count":0,
            "session_human_visitor_consult":1,
            "first_response_in60s_rate":"0.00%"
        }
    ],
    "retCode":"000000",
    "retMsg":"成功"
}