1.获取平台商户分类列表

通过此接口开发者可获取当前多商户平台下所设置的商户分类列表,设置商户分类是为了平台客服方便的去管理商户的账号。如没有对商户进行分类所有商户在平台账号中会显示为未分类。

接口地址

http请求方式: GET:
https://${apiServer}/subplatform/subAccountCategoryList/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为10秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求5000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

返回说明

返回数据格式:json

对象 字段 类型 是否为空 说明
categoryList Object[] 分类列表
categoryId int 分类ID,在创建商户设置商户分类时需要
categoryName String 商户分类名称

返回示例

{
    "categoryList":[
        {
            "categoryId":1,
            "categoryName":"超级卖家"
        },
        {
            "categoryId":2,
            "categoryName":"金牌卖家"
        }
    ]
}

2.获取平台商户版本列表

通过此接口开发者可获取当前多商户平台下所设置的商户版本列表,在创建商户时可指定商户使用一洽客服系统的版本,有效地控制和管理商户的客服工作。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/subAccountVersionList/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为10秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求5000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

返回说明

返回数据格式:json

对象 字段 类型 可为空 说明
versionList   Object[] 分类列表
  versionId int 版本ID,在创建商户设置商户版本时需要
  versionName String 版本名称

返回示例

{
    "versionList":[
        {
            "versionId":1,
            "versionName":"专业版"
        },
        {
            "versionId":2,
            "versionName":"标准版"
        }
    ]
}

3.创建商户账号

通过此接口开发者可在多商户平台下,创建商户客服账号。

接口地址

 http请求方式: POST
 https://${apiServer}/subplatform/createSubAccount/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 长度限制 说明
loginName String 50 新建账号的管理员登陆账号。(手机号或者邮箱地址)
staffName String 50 新建账号的管理员姓名
loginPass String 20 新建账号的登陆密码。6-20位,如果不填一洽会自动生成账号密码
contactName String 50 账号联系人姓名,如果不填则使用staffName
contactPhone String 20 账号联系人电话,如果不填则使用loginName
contactJobTitle String 50 账号联系人职位
accountName String 50 新建账号的名称。例如:lenovo官方店
accountUrl String 255 新建账号的商铺网址或者官方网址,PC站网址
accountMobileUrl String 255 新建账号的商铺网址或者官方网址,手机站网址
accountIntro String 255 新建账号的商铺简介
accountAddress String 255 新建账号的商铺地址
categoryId int   新建账号所属分类,如果不传则定义为未分类
versionId int   新建账号的客服系统版本,如果不传则使用一洽定义的商户最高版本
seatCount int   新建账号所需添加的坐席的数量,坐席数量为当前账号可以登录的最大同时接待访客咨询的客服数量,<=0则不执行添加坐席操作
seatStartDate String   坐席账号的开始日期 yyyy-MM-dd 不填则为当前时间
seatExpireDate String   坐席账号的结束日期 yyyy-MM-dd 必须大于startDate

示例:

{
    "accountName":"一洽官方商城",
    "accountUrl":"https://www.echatsoft.com",
    "categoryId":2,
    "contactName":"李先生",
    "contactPhone":"13888888888",
    "loginName":"13666666666",
    "loginPass":"echatsoft007",
    "staffName":"一洽客服@Eric",
    "versionId":3
}

返回说明

返回数据格式:json

字段 类型 可为空 说明
accountId int 新创建账号的一洽客服系统账号ID,使用此ID根据一洽提供的SDK来打开当前账号的服务窗口
loginName String 新建账号的管理员登陆名
loginPass String 新建账号的管理员登陆密码

返回示例

 {
    "accountId":888,
    "loginName":"13666666666",
    "loginPass":"echatsoft"
}

4.添加坐席

通过此接口开发者可给商户添加坐席账号,在登录一洽客服系统时,当前账号内可用的客服席位数量必须有空余才可正常登录客服系统。

接口地址

http请求方式: GET
 https://${apiServer}/subplatform/addSeat/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

返回说明

参数 类型 是否必须 说明
accountId int 要添加坐席的账号ID
seatCount int 新建账号所需添加的坐席的数量,坐席数量为当前账号可以登录的最大同时接待访客咨询的客服数量,<=0则不执行添加坐席操作
seatStartDate String 坐席账号的开始日期 yyyy-MM-dd 不填则为当前时间
seatExpireDate String 坐席账号的结束日期 yyyy-MM-dd 必须大于startDate

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

5.查询坐席

通过此接口开发者可获取指定商户的在线客服系统账户下可用的坐席账号列表。

接口地址

http请求方式: GET
 https://${apiServer}/subplatform/getSubAccountSeatList/${appId}?accessToken=${accessToken}&accountId=${accountId}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求5000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证
accountId 商户账号ID

返回说明

返回数据格式:json

