# Description
提供短信发送功能
# Scene
在需要向用户提供发送短信功能的场景提供服务,需要租户在短信模块配置了发送器与短信模板,目前仅支持使用容联云平台发送短信。
# 接口路径
/v1/send
,如 https://alpha-engage.gridsumdissector.com/open-api/sms/open-api/v1/send
# 请求参数
Name | Type | Description |
---|---|---|
phone | String | 目标手机号码 |
data | Object | 发送内容 |
templateId | String | 短信模板Id(系统内的32位uid) |
如:
{
"profileId": "",
"userId": "",
"data":{
"phone": "18912344321",
"data": {
"1":"填充字段1",
"2":"填充字段2"
},
"templateId": "1UpDJx8mAkUgOe8LKjmRFkTayv0fm03l",
}
}
# 响应参数
Name | Type | Description |
---|---|---|
data | Object | 响应内容 |
data.result | String | 发送结果(success:成功,failure:失败) |
data.errMsg | String | 如果发送失败,显示错误原因 |