提交黑名单申请

最近更新时间:2019-08-13 19:58:06

1. 接口描述

接口请求域名: cr.ap-shenzhen-fsi.tencentcloudapi.com 。

提交黑名单后,黑名单中有效期内的号码将停止拨打,适用于提醒、催收、回访场景。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ApplyBlackList
Version String 公共参数,本接口取值:2018-03-21
Region String 公共参数,本接口取值 ap-shenzhen-fsi。
Module String 模块名,本接口取值:account
Operation String 操作名,本接口取值:ApplyBlackList
BlackList.N Array of SingleBlackApply 黑名单列表
InstId String 实例ID,不传默认为系统分配的初始实例

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交黑名单申请

输入示例

https://cr.ap-shenzhen-fsi.tencentcloudapi.com/?Action=ApplyBlackList
&Module=account
&Operation=ApplyBlackList
&BlackList.0.BlackType=01
&BlackList.0.OperationType=A
&BlackList.0.BlackValue=13312345233
&BlackList.0.BlackDescription=输入示例
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "13ca0b60-ff5g-43e2-9123-b9361bf0f93e"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ApplyBlackListError 提交黑名单出错。
InternalError.UnknownError 内部未知错误。
MissingParameter.MOError 找不到Module 或 Operation。