- 支付
- 私域
- 公域
- 营销
- 资金
- 会员
- 信用
- 安全
- 其他
客服已授权角色列表查询接口
公共参数#
请求地址#
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
公共请求参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
method | String | 是 | 128 | 接口名称 | alipay.trade.order.settle |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
version | String | 是 | 3 | 版本号,默认1.0 | 1.0 |
biz_app_id | String | 否 | 32 | 商户app_id | 2014072300007148 |
invoke_app_id | String | 否 | 32 | 调用方app_id | 2014072300007148 |
utc_timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
请求参数#
Header#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
Query#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
tenant_id | String | 必选 | 16 | CCM租户id | Liw_Lm46 |
tenant_instance_id | String | 必选 | 16 | CCM部门id,如果租户未使用多部门模式,部门id与租户id相同 | Liw_Lm46 |
agent_ids | String[] | 必选 | 32 | 客服id列表 | 2019090501910134,2020060301949651 |
公共响应参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数#
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
auths | AgentAuth | 必填 | 客服授权列表 |
响应示例#
{
"response": {
"code": "10000",
"msg": "Success",
"auths": [
{
"agent_id": "2019090501910134",
"roles": [
{
"role_id": "123",
"role_name": "管理员"
}
]
}
]
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例#
{
"response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
修改于 2023-11-27 06:09:02