修改企业回调配置

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

新增/删除企业应用集成中的回调配置。 新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。 请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。 更多回调相关的说明参考文档回调通知能力

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyApplicationCallbackInfo。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
OperateType	是	Integer	操作类型： 1-新增 2-删除 示例值：1
CallbackInfo	是	CallbackInfo	企业应用回调信息
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除应用回调配置

删除应用回调配置，成功只会返回RequestId

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationCallbackInfo
<公共请求参数>

{
    "Operator": {
        "UserId": "y******************g"
    },
    "CallbackInfo": {
        "CallbackUrl": "https://y.qq.com/"
    },
    "OperateType": 2
}

输出示例

{
    "Response": {
        "RequestId": "s1*****9"
    }
}

示例2 新增应用回调配置

新增一条应用回调配置，成功只会返回RequestId

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationCallbackInfo
<公共请求参数>

{
    "Operator": {
        "UserId": "y******************g"
    },
    "CallbackInfo": {
        "CallbackUrl": "https://y.qq.com/",
        "CallbackKey": "A******************B",
        "CallbackToken": "A********C"
    },
    "OperateType": 1
}

输出示例

{
    "Response": {
        "RequestId": "s1*****9"
    }
}

示例3 删除不存在的应用回调配置失败

删除应用回调配置，对应的回调地址不存在，返回失败

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApplicationCallbackInfo
<公共请求参数>

{
    "Operator": {
        "UserId": "y******************g"
    },
    "CallbackInfo": {
        "CallbackUrl": "https://yy.qq.com/"
    },
    "OperateType": 2
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "当前配置不存在"
        },
        "RequestId": "s169*****2"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue	参数取值错误。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。