1.1 接口说明
在优音云客服系统中,可先通过 设置>渠道设置>短信 中,查看短信状态为“审核通过”的短信模板,用对应短信模板ID做为下一步使用群发短信的必要参数。
1.2 调用形式
1.3 调用方式
POST
1.4 传入参数
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | sms_template_id | String | 是 | 已审核通过的短信模板ID(开通云客服系统后,在 设置>渠道设置>短信 右侧中)找对应的短信模板ID |
2 | numbers | String | 是 | 接收手机号码,多个手机号码以英文逗号分隔 |
3 | var0至var9 | String | 否 | 需要替换的变量,例如:要替换{1}传var1 |
注:如需同时给多个手机号发送短信,可在num中传多个手机号以英文逗号分开。
1.5 回应参数
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | errcode | Number | 是 | 状态码:0成功,及其他非0错误码,详见错误码列表 |
2 | errmsg | String | 是 | 状态说明 |
3 | data | Object数组 | 是 | null,该参数无值 |
1.6 使用样例
调用:
url:https://ykf.uincall.com/openapi/sms/send/v2?tenant_id=acf5xxxx-xxxx-xxxx-xxxx-xxxxxxxxcfab&access_token=xxxxxxxx
样例报文1:
{
"sms_template_id": "d8e6xxxxc1bbxxxxe8bexxxx50e7xxxx",
"numbers": "13000000000",
"var0": "替换变量",
"var1": "替换变量",
"var2": "替换变量",
"var3": "替换变量",
"var4": "替换变量",
"var5": "替换变量",
"var6": "替换变量",
"var7": "替换变量",
"var8": "替换变量",
"var9": "替换变量"
}
样例报文2:
{
"sms_template_id": "d8e6xxxxc1bbxxxxe8bexxxx50e7xxxx",
"numbers": "130xxxx,130xxxx"
}
响应样例1:
{
"errcode": 180003,
"errmsg": "短信发送失败",
"data": null
}
响应样例2:
{
"errcode": 200,
"errmsg": "短信发送成功",
"data": null
}
文档更新时间: 2025-04-15 09:29 作者:admin