How to Send a SMS

To send SMS messages using this API, follow the steps below:

Send text messages to multiple recipients using the LigueLead API's simple one-step process.


📋 Prerequisites

  • Valid api-token and app-id from your LigueLead account

  • Target phone numbers in Brazilian format (11 digits, no country code)

  • SMS message content (text)


📱 Send SMS Message

Send SMS messages to multiple recipients with a single API call.


1️⃣ Get Your Credentials

  1. Access your account at areadocliente.liguelead.app.br
  2. Navigate to the API Credentials section
  3. Copy your API Key and API Secret (or the authentication token provided)

2️⃣ Prepare the Request

Endpoint:POST /v1/sms📄 Send SMS – API Reference


Request Example

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": "Welcome Campaign",
    "message": "Welcome to LigueLead! Thank you for joining us.",
    "phones": ["11999999999", "11888888888"],
    "group_id": "optional-group-id"
  }'

Response

{
  "message": "SMS accepted successfully",
  "data": {
    "campaign_id": "3b4f7c5e-7e2d-4157-b542-5eb2155455c5",
    "accepted_at": "2025-12-29T18:34:38.961Z"
  }
}

💡 Tip: Save the returned campaign_id for tracking delivery status later.


📋 Request Parameters

ParameterTypeRequiredDescription
titlestringCampaign identifier for organization
messagestringSMS text content to be sent
phonesarrayBrazilian phone numbers (accept multiple formats)
group_idstringOptional group identifier for batch organization
is_flashbooleanDefines whether the message will be sent via Flash.

📱 Phone Number Format

The API accepts Brazilian phone numbers in multiple formats:

National Format:

  • São Paulo: "11999999999"
  • Rio de Janeiro: "21999999999"
  • Brasília: "61999999999"
  • Belo Horizonte: "31999999999"

International Format:

  • São Paulo: "+5511999999999"
  • Rio de Janeiro: "+5521999999999"
  • Brasília: "+5561999999999"

DDI Format:

  • São Paulo: "5511999999999"
  • Rio de Janeiro: "5521999999999"
  • Brasília: "5561999999999"

Recommendation: While all formats are accepted, the national 11-digit format is recommended for best compatibility.


⚡ Processing & Delivery

  • Asynchronous Processing: SMS messages are queued for delivery
  • Response Code: 202 Accepted indicates successful queuing
  • Delivery Time: Usually within minutes, depending on carrier
  • Character Limit: Standard SMS length limits apply (160 characters per message)

🚀 Best Practices

  1. Clear Messages: Keep SMS content concise and actionable
  2. Organize with Groups: Use group_id to categorize related campaigns
  3. Test First: Send to a small group before scaling up
  4. Timing Matters: Consider Brazilian business hours for better engagement
  5. Descriptive Titles: Use clear campaign titles for easy identification

🚫 SMS Flash Restrictions

SMS Flash messages do not allow sending links (URLs) in the message content.


🛠️ Troubleshooting

IssueSolution
Invalid phone formatEnsure valid Brazilian phone number format (11 digits or with DDI)
Authentication errorVerify api-token and app-id headers
Message too longKeep within SMS character limits
Empty phones arrayInclude at least one valid phone number

📈 SMS Campaign Ideas

E-commerce

  • Order confirmations
  • Shipping updates
  • Promotional offers
  • Abandoned cart reminders

Healthcare

  • Appointment reminders
  • Medication alerts
  • Health tips
  • Test results notifications

Education

  • Class schedules
  • Important announcements
  • Grade notifications
  • Event reminders

Retail

  • Store promotions
  • New product launches
  • Seasonal campaigns
  • Customer surveys

🔐 Security & Compliance

  • Data Protection: Ensure compliance with Brazilian data protection laws (LGPD)
  • Opt-in Required: Only send SMS to customers who have consented
  • Rate Limits: Respect API rate limits to avoid blocking
  • Content Guidelines: Avoid spam-like content that could be filtered

📞 Support

Need help with SMS integration? Contact our support team through the LigueLead Client Area.