检查手机号码是否支持卡片短信。
接口说明
未开通卡片短信业务的阿里云账号无法调用此 API。
目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系阿里云售前咨询。
推荐使用新接口 QueryMobilesCardSupport 查询手机号是否支持卡片短信。
QPS 限制
本接口的单用户 QPS 限制为 2000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
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"
}
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
请求状态码。
|
OK |
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
819BE656-D2E0-4858-8B21-B2E477085AAF |
| Success |
boolean |
接口调用是否成功。取值:
|
true |
| Data |
object |
返回数据。 |
|
| queryResult |
array<object> |
查询结果列表。 |
|
|
object |
查询数据。 |
||
| mobile |
string |
手机号码。 |
1390000**** |
| support |
boolean |
是否支持卡片短信能力。取值:
|
true |
示例
正常返回示例
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. | 没有访问权限,请联系管理员。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。