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:

HeaderDescriptionRequired
api-tokenYour API authentication token
app-idYour application identifier
Content-Typeapplication/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:

GroupDescriptionKey Operations
VoiceAudio file management & voice deliveryUpload audio, send voice messages
SMSText message deliverySend SMS messages
GroupsContact organization for batch messagingCreate and manage contact groups
CampaignsStatus tracking and delivery resultsMonitor campaign performance

🛡️ Error Handling

The API uses standard HTTP status codes:

  • 200 - Success
  • 201 - Created (for uploads)
  • 202 - Accepted (for async operations)
  • 400 - Bad Request
  • 401 - Unauthorized
  • 429 - Rate Limited
  • 500 - Server Error

📋 Next Steps

  1. Send a Voice Message - Learn the two-step process
  2. Send an SMS - Quick SMS delivery
  3. 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.