获取短信任务
更新时间:2025-08-15 03:41:38
基本信息
Action
DescribeSMSJobs
Path
/iaas
Method
GET
请求参数
此接口除公共参数外,还包含以下参数。关于公共参数的更多信息,请参见前文内容。
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
String |
否 |
用户邮箱 |
|
end_time |
String |
否 |
查询发送截止时间 |
notification_center_posts |
String |
否 |
消息任务id查询偏移量 |
phone |
String |
否 |
用户手机号 |
phones |
String |
否 |
接收短信的手机号 |
post_sub_type |
String |
否 |
消息类型 |
post_type |
String |
否 |
业务类型 |
provider |
String |
否 |
短信供应商 |
search_word |
String |
否 |
模糊查询 |
sms_jobs |
String |
否 |
短信任务id |
sms_type |
String |
否 |
短信类型 |
start_time |
String |
否 |
查询发送开始时间 |
status |
String |
否 |
状态 |
user_id |
String |
否 |
用户 ID |
user_name |
String |
否 |
用户名称 |
返回数据
此接口除公共返回参数外,还包含以下返回参数。关于公共返回参数的更多信息,请参见前文内容。
| 参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
sms_job_set |
Array |
否 |
短信任务集合 |
sms_job_set.content |
String |
否 |
短信内容 |
sms_job_set.create_time |
String |
否 |
创建时间 |
sms_job_set.phone |
String |
否 |
手机号 |
sms_job_set.provider |
String |
否 |
短信供应商 |
sms_job_set.sms_job_id |
String |
否 |
短信任务id |
sms_job_set.sms_type |
String |
否 |
短信类型 |
sms_job_set.status |
String |
否 |
状态 |
sms_job_set.tick_id |
String |
否 |
批次id |
total_count |
Integer |
否 |
查询结果总数 |
请求示例
{
"action": "DescribeSMSJobs",
"limit": 1,
"offset": 0,
"phones": [],
"sms_jobs": [],
"sms_type": "",
"status": ""
}
返回示例
{
"action": "DescribeSMSJobsResponse",
"ret_code": 0,
"sms_job_set": [
{
"content": "您的手机验证码是: 2685,请在30分钟内完成验证。",
"create_time": "2019-12-27T03:39:51Z",
"phone": "17786022311",
"provider": "zucp",
"sms_job_id": "sms-xxxxxxxx",
"sms_type": "register",
"status": "pending",
"tick_id": "-21"
}
],
"total_count": 8333
}