https://github.com/qichengzx/qcloudsms_go
qcloudsms sdk for Go
https://github.com/qichengzx/qcloudsms_go
qcloud-sdk qcloudsms sms-client
Last synced: 5 months ago
JSON representation
qcloudsms sdk for Go
- Host: GitHub
- URL: https://github.com/qichengzx/qcloudsms_go
- Owner: qichengzx
- License: mit
- Created: 2018-01-01T13:40:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-07T11:36:39.000Z (over 6 years ago)
- Last Synced: 2024-06-18T17:29:08.903Z (almost 2 years ago)
- Topics: qcloud-sdk, qcloudsms, sms-client
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 59
- Watchers: 5
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
腾讯云短信 Go SDK
===
[](https://travis-ci.org/qichengzx/qcloudsms_go)
[](https://ci.appveyor.com/project/qichengzx/qcloudsms-go/branch/master)
[](https://godoc.org/github.com/qichengzx/qcloudsms_go)
[](https://goreportcard.com/report/github.com/qichengzx/qcloudsms_go)
[](https://raw.githubusercontent.com/qichengzx/qcloudsms_go/master/LICENSE)
## Overview
> 此 SDK 为非官方版本，命名和结构上与官方版本有一些区别。
> 海外短信和国内短信使用同一接口，只需替换相应的国家码与手机号码，每次请求群发接口手机号码需全部为国内或者海外手机号码。
> 语音通知目前支持语音验证码以及语音通知功能。
## Features
##### 短信
- [x] 单发短信
- [x] 指定模板单发短信
- [x] 群发短信
- [x] 群发模板短信
- [ ] 短信下发状态通知
- [ ] 短信回复
- [x] 拉取短信状态
- [x] 拉取单个手机短信状态
##### 语音
- [x] 发送语音验证码
- [x] 发送语音通知
- [ ] 语音验证码状态通知
- [ ] 语音通知状态通知
- [ ] 语音通知按键通知
- [ ] 语音送达失败原因推送
##### 模板
- [x] 添加模板
- [x] 修改模板
- [x] 删除模板
- [x] 模板状态查询
##### 签名
- [x] 添加签名
- [x] 修改签名
- [x] 删除签名
- [x] 短信签名状态查询
##### 统计
- [x] 发送数据统计
- [x] 回执数据统计
# Getting Start
## 准备
在开始开发云短信应用之前，需要准备如下信息:
- [x] 申请APPID以及APPKey
> 云短信应用SDK `AppID`和`AppKey`可在[短信控制台](https://console.cloud.tencent.com/sms)的应用信息里获取，如您尚未添加应用，请到[短信控制台](https://console.cloud.tencent.com/sms)中添加应用。
- [x] 申请签名
一个完整的短信由短信`签名`和短信正文内容两部分组成，短信`签名`须申请和审核，`签名`可在[短信控制台](https://console.cloud.tencent.com/sms)的相应服务模块`内容配置`中进行申请。
- [x] 申请模板
> 同样短信或语音正文内容`模板`须申请和审核，`模板`可在[短信控制台](https://console.cloud.tencent.com/sms)的相应服务模块`内容配置`中进行申请。
完成以上三项便可开始代码开发。
## 安装
```
go get github.com/qichengzx/qcloudsms_go
```
## 用法
```Go
import "github.com/qichengzx/qcloudsms_go"
opt := qcloudsms.NewOptions("yourappid","yourappkey","yoursign")
var client = qcloudsms.NewClient(opt)
client.SetDebug(true)
```
更多示例可在 [Example](https://github.com/qichengzx/qcloudsms_go/blob/master/example.go) 或 [godoc](https://godoc.org/github.com/qichengzx/qcloudsms_go#pkg-examples) 查看
注意：example.go 中的示例代码，调用 NewOptions()，NewClient(opt) 时没有加包名，在实际调用中需要加入，或 import 时加入省略包名的操作。
## Documentation
[完整文档](https://godoc.org/github.com/qichengzx/qcloudsms_go)
## License
This project is under the MIT License.