Seven short message service connector

The official Logto connector for Seven short message service.

Table of contents

• Seven short message service connector
  • Register Seven account
  • Get API key
  • Compose the connector JSON
    • Test Seven SMS connector
    • Config types
  • Error codes

Register seven account

Create a new account on seven. (Jump to the next step if you already have one.)

Get API key

See the helpdesk article on how to retrieve your API key.

Compose the connector JSON

Fill out the field apiKey and optionally from.

You can add multiple SMS connector templates for different cases. Here is an example of adding a single template:

• Fill out the content field with arbitrary string-typed contents. Do not forget to leave {{code}} placeholder for random passcode.
• Fill out the usageType field with either Register, SignIn or Test for different use cases.

Here is an example of seven SMS connector config JSON.

{
    "apiKey": "<your-api-key>",
    "from": "<from>",
    "templates": [
        {
            "content": "<arbitrary-register-template-contents: your passcode is {{code}}>",
            "usageType": "Register"
        },
        {
            "content": "<arbitrary-sign-in-template-contents: your passcode is {{code}}>",
            "usageType": "SignIn"
        },
        {
            "content": "<arbitrary-test-template-contents: your passcode is {{code}}>",
            "usageType": "Test"
        }
    ]
}

Test seven SMS connector

You can enter a phone number and click on "Send" to see whether the settings can work before "Save and Done".

That's it. Don't forget to Enable connector in sign-in experience.

Config types

Name	Type
apiKey	string
from	string
templates	Templates[]

Template Properties	Type	Enum values
content	string	N/A
usageType	enum string	'Register' \ 'SignIn' \ 'Test'

Error codes

• seven - error codes