发送短信
服务描述
本接口用于发送短信
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/crm/openapi/v1/sms/send
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
SmsSendOpenapiData |
body |
SmsSendOpenapiData |
Y |
短信入参 |
SmsSendOpenapiData
参数 |
类型 |
说明 |
templateId |
String |
模板ID,由短信模板获取 |
phoneParam |
List<phoneParam> |
手机参数 |
phoneParam
参数 |
类型 |
说明 |
phone |
String |
手机号 |
paramDatas |
List |
短信内容的变量参数,按照顺序匹配 |
请求数据示例:
POST https://{您的专属域名}/crm/openapi/v1/sms/send
假如短信内容为:你好{1},欢迎使用得助系统,你的验证码为{2},3分钟内有效。
body入参为:
{
"phoneParam": [
{
"paramDatas": [
"张三","9999"
],
"phone": "18428111422"
},
{
"paramDatas": [
"李四","8888"
],
"phone": "18428111423"
}
],
"templateId": 7
}
则张三收到的短信内容为:
你好张三,欢迎使用得助系统,你的验证码为9999,3分钟内有效。
李四收到的短信内容为:
你好李四,欢迎使用得助系统,你的验证码为8888,3分钟内有效。
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
|
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": {}
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
20001 |
请求失败 |
21002 |
认证失败,请重新登录 |
FAQ: