An open API service indexing awesome lists of open source software.

https://github.com/seven-io/logto


https://github.com/seven-io/logto

logto seven-plugin sms

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

          


seven logo

seven SMS Connector for Logto


Official Logto connector for sending passcode SMS via the seven gateway.


MIT License
Logto connector
TypeScript runtime

---

## Features

- **Passwordless Sign-In** - Wire seven SMS into Logto's passcode sign-in experience
- **Per-Use-Case Templates** - Distinct message templates for `Register`, `SignIn` and `Test`
- **Custom Sender ID** - Override the displayed sender via the `from` field

## Prerequisites

- A [Logto](https://logto.io/) project (cloud or self-hosted)
- A [seven account](https://www.seven.io/) with API key ([How to get your API key](https://help.seven.io/en/developer/where-do-i-find-my-api-key))

## Configuration

In the Logto admin, add a new SMS connector and pick **seven**. Paste the JSON config below and edit the placeholders:

```json
{
"apiKey": "",
"from": "",
"templates": [
{
"content": "",
"usageType": "Register"
},
{
"content": "",
"usageType": "SignIn"
},
{
"content": "",
"usageType": "Test"
}
]
}
```

| Field | Type | Description |
|-------|------|-------------|
| `apiKey` | string | Your seven API key |
| `from` | string | Optional sender ID. Up to 11 alphanumeric or 16 numeric characters |
| `templates` | Template[] | One template per use case |

| Template field | Type | Allowed values |
|----------------|------|----------------|
| `content` | string | Free-form text. Must contain `{{code}}` placeholder |
| `usageType` | enum string | `Register` / `SignIn` / `Test` |

## Usage

1. Click **Test** in the connector settings to verify your setup with a real phone number.
2. After saving, [enable the connector in the sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-passcode-sign-in/#enable-connector-in-sign-in-experience).

## Error codes

See seven's [SMS return codes](https://docs.seven.io/en/rest-api/endpoints/sms#return-codes) for what each numeric response means.

## Support

Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/) or [open an issue](https://github.com/seven-io/logto/issues).

## License

[MIT](LICENSE)