跳到主要内容

SendBatchUSMSMessage

批量发送短信

接口说明

批量发送短信消息,支持一次发送给多个手机号。

请求信息

请求参数

Header参数

参数名类型必填说明示例值
Content-Typestring请求内容类型"application/json"
AuthorizationstringHTTP Basic认证信息"Basic $(echo -n 'accesskeyId:accesskeySecret'

Body参数

参数名类型必填说明示例值
TaskContentarray发送任务列表见下方说明

TaskContent 数组元素说明

每个元素包含以下字段:

参数名类型必填说明示例值
TemplateIdstring模板ID"template_id_1"
SenderIdstring发送方标识(发送方名称)"USpeedo"
Targetarray目标手机号列表见下方说明

Target 数组元素说明

每个元素包含以下字段:

参数名类型必填说明示例值
Phonestring手机号码"13800138000"
TemplateParamsarray模板参数(根据模板变量填写)["123456"]

请求示例

curl -X POST "https://api.uspeedo.com/api/v1/usms/SendBatchUSMSMessage" \
-H "Content-Type: application/json" \
-H "Authorization: Basic $(echo -n 'YOUR_ACCESSKEY_ID:YOUR_ACCESSKEY_SECRET' | base64)" \
-d '{
"TaskContent": [
{
"TemplateId": "template_id_1",
"SenderId": "USpeedo",
"Target": [
{
"Phone": "13800138000",
"TemplateParams": ["123456"]
}
]
}
]
}'

响应格式

成功响应

{
"RetCode": 0,
"Message": "success",
"SessionNo": ["session_no_1", "session_no_2"],
"FailedTargetPhones": []
}

响应字段说明

字段名类型说明
RetCodeint返回码,0表示成功
Messagestring返回消息
SessionNoarray会话编号列表,用于查询发送状态
FailedTargetPhonesarray发送失败的手机号列表,每个元素包含:Phone(手机号)、TemplateParams(模板参数)、FailureReason(失败原因)

失败响应

{
"RetCode": 215392,
"Message": "Invalid parameter [TemplateId]"
}

常见错误码

错误码说明
0成功
215392参数错误
215397缺少必填参数
215400服务器错误