Getting Started with LigueLead
Welcome to the LigueLead API! This guide will help you get started with our ommunication platform for voice messaging and SMS services.
Base URL & Authentication
Base URL:
https://api.liguelead.com.br/v1
All API requests require dual header authentication:
| Header | Description | Required |
|---|---|---|
api-token | Your API authentication token | ✅ |
app-id | Your application identifier | ✅ |
Content-Type | application/json (for JSON requests) | ✅ |
Get Your Credentials: Access your LigueLead account at areadocliente.liguelead.app.br and navigate to Integrations → API Token.
🚀 Quick Start
1. Test Your Authentication
curl -X GET "https://api.liguelead.com.br/v1/voice/uploads" \
-H "api-token: YOUR_API_TOKEN" \
-H "app-id: YOUR_APP_ID"2. Send Your First SMS
curl -X POST "https://api.liguelead.com.br/v1/sms" \
-H "api-token: YOUR_API_TOKEN" \
-H "app-id: YOUR_APP_ID" \
-H "Content-Type: application/json" \
-d '{
"title": "My First SMS",
"message": "Hello from LigueLead!",
"phones": ["11999999999"]
}'📱 Phone Number Format
Important: The API accepts phone numbers both with and without country code (DDI):
✅ Accepted: "11999999999" (national format)
✅ Accepted: "+5511999999999" or "5511999999999" (with DDI)
For best compatibility, the national 11-digit format is recommended, but numbers with country code are also supported.
🔄 Asynchronous Processing
Both SMS and Voice message sending are asynchronous operations:
- Response:
202 Accepted(request queued for processing) - Tracking: Use the Campaign endpoints to monitor delivery status
- Real-time Updates: Consider implementing webhooks (contact support)
🏗️ API Structure
The LigueLead API is organized into logical groups:
| Group | Description | Key Operations |
|---|---|---|
| Voice | Audio file management & voice delivery | Upload audio, send voice messages |
| SMS | Text message delivery | Send SMS messages |
| Groups | Contact organization for batch messaging | Create and manage contact groups |
| Campaigns | Status tracking and delivery results | Monitor campaign performance |
🛡️ Error Handling
The API uses standard HTTP status codes:
200- Success201- Created (for uploads)202- Accepted (for async operations)400- Bad Request401- Unauthorized429- Rate Limited500- Server Error
📋 Next Steps
- Send a Voice Message - Learn the two-step process
- Send an SMS - Quick SMS delivery
- API Limits - Understand rate limits and constraints
💡 Best Practices
- Test with small batches before scaling up
- Store audio IDs from uploads for reuse
- Use groups to organize related campaigns
- Handle rate limits gracefully in your application
🆘 Support
Need help? Contact our support team through the LigueLead Client Area.
Updated 5 months ago
