Installation
Requirements
- Node.js 18 or higher
- TypeScript 4.7+ (optional, for type definitions)
Quick Start
Configuration
Initialize the Client
Environment Variables
We recommend storing your API key in environment variables:Messages
Send a Message
Send with Template
Get Message Status
List Messages
Templates
Create Template
List Templates
Get Template
Update Template
Delete Template
Senders
List Senders
Create Sender
Contacts
Get Contact
Update Contact
Error Handling
Error Types
| Error Code | Description |
|---|---|
bad_request | Invalid request parameters |
unauthorized | Invalid or missing API key |
forbidden | Insufficient permissions |
not_found | Resource not found |
rate_limit_exceeded | Too many requests |