实现SPI接口

SPI 接口实现说明
SPI 接口实现生命周期
接口状态 | 可执行操作 |
---|---|
未接入接口 | 接入 |
开发中 | 详情,提交审核,修改 |
审核中 | 详情,撤销审核 |
待发布 | 详情,发布 |
已驳回 | 详情,提交审核,修改 |
已上线 | 详情,升级 |
租户管理
租户角色列表查询接口
Query 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | qHT_sTlI | CCM租户id |
tenant_instance_id | String | 必选 | 16 | qHT_sTlI | CCM部门id,如果租户没有使用多部门模式,则部门id与租户id相同 |
接口业务出参
名称 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|
+ roles | 必选 | 可供租户使用的外部系统定义的角色列表 | ||
L role_id | 必选 | 20 | 123 | isv定义的角色的唯一标识 |
L role_name | 必选 | 32 | 管理员 | isv定义的角色名称 |
响应示例
{
"response": {
"code": "10000",
"msg": "Success",
"roles": [
{
"role_id": "123",
"role_name": "管理员"
}
]
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
租户热线技能组列表查询接口
Query 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | qHT_sTlI | CCM租户id |
tenant_instance_id | String | 必选 | 16 | qHT_sTlI | CCM部门id,如果租户未使用多部门模式,则部门id与租户id相同 |
接口业务出参
名称 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|
+ hotline_groups | 必选 | - | - | isv定义的技能组列表 |
L group_id | 必选 | 20 | 123 | isv定义的热线技能组id |
L group_name | 必选 | 32 | 测试技能组 | isv定义的热线技能组名称 |
响应示例
{
"response":{
"code":"10000",
"msg":"Success",
"hotline_groups":[{
"group_id":"123",
"group_name":"测试技能组" }]
}
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}
客服管理
客服角色设置接口
Body 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | qHT_sTlI | ccm租户id |
tenant_instance_id | String | 必选 | 16 | qHT_sTlI | CCM部门id,如果租户未使用多部门模式,则部门id与租户id相同 |
agent_id | String | 必选 | 32 | 2019090501910134 | 客服id |
role_ids | String | 必选 | 20 | 111,222 | 客服拥有的角色id列表 |
响应示例
{
"response":{
"code":"10000",
"msg":"Success" }
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}
客服已授权角色列表查询接口
Query 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | Liw_Lm46 | CCM租户id |
tenant_instance_id | String | 必选 | 16 | Liw_Lm46 | CCM部门id,如果租户未使用多部门模式,部门id与租户id相同 |
agent_ids | String | 必选 | 32 | 2019090501910134,2020060301949651 | 客服id列表 |
接入业务出参
名称 | 具体类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
+auths | - | 必选 | - | - | 客服授权列表 |
L agent_id | String | 必选 | 32 | 2019090501910134 | 客服id |
L+ roles | - | 必选 | - | - | 客服已授权的角色列表 |
LL role_id | String | 必选 | 20 | 123 | isv定义的角色的唯一标识 |
LL role_name | String | 必选 | 32 | 管理员 | isv定义的角色名称 |
响应示例
{
"response":{
"code":"10000",
"msg":"Success",
"auths":[{
"agent_id":"2019090501910134",
"roles":[{
"role_id":"123",
"role_name":"管理员" }]
}]
}
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}
客服热线技能组列表查询接口
Query 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | Liw_Lm46 | ccm租户id |
tenant_instance_id | String | 必选 | 16 | Liw_Lm46 | CCM部门id,如果租户未使用多部门模式,则部门id与租户id相同 |
agent_ids | String | 必选 | 32 | 2019090501910134,2020060301949651 | 客服id列表 |
接口业务出参
名称 | 具体类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
+ agent_hotline_groups | - | 必选 | - | - | 客服热线技能组列表 |
L agent_id | String | 必选 | 32 | 2020060301949651 | 客服id |
L+ skill_groups | - | 必选 | - | - | 技能组列表 |
LL group_id | String | 必选 | 20 | 123 | isv定义的热线技能组id |
LL group_name | String | 必选 | 32 | 测试技能组 | isv定义的热线技能组名称 |
响应示例
{
"response":{
"code":"10000",
"msg":"Success",
"agent_hotline_groups":[{
"agent_id":"2020060301949651",
"skill_groups":[{
"group_id":"123",
"group_name":"测试技能组" }]
}]
}
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}
客服热线技能组设置接口
Body 业务参数
名称 | 参数类型 | 是否必填 | 最大长度 | 示例值 | 描述 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | qHT_sTlI | CCM租户id |
tenant_instance_id | String | 必选 | 16 | qHT_sTlI | CCM部门id,如果租户未使用多部门模式,则部门id与租户id相同 |
agent_id | String | 必选 | 32 | 2019090501910134 | 客服id |
skill_group_ids | String | 必选 | 32 | 111,222 | 热线技能组id列表 |
响应示例
{
"response":{
"code":"10000",
"msg":"Success" }
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}
能力发布

第一步:请求及响应配置
1.
1.

2.

第二步:在线测试及审核
在线测试

接口审核
