批量创建手机号黑名单 - BatchCreateUSMSBlacklistPhone
简介
批量创建手机号黑名单
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 BatchCreateUSMSBlacklistPhone | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | No |
| Zone | string | 可用区。参见 可用区列表 | No |
| ProjectId | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口 | Yes |
| IsGlobal | boolean | 是否全项目生效 | Yes |
| BlackList | string | 手机号黑名单列表,该参数是json数组的base64编码结果,单次不超过1000条;子项参数说明: { “Phone”: “13900000001”, 手机号 类型:string “Purpose”: 2,短信类型 类型int :0-不过滤 1-验证码 2-通知 3-营销 “Remark”: “测试数据001” 备注 类型 string(最大256字符) } Remark: 备注(最大256字符)示例： 示例:发送内容json数组(base64编码前): [ { “Phone”: “13900000001”, “Purpose”: 2, “Remark”: “测试数据001” } ] 示例:发送内容json数组(base64编码后): Ww0KICAgICB7DQogICAgICAiUGhvbmUiOiAiMTM5MDAwMDAwMDEiLA0KICAgICAgIlB1cnBvc2UiOiAyLA0KICAgICAgIlJlbWFyayI6ICLmtYvor5XmlbDmja4wMDEiIA0KICAgIH0NCl0= 其他: 支持的手机号格式 1. 带括号的手机号，括号里面是国家码 (a)xxxxx 2. 不带括号的手机号 axxxxxx 3. 带加号的手机号 +axxxxx | Yes |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| ReqUuid | string | 本次请求Uuid | Yes |
| SuccessList | array[string] | 创建成功的手机号列表 示例[“13900000001”,“13900000002] | Yes |
| FailedList | array[string] | 创建失败的手机号列表 示例[“13900000003”,“13900000004] | Yes |
示例
请求示例
https://api.x-adc.cn/?Action=BatchCreateUSMSBlacklistPhone
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=tHdAlChQ
&IsGlobal=true
&BlackList=Ww0KICAgICB7DQogICAgICAiUGhvbmUiOiAiMTM5MDAwMDAwMDEiLA0KICAgICAgIlB1cnBvc2UiOiAyLA0KICAgICAgIlJlbWFyayI6ICLmtYvor5XmlbDmja4wMDEiIA0KICAgIH0NCl0=响应示例
{
"Action": "BatchCreateUSMSBlacklistPhoneResponse",
"FailedList": [
"13900000003",
"13900000004"
],
"Message": "Success",
"ReqUuid": "ezKmluyR",
"RetCode": 0,
"SuccessList": [
"13900000001",
"13900000002"
]
}