tencent cloud

APIs

创建EKYC Webhook配置

下载
聚焦模式
字号
最后更新时间: 2026-09-18 16:13:18

1. 接口描述

接口请求域名: faceid.intl.tencentcloudapi.com 。

创建EKYC Webhook配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateEKYCWebhook。
Version String 公共参数,本接口取值:2018-03-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-hongkong, ap-singapore 。
WebhookName String

Webhook 名称,用于控制台展示

WebhookURL String

回调地址,必须为 HTTPS 协议

3. 输出参数

参数名称 类型 描述
Result String

返回结果

WebhookId Integer

创建的 Webhook 配置 ID

HasSignatureKey Boolean

是否添加秘钥

默认值:false

SignatureKey String

回调秘钥

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例

输入示例

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

{
    "WebhookName": "qq",
    "WebhookURL": "https://www.qq.com/"
}

输出示例

{
    "Response": {
        "Result": "Success",
        "WebhookId": 51,
        "RequestId": "1778ad8c-2cf3-4f14-99ff-c250e32f0611"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AMLDBError AML database operation error.
FailedOperation.AMLInternalError AML service internal error.
FailedOperation.AMLWebhookDuplicate A webhook for this scene already exists.
FailedOperation.EKYCWebhookDuplicate A webhook for this scene already exists.
InvalidParameterValue.AMLFieldValidation Field validation failed
InvalidParameterValue.EKYCFieldValidation Field validation failed.
InvalidParameterValue.MissingScene Scene is required.
InvalidParameterValue.MissingWebhookName WebhookName is required.
InvalidParameterValue.WebhookURL Webhook URL must be a valid HTTPS URL.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