{"id":18666732,"url":"https://github.com/johnmai-dev/Gsms","last_synced_at":"2025-04-11T23:33:06.391Z","repository":{"id":84732830,"uuid":"606326021","full_name":"johnmai-dev/Gsms","owner":"johnmai-dev","description":"📲 一款满足你的多种发送需求的短信发送组件，参考overtrue/easy-sms实现的 Go 版本","archived":false,"fork":false,"pushed_at":"2024-06-20T06:02:51.000Z","size":65,"stargazers_count":18,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T10:28:54.299Z","etag":null,"topics":["aliyun-sms","easy-sms","go","go-sms","golang","golang-sms","sms","sms-client","sms-gateway","yunpian-sms"],"latest_commit_sha":null,"homepage":"https://github.com/maiqingqiang/Gsms","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnmai-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-25T06:24:26.000Z","updated_at":"2024-11-21T15:14:06.000Z","dependencies_parsed_at":"2024-11-10T09:36:11.174Z","dependency_job_id":null,"html_url":"https://github.com/johnmai-dev/Gsms","commit_stats":null,"previous_names":["johnmai-dev/gsms"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmai-dev%2FGsms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmai-dev%2FGsms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmai-dev%2FGsms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnmai-dev%2FGsms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnmai-dev","download_url":"https://codeload.github.com/johnmai-dev/Gsms/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248495767,"owners_count":21113695,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aliyun-sms","easy-sms","go","go-sms","golang","golang-sms","sms","sms-client","sms-gateway","yunpian-sms"],"created_at":"2024-11-07T08:33:47.313Z","updated_at":"2025-04-11T23:33:01.352Z","avatar_url":"https://github.com/johnmai-dev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\n[![go report card][go-report-card]][go-report-card-url]\n[![Go.Dev reference][go.dev-reference]][go.dev-reference-url]\n[![Go package][go-pacakge]][go-pacakge-url]\n[![MIT License][license-shield]][license-url]\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n\n\n\u003ch1 align=\"center\"\u003eGsms :calling: \u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e:calling: 一款满足你的多种发送需求的短信发送组件，此项目参考 \u003ca href=\"https://github.com/overtrue/easy-sms\"\u003eeasy-sms\u003c/a\u003e 实现的 Go 版本 \u003c/p\u003e\n\n## 特点\n\n1. 支持目前市面多家服务商\n2. 一套写法兼容所有平台\n3. 简单配置即可灵活增减服务商\n4. 内置多种服务商轮询策略、支持自定义轮询策略\n5. 统一的返回值格式，便于日志与监控\n6. 自动轮询选择可用的服务商\n7. 更多等你去发现与改进...\n\n## 平台支持\n\n- [云片](https://www.yunpian.com)\n- [阿里云](https://www.aliyun.com/)\n- [腾讯云 SMS](https://cloud.tencent.com/product/sms)\n- 欢迎PR，或者你提供帮助我来开发~\n\n\n## 安装\n\n```shell\ngo get -u github.com/maiqingqiang/gsms\n```\n\n## 使用\n\n```go\npackage main\n\nimport (\n\t\"github.com/maiqingqiang/gsms\"\n\t\"github.com/maiqingqiang/gsms/gateways/aliyun\"\n\t\"github.com/maiqingqiang/gsms/gateways/yunpian\"\n\t\"github.com/maiqingqiang/gsms/message\"\n\t\"log\"\n)\n\nfunc main() {\n\tclient := gsms.New(\n\t\t[]gsms.Gateway{\n\t\t\t\u0026yunpian.Gateway{\n\t\t\t\tApiKey:    \"ApiKey\",\n\t\t\t\tSignature: \"Signature\",\n\t\t\t},\n\t\t\t\u0026aliyun.Gateway{\n\t\t\t\tAccessKeyId:     \"AccessKeyId\",\n\t\t\t\tAccessKeySecret: \"AccessKeySecret\",\n\t\t\t\tSignName:        \"SignName\",\n\t\t\t},\n\t\t},\n\t\tgsms.WithGateways([]string{\n\t\t\tyunpian.NAME, aliyun.NAME,\n\t\t}),\n\t)\n\n\tresults, err := client.Send(18888888888, \u0026message.Message{\n\t\tTemplate: \"5532044\",\n\t\tData: map[string]string{\n\t\t\t\"code\": \"521410\",\n\t\t},\n\t})\n\n\tif err != nil {\n\t\tlog.Fatalf(\"发送失败 %+v\", err)\n\t}\n\n\tlog.Printf(\"发送成功 %+v\", results)\n}\n```\n\n## 短信内容\n\n由于使用多网关发送，所以一条短信要支持多平台发送，每家的发送方式不一样，但是我们抽象定义了以下公用属性：\n- `Content` 文字内容，使用在像云片类似的以文字内容发送的平台\n- `Template` 模板 ID，使用在以模板ID来发送短信的平台\n- `Data`  模板变量，使用在以模板ID来发送短信的平台\n\n所以，在使用过程中你可以根据所要使用的平台定义发送的内容。\n\n```go\nclient.Send(18888888888, \u0026core.Message{\n    Template: \"SMS_00000001\",\n    Data: map[string]string{\n        \"code\": \"521410\",\n    },\n})\n\nclient.Send(18888888888, \u0026core.Message{\n    Content: \"您的验证码为: 6379\",\n})\n```\n\n### 闭包方式\n```go\nclient.Send(18888888888, \u0026core.Message{\n    Template: func(gateway core.GatewayInterface) string {\n        if gateway.Name() == aliyun.NAME {\n            return \"SMS_271385117\"\n        }\n        return \"5532044\"\n    },\n    Data: func(gateway core.GatewayInterface) map[string]string {\n        if gateway.Name() == aliyun.NAME {\n            return map[string]string{\n                \"code\": \"1111\",\n            }\n        }\n        return map[string]string{\n            \"code\": \"6379\",\n        }\n    },\n})\n```\n\n## 发送网关\n```go\nclient.Send(18888888888, \u0026core.Message{\n    Template: \"5532044\",\n    Data: map[string]string{\n        \"code\": \"6379\",\n    },\n}, yunpian.NAME, aliyun.NAME)\n```\n\n## 自定义网关\n\n只需要实现 `gsms.Gateway` 接口即可，例如：\n\n## 场景发送\n\n```go\n\nvar _ gsms.Message = (*OrderPaidMessage)(nil)\n\ntype OrderPaidMessage struct {\n    OrderNo string\n}\n\nfunc (o *OrderPaidMessage) Gateways() ([]string, error) {\n    return []string{yunpian.NAME}, nil\n}\n\nfunc (o *OrderPaidMessage) Strategy() (gsms.Strategy, error) {\n    return nil, nil\n}\n\nfunc (o *OrderPaidMessage) GetContent(gateway gsms.Gateway) (string, error) {\n    return fmt.Sprintf(\"您的订单:%s, 已经完成付款\", o.OrderNo), nil\n}\n\nfunc (o *OrderPaidMessage) GetTemplate(gateway gsms.Gateway) (string, error) {\n    return \"5532044\", nil\n}\n\nfunc (o *OrderPaidMessage) GetData(gateway gsms.Gateway) (map[string]string, error) {\n    return map[string]string{\n    \"code\": \"6379\",\n    }, nil\n}\n\nfunc (o *OrderPaidMessage) GetType(gateway gsms.Gateway) (string, error) {\n    return message.TextMessage, nil\n}\n\nclient.Send(18888888888, \u0026OrderPaidMessage{OrderNo: \"1234\"})\n\n```\n\n## 各平台配置说明\n\n### [阿里云](https://www.aliyun.com/)\n\n短信内容使用 `Template` + `Data`\n\n```go\n\u0026aliyun.Gateway{\n    AccessKeyId:     \"AccessKeyId\",\n    AccessKeySecret: \"AccessKeySecret\",\n    SignName:        \"【默认签名】\",\n}\n```\n\n### [云片](https://www.yunpian.com)\n\n短信内容使用 `Content`\n\n```go\n\u0026yunpian.Gateway{\n    ApiKey:    \"ApiKey\",\n    Signature: \"【默认签名】\", // 内容中无签名时使用\n}\n```\n\n### [腾讯云 SMS](https://cloud.tencent.com/product/sms)\n\n短信内容使用 `Template` + `Data`\n\n```go\n\u0026qcloud.Gateway{\n    SdkAppId:  \"\",\n    SecretId:  \"\",\n    SecretKey: \"\",\n    SignName:  \"\",\n}\n```\n\n## 版权说明\n\n该项目签署了 MIT 授权许可，详情请参阅 [LICENSE](LICENSE)\n\n## 鸣谢\n\n- [安正超](https://github.com/overtrue)\n- [easy-sms](https://github.com/overtrue/easy-sms)\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/maiqingqiang/Gsms.svg\n[contributors-url]: https://github.com/maiqingqiang/Gsms/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/maiqingqiang/Gsms.svg\n[forks-url]: https://github.com/maiqingqiang/Gsms/network/members\n[stars-shield]: https://img.shields.io/github/stars/maiqingqiang/Gsms.svg\n[stars-url]: https://github.com/maiqingqiang/Gsms/stargazers\n[issues-shield]: https://img.shields.io/github/issues/maiqingqiang/Gsms.svg\n[issues-url]: https://github.com/maiqingqiang/Gsms/issues\n[license-shield]: https://img.shields.io/github/license/maiqingqiang/Gsms.svg\n[license-url]: https://github.com/maiqingqiang/Gsms/blob/main/LICENSE\n[go-report-card]: https://goreportcard.com/badge/github.com/maiqingqiang/Gsms\n[go-report-card-url]: https://goreportcard.com/report/github.com/maiqingqiang/Gsms\n[go.dev-reference]: https://img.shields.io/badge/go.dev-reference-blue?logo=go\u0026logoColor=white\n[go.dev-reference-url]: https://pkg.go.dev/github.com/maiqingqiang/gsms?tab=doc\n[go-pacakge]: https://github.com/maiqingqiang/Gsms/actions/workflows/test.yml/badge.svg?branch=main\n[go-pacakge-url]: https://github.com/maiqingqiang/Gsms/actions/workflows/test.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmai-dev%2FGsms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnmai-dev%2FGsms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnmai-dev%2FGsms/lists"}