支付宝小程序:扩展功能-实现 SPI 接口

小编:啊南 1292阅读 2020.12.29

完成?接入准备?后开发者可通过?SPI 三方服务接入?功能实现支付宝官方提供的 CCM 插件化接口,并将功能发布上线。SPI 的接入流程如下图所示:

image?


SPI 接口实现说明

商家/ISV 需根据官方 SPI 接口参数规范,根据自身实际业务场景需求实现所需的租户、客服管理接口,支付宝将调用商家/ISV 提供的 SPI 接口向其发送对应数据。

注意

  • SPI 接口网络通信规范参见?通信规范。

  • 本文列举 SPI 接口入参及接口响应参数为业务参数,接口入参及响应参数中还需包含系统固定参数,详情参见?通信规范。

  • SPI 接口实现示例参见?服务端实现 DEMO。

SPI 接口实现生命周期

接口状态

可执行操作

未接入接口 接入

开发中

详情,提交审核,修改

审核中

详情,撤销审核

待发布

详情,发布

已驳回

详情,提交审核,修改

已上线

详情,升级


租户管理

商家/ISV 需根据 SPI 接口规范及自身需求实现如下接口,支付宝将调用接口完成对租户的对应操作。

租户角色列表查询接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.role.query(租户角色列表查询接口),管理员在 CCM 员工编辑页面为员工分配角色时,查询 CCM 和 ISV 角色列表。

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定义的角色名称


响应示例
{r    "response": {r        "code": "10000",r        "msg": "Success",r        "roles": [r            {r                "role_id": "123",r                "role_name": "管理员"            r            }r        ]r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"rr}


租户热线技能组列表查询接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.hotlinegroup.query(租户热线技能组列表查询接口),管理员在 CMM 员工编辑页面为员工分配热线技能组时,查询 ISV 热线技能组列表。

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定义的热线技能组名称

?响应示例
{r    "response": {r        "code": "10000",r        "msg": "Success",r        "hotline_groups": [r            {r                "group_id": "123",r                "group_name": "测试技能组"r            }r        ]r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"r}


客服管理

商家/ISV 需根据 SPI 接口规范及自身需求实现如下接口,支付宝将调用接口完成对客服的对应操作。

客服角色设置接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.auth.submit(客服角色设置接口),在 CCM 员工管理页面为员工分配角色。CCM 服务端调用此 SPI 接口,设置员工的 ISV 角色,每次设置都覆盖原有的角色列表。

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列表


说明:本接口仅需公共响应参数,暂无业务响应参数。


响应示例


{r    "response": {r        "code": "10000",r        "msg": "Success"r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"r}


客服已授权角色列表查询接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.auth.query(客服已授权角色列表查询接口),在 CCM 员工管理页面显示员工的角色列表。CCM 服务端调用此 SPI 接口,查询员工当前拥有的外部系统角色列表。

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定义的角色名称


响应示例
{r    "response": {r        "code": "10000",r        "msg": "Success",r        "auths": [r            {r                "agent_id": "2019090501910134",r                "roles": [r                    {r                        "role_id": "123",r                        "role_name": "管理员"r                    }r                ]r            }r        ]r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"r}


客服热线技能组列表查询接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.agent.hotlinegroup.query(客服热线技能组列表查询接口),在 CCM 员工管理页面显示员工的热线技能组列表。CCM 服务端调用此 SPI 接口,查询员工当前拥有的 ISV 热线技能组列表。

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定义的热线技能组名称


响应示例
{r    "response": {r        "code": "10000",r        "msg": "Success",r        "agent_hotline_groups": [r            {r                "agent_id": "2020060301949651",r                "skill_groups": [r                    {r                        "group_id": "123",r                        "group_name": "测试技能组"r                    }r                ]r            }r        ]r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"r}


客服热线技能组设置接口

开发者需根据如下业务规范实现?spi.alipay.iservice.ccm.agent.hotlinegroup.submit(客服热线技能组设置接口),在 CCM 员工管理页面为员工分配热线技能组。CCM 服务端调用此 SPI 接口,设置员工的 ISV 热线技能组,每次设置都覆盖原有的技能组列表。


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列表


说明:本接口仅需公共响应参数,暂无业务响应参数。

响应示例
{r    "response": {r        "code": "10000",r        "msg": "Success"r    },r    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"r}


能力发布

开发者实现 CCM 插件化能力 SPI 接口且所有官方定义的 SPI 列表中必须实现的接口都是?已上线?状态时,对应功能包可执行上线及下线操作,进行能力的上线申请。


发布流程


image?


第一步:请求及响应配置

1.开发者完成 SPI 接口实现后,需进入?开放平台能力管理?选择 能力管理 点击 发布 API 能力 > 实现官方 API

2.点击接入 CCM插件化 能力应用右侧 去开发 按钮,进入详情页。

image.png

3.在 API 列表 > 官方定义SPI列表 选择已实现接口,点击?接入?填入?后端服务正式地址、后端服务测试地址?并选择?请求编码

image?

第二步:在线测试及审核

不满足以下条件的需要给出错误提示:

  • 对于需要签约的功能包没有完成签约。

  • 功能包绑定的应用必须是上线状态。


在线测试

image?

接口审核

SPI 接口联调通过以后可以发起接口审核。

image?

第三步:能力发布上线

当所有 SPI 接口审核通过后,可进行能力上线发布审核。

image

关联标签: