https://github.com/android-sms-gateway/client-go
A Go client library for sending and managing SMS messages via the SMS Gateway for Android™ API.
https://github.com/android-sms-gateway/client-go
android android-app android-development android-sms api-client communication go-client go-sdk golang http-client message-service messaging-api mobile-messaging rest-api sms-api sms-gateway sms-integration sms-library sms-service telecommunications
Last synced: about 1 month ago
JSON representation
A Go client library for sending and managing SMS messages via the SMS Gateway for Android™ API.
- Host: GitHub
- URL: https://github.com/android-sms-gateway/client-go
- Owner: android-sms-gateway
- License: apache-2.0
- Created: 2024-05-28T02:13:46.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T07:11:24.000Z (about 1 year ago)
- Last Synced: 2025-03-26T08:24:03.369Z (about 1 year ago)
- Topics: android, android-app, android-development, android-sms, api-client, communication, go-client, go-sdk, golang, http-client, message-service, messaging-api, mobile-messaging, rest-api, sms-api, sms-gateway, sms-integration, sms-library, sms-service, telecommunications
- Language: Go
- Homepage: https://sms-gate.app
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Go Report Card][reportcard-shield]][reportcard-url]
[![Codecov][codecov-shield]][codecov-url]
[![Go Version][goversion-shield]][goversion-url]
[![License][license-shield]][license-url]
[![Release][release-shield]][release-url]
[![Stars][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [SMSGate client (`smsgateway`)](#smsgate-client-smsgateway)
- [Certificate Authority client (`ca`)](#certificate-authority-client-ca)
- [API Coverage](#api-coverage)
- [`smsgateway.Client`](#smsgatewayclient)
- [`ca.Client`](#caclient)
- [Contributing](#contributing)
- [License](#license)
## About The Project
`client-go` provides typed clients for the SMSGate ecosystem:
- `smsgateway` package for 3rd-party API operations (messages, devices, health, logs, settings, webhooks, and token lifecycle).
- `ca` package for Certificate Authority workflows (submit CSR and check CSR status).
- Shared low-level HTTP handling in the `rest` package.
The library supports both Basic authentication (`user` + `password`) and Bearer token authentication for the SMSGate client.
## Built With
- [Go](https://go.dev/) 1.22+
- Standard `net/http` client with configurable transport
## Getting Started
### Prerequisites
- Go 1.22 or newer
- SMSGate account/device credentials and/or API token
### Installation
```bash
go get github.com/android-sms-gateway/client-go
```
## Usage
### SMSGate client (`smsgateway`)
```go
package main
import (
"context"
"log"
"os"
"github.com/android-sms-gateway/client-go/smsgateway"
)
func main() {
ctx := context.Background()
client := smsgateway.NewClient(smsgateway.Config{
User: os.Getenv("ASG_USERNAME"),
Password: os.Getenv("ASG_PASSWORD"),
// or use Token: os.Getenv("ASG_TOKEN"),
})
state, err := client.Send(ctx, smsgateway.Message{
TextMessage: &smsgateway.TextMessage{Text: "Hello from Go"},
PhoneNumbers: []string{
"+15555550100",
},
})
if err != nil {
log.Fatal(err)
}
log.Printf("message queued: %s", state.ID)
}
```
### Certificate Authority client (`ca`)
```go
package main
import (
"context"
"log"
"github.com/android-sms-gateway/client-go/ca"
)
func main() {
ctx := context.Background()
client := ca.NewClient()
resp, err := client.PostCSR(ctx, ca.PostCSRRequest{
Type: ca.CSRTypeWebhook,
Content: "-----BEGIN CERTIFICATE REQUEST-----...",
})
if err != nil {
log.Fatal(err)
}
log.Printf("request id: %s, status: %s", resp.RequestID, resp.Status)
}
```
## API Coverage
### `smsgateway.Client`
- Messages: `Send`, `GetState`
- Devices: `ListDevices`, `DeleteDevice`
- Health: `CheckHealth`
- Inbox export: `ExportInbox`
- Logs: `GetLogs`
- Settings: `GetSettings`, `UpdateSettings`, `ReplaceSettings`
- Webhooks: `ListWebhooks`, `RegisterWebhook`, `DeleteWebhook`
- Token management: `GenerateToken`, `RefreshToken`, `RevokeToken`
For endpoint semantics and payload details, see https://api.sms-gate.app/
### `ca.Client`
- CSR workflows: `PostCSR`, `GetCSRStatus`
## Contributing
Contributions are welcome. Please open an issue to discuss major changes before submitting a pull request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/my-change`)
3. Commit your changes (`git commit -m 'Describe change'`)
4. Push to your branch
5. Open a Pull Request
## License
Distributed under the Apache-2.0 License. See [`LICENSE`](LICENSE) for details.
[reportcard-shield]: https://goreportcard.com/badge/github.com/android-sms-gateway/client-go?style=for-the-badge
[reportcard-url]: https://goreportcard.com/report/github.com/android-sms-gateway/client-go
[codecov-shield]: https://img.shields.io/codecov/c/gh/android-sms-gateway/client-go?style=for-the-badge
[codecov-url]: https://codecov.io/gh/android-sms-gateway/client-go
[goversion-shield]: https://img.shields.io/github/go-mod/go-version/android-sms-gateway/client-go?style=for-the-badge
[goversion-url]: https://github.com/android-sms-gateway/client-go/blob/HEAD/go.mod
[license-shield]: https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge
[license-url]: https://github.com/android-sms-gateway/client-go/blob/master/LICENSE
[release-shield]: https://img.shields.io/github/v/release/android-sms-gateway/client-go?style=for-the-badge
[release-url]: https://github.com/android-sms-gateway/client-go/releases
[stars-shield]: https://img.shields.io/github/stars/android-sms-gateway/client-go?style=for-the-badge
[stars-url]: https://github.com/android-sms-gateway/client-go/stargazers
[issues-shield]: https://img.shields.io/github/issues/android-sms-gateway/client-go?style=for-the-badge
[issues-url]: https://github.com/android-sms-gateway/client-go/issues
