apikey query parameter for most operations. Account registration and password reset do not require an API key. Password changes use a form body. Avoid logging request URLs.
With Hub connection reporting enabled, Corsair core currently reports any successful endpoint as credential-verified, including registration and password reset. Those two operations do not check the API key; do not treat their success as API-key verification.
otp.validate throws an error with the message SMS Alert OTP code does not match for the documented Code does not match. response, even though SMS Alert labels it successful. Catch that error to handle a rejected code. For other responses, inspect description.desc rather than assuming status: "success" means the code matched; the provider has not documented all possible validation outcomes.
Use messages.send with schedule for scheduled messages, or dlrurl and reference to request delivery callbacks. Corsair does not provide an inbound webhook handler for those callbacks; secure them in your own application. XML contact import and XML push are excluded because their credential or payload contracts are incomplete. Requests are not automatically retried.
What you get:
- 29 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the SMS Alert API key before the first call: More: API Key
pnpm corsair setup --plugin=smsalert --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
account.balance
account.changePassword
What’s next
API reference
Every
smsalert.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.