对象 字段 类型 可为空 说明
seatList   Object[] 所有生效的坐席配置列表
  seatId int 坐席配置ID,可通过此ID进行置顶坐席账号的更新
  seatCount int 坐席数量
  seatStartDate String 坐席账号的开始日期 yyyy-MM-dd 不填则为当前时间
  seatExpireDate String 坐席账号的结束日期 yyyy-MM-dd

返回示例

{
    "seatList":[
        {
            "seatCount":3,
            "seatExpireDate":"2019-10-01",
            "seatId":50,
            "seatStartDate":"2018-10-01"
        },
        {
            "seatCount":3,
            "seatExpireDate":"2019-07-01",
            "seatId":66,
            "seatStartDate":"2018-06-01"
        }
    ]
}

6.更新坐席

通过此接口开发者可更新商户的坐席信息,在登录一洽客服系统时,当前账号内可用的客服席位数量必须有空余才可正常登录客服系统。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/updateSubAccountSeat/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 说明
accountId int 要修改坐席的商户账号ID
seatId int 要修改坐席的坐席ID
seatCount int 更新当前坐席配置的坐席数量,如果更新为0,则删除当前坐席配置
seatStartDate String 更新当前坐席配置的开始日期 yyyy-MM-dd 不填则为当前时间
seatExpireDate String 更新当前坐席配置的结束日期 yyyy-MM-dd 必须大于startDate

返回说明

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

7.商户客服系统状态管理

通过此接口开发者可更新商户的在线客服系统使用状态,通过修改状态来禁止和允许商户使用客服系统。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/updateSubAccountStatus/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 说明
accountIds String 要修改状态的商户账号ID列表,多个账号用英文逗号分隔,最多100个
status int 要更新的当前商户在线客服系统的状态。 1:启用 2:禁用

返回说明

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

8.更新商户类型

通过此接口开发者可更新商户的类型。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/updateSubAccountCategory/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 说明
accountIds String 要修改类型的商户账号ID列表,多个账号用英文逗号分隔,最多100个
categoryId int 要更新的当前商户在线客服系统的分类ID

返回说明

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

9.更新商户版本

通过此接口开发者可更新商户的在线客服系统的权限版本。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/updateSubAccountVersion/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说 明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 说明
accountIds String 要修改客服权限版本的商户账号ID列表,多个账号用英文逗号分隔,最多100个
versionId int 要更新的当前商户在线客服系统版本ID

返回说明

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

10.更新商户信息

通过此接口开发者可更新商户的基础信息。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/updateSubAccountInfo/${appId}?accessToken=${accessToken}

访问限制

最大访问频率为1秒钟,如果频繁超过允许频率访问可能会被系统禁止访问。每个账号24小时内限制请求50000次

参数说明

参数 是否必须 说明
accessToken 接口调用凭证

post数据格式:Json

参数 类型 是否必须 长度限制 说明
accountId int   要修改基础信息的商户账号I表
contactName String 50 账号联系人姓名,如果不填则使用staffName
contactPhone String 20 账号联系人电话,如果不填则使用loginName
contactJobTitle String 50 账号联系人职位
accountName String 50 账号的名称。例如:lenovo官方店
accountUrl String 255 账号的商铺网址或者官方网址,PC站网址
accountMobileUrl String 255 账号的商铺网址或者官方网址,手机站网址
accountIntro String 255 账号的商铺简介
accountAddress String 255 账号的商铺地址

返回说明

返回正常示例

{
"errcode":0,
"errmsg":"ok" 
}

11.获取商户服务状态

通过此接口开发者可获取当前多商户平台下指定商户的客服服务状态,通过商户的在线、离线状态来个性化显示商户的客服服务状态。

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/subAccountStatus/${appId}?accessToken=${accessToken}&accountId=${accountId}

参数说明

参数 是否必须 说明
accessToken 接口调用凭证
accountId 商户账号ID

返回说明

返回数据格式:json

字段 类型 说明
status int 当前商户账号的客服状态 1:在线 2:离线

返回示例

{
  "status":1
}

12.获取访客未读消息数量

通过此接口开发者可获取访客在平台所有的未读消息数量总和以及单个商户的未读消息数量,用于在客户进入APP以及客户进入指定的商户或者平台客服埋点页面时提示访客是否有新消息

接口地址

 http请求方式: GET
 https://${apiServer}/subplatform/visitorUnReadMsgCount/${appId}?accessToken=${accessToken}&visitorId=#{visitorId}

参数说明

参数 类型 是否必须 说明
accessToken String 接口调用凭证
visitorId String 访客ID,如果接入了会员那么visitorId=vip+${uid}如:web455459662 ;webvip455459662
accountId String 指定账号的ID(商户的一洽账号ID或者平台的一洽账号ID),不指定则获取所有商户以及平台方的未读消息数量总和

返回说明

返回数据格式:json

字段 类型 说明
unreadMsgCount int 未读消息数量

返回示例

{
  "unreadMsgCount":3
}