有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: bri.tencentcloudapi.com 。

输入业务名 (bri_num, bri_dev, bri_ip, bri_apk, bri_url, bri_social 六种之一) 及其 相应字段, 获取业务风险分数和标签。

当业务名为bri_num时,必须填PhoneNumber字段.

当业务名为bri_dev时, 必须填Imei字段.

当业务名为bri_ip时,必须填IP字段.

当业务名为bri_apk时,必须填 (PackageName,CertMd5,FileSize) 三个字段 或者 FileMd5一个字段.

当业务名为bri_url时,必须填Url字段.

当业务名为bri_social时,必须填QQ和Wechat字段两者其中一个或者两个.

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBRI。
Version String 公共参数,本接口取值:2019-03-28。
Region String 公共参数,本接口不需要传递此参数。
RequestData BRIRequest 业务风险情报请求体
ResourceId String 客户用于计费的资源ID

3. 输出参数

参数名称 类型 描述
ResponseData BRIResponse 业务风险情报响应体
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 bri_num

输入示例

https://bri.tencentcloudapi.com/?Action=DescribeBRI
&ResourceId=test_resource_id_for_bri_num
&RequestData.Service=bri_num
&RequestData.PhoneNumber=18122223554
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "891f2f2e-4851-4cd8-9555-8d92d6e77902",
        "ResponseData": {
            "Score": 71.0,
            "Tags": [
                "疑似新客户"
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.Timeout 查询超时
InvalidParameter 参数错误。
InvalidParameter.CertMd5 CertMd5参数错误
InvalidParameter.FileMd5 FileMd5参数错误
InvalidParameter.FileSize FileSize参数错误
InvalidParameter.Imei Imei参数错误
InvalidParameter.InvalidAction 接口不存在
InvalidParameter.Ip IP参数错误
InvalidParameter.PackageName 包名填写错误
InvalidParameter.PhoneNumber PhoneNumber参数错误
InvalidParameter.QQ QQ参数错误
InvalidParameter.Service Service参数错误
InvalidParameter.Url Url参数错误
InvalidParameter.Wechat Wechat参数错误
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnknownParameter 未知参数错误。