发送短信
1.接口描述
请求方式可以是GET或者POST,两者选择其一,POST参数格式已JSON格式传递
接口请求地址:GET /client-sms/v2/sms/send-single
接口请求地址:POST /client-sms/v2/sms/send-single
2.输入参数
| 参数名称 | 描述 | 是否必选 | 类型 | Location |
|---|---|---|---|---|
| Finovy-Access-Token | 令牌-口令 | yes | string | header |
| mobile | 短信接收的手机号 | yes | string | body |
| content | 短信内容:最大支持1000个字,使用 UrlEncode 编码 UTF-8的消息内容。 | yes | string | body |
| svrtype | 业务类型:描述本条短信的内容类型,属于验证码:1、通知:2、或营销:3 | yes | string | body |
| exno | 填 写 本 条 短 信 的 OA 或SenderID。可留空。 | yes | string | body |
| custid | 用户自定义流水号:该条短信在您业务系统内的 ID,比如订单号或者短信发送记录的流水号。 | yes | string | body |
| exdata | 自定义扩展资料:额外提供的最大 64 个长度的 ASCII 字符串:字母、数字、底线、减号,作为自定义扩展数据,填写后,状态报告返回时将会包含这部分数据,如不需要则不用提交此字段或填空。 | yes | string | body |
3.输出参数
| 参数名称 | 描述 | 类型 |
|---|---|---|
| result | 短信发送请求处理结果:0:成功,非0:失败, 详见错误码 | string |
| desc | 应答结果描述,当result非0时,为错误描述,编码方式:urlencode(UTF-8) | string |
| msgid | 短信流水号:一条请求短信只对应一个 msgid | string |
| custid | 用户自定义流水号:默认与请求报文中的 custid 保持一致,若请求报文中没有 custid 参数或值为空, | string |
4.示例
示例1:请求成功示例
输入示例
POST /client-sms/v2/sms/send-single / HTTP/1.1
Host: smsapi-sandbox.finovy.cn
Finovy-Access-Token: 4vL4rcNGNcgx5v0RLCcFew
Content-Type: application/json
<公共请求参数>
{
"mobile": "8618948591091",
"content": "%E8%BF%99%E6%98%AF%E4%B8%80%E6%9D%A1%E6%B5%8B%E8%AF%95%E7%9F%AD%E4%BF%A1",
"svrtype": "1"
}
输出示例
{"result":0,"desc":"%E6%88%90%E5%8A%9F","msgid":14726114648485533180,"custid":"14726114648485533180"}
5.错误码
| 状态码 | 描述 |
|---|---|
| 0 | 接口调用成功 |
| 401 | 身份认证失败 |
| 1001 | 无权限 |
| 100001 | 短信发送错误 |
| 100002 | 参数绑定异常 |