语音发送API

收起菜单

语音发送 API

1.概览

语音发送前需要先创建模板并审核通过后方可使用。

2.接口说明

2.1请求URL

https://apis.shlianlu.com/sms/voice/send

2.2请求方式

POST

2.3请求包头定义

Accept: application/json

Content-Type: application/json;charset=utf-8

3.请求参数

MchId	String	是	企业ID：请登录联麓客户端点击（语音服务）进入概览页面获取	100***66
AppId	String	是	Appid：请登录联麓客户端点击（语音服务）进入概览页面获取	10*************00
Version	String	是	公共参数，本接口取值：1.1.0	1.1.0
TimeStamp	String	是	Timestamp UNIX 时间戳	1647481897155
SignType	String	是	加密方式，固定值：MD5或者HMACSHA256	MD5
Signature	String	是	数字签名。所有字段（除PhoneNumberSet字段）排序拼接字符串，并在最后加上&key=Appkey(appkey为appid对应密钥)，用MD5或者HMACSHA256加密所得字符串，转为大写。详见sdk
PhoneNumberSet	Array of String	是	接收短信的手机号码数组，上限为1000，号码间用以半角逗号（,）分隔。	["15587571285","15587571286"]
TemplateParamSet	Array of String	否	提交模板变量内容，根据平台创建模板变量数提交相应变量	["联麓信息", "123456"]
TemplateId	String	是	模版id，请登录联麓客户端点击（语音服务）进入短信模板页面创建模板获取。	123456
TaskTime	String	否	定时任务，设置任务按照预定的时间发送，UNIX 时间戳	1647481897155
Tag	String	否	自定义标签，当请求传入此参数时则拉取/推送报告时也会携带此参数	123

Signature 签名机制详解

4.返回参数

返回状态	status	string	短信发送状态
唯一ID	taskId	string	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
时间戳	timestamp	string	UNIX 时间戳
返回信息	message	string	返回信息

5.示例

5.1请求示例

{
  "TemplateParamSet": ["联麓信息", "123456"],
  "PhoneNumberSet": ["15587571285"],
  "AppId": "100*******670",
  "Version": "Version",
  "MchId": "1000135",
  "Signature": "D0BDCBECCD960059D8806095413B40B6", 签名机制详解
  "TaskTime": "1662108626023",
  "Tag": "123",
  "SignType": "MD5",
  "TimeStamp": "1646289005142",
  "TemplateId": "70000482"
}

5.2返回示例

{
  "tag": "123",
  "message": "success",
  "taskId": "202209020013611000007",
  "timestamp": 1662108944571,
  "status": "00"
}

6.错误码

参阅 API 错误代码