检查手机号码是否支持卡片短信。
接口说明
- 未开通卡片短信业务的阿里云账号无法调用此 API。
- 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系阿里云售前咨询。
- 推荐使用新接口 QueryMobilesCardSupport 查询手机号是否支持卡片短信。
QPS 限制
本接口的单用户 QPS 限制为 2000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dysms:CheckMobilesCardSupport | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateCode | string | 是 | 卡片短信模板 Code。 登录短信服务控制台国内卡片短信页面,在模板管理页签查看卡片短信模板列表。 说明
必须是已添加、并通过审核的卡片短信模板。
| CARD_SMS_**** |
Mobiles | array<object> | 是 | 待查询的手机号列表。 | |
object | 是 | 待查询的手机号,且该参数的填写格式必须为{"#6#mobile":"1380000****"},否则会报手机号格式错误。一次请求最多支持查询 10000 个号码。 | {"#6#mobile":"1322587****"} |
完整请求参数示例:
{
"Mobiles": [
{
"#6#mobile": "137******00"
},
{
"#6#mobile": "130******00"
}
],
"TemplateCode": "CARD_SMS_6***9"
}
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
"Success": true,
"Data": {
"queryResult": [
{
"mobile": "1390000****",
"support": true
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
200 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 没有访问权限,请联系管理员 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史