Skip to main content

​
API Overview

The LivChat.ai API is organized around REST. It uses predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

​
Base URL

https://api.livchat.ai/v1

​
Authentication

All requests require a Bearer token: 
Authorization: Bearer lc_live_YOUR_API_KEY

​
Endpoints Overview

​
Messages

Send WhatsApp messages in various formats.
EndpointMethodDescription
/v1/messages/sendPOSTSend text message
/v1/messages/send/imagePOSTSend image
/v1/messages/send/documentPOSTSend document
/v1/messages/send/audioPOSTSend audio
/v1/messages/send/videoPOSTSend video
/v1/messages/send/locationPOSTSend location
/v1/messages/send/contactPOSTSend contact card
/v1/messages/send/stickerPOSTSend sticker
/v1/messages/reactPOSTReact to message
/v1/messages/readPOSTMark as read

​
Contacts

Manage and verify contacts.
EndpointMethodDescription
/v1/contacts/checkPOSTCheck if numbers have WhatsApp
/v1/contacts/infoPOSTGet contact information
/v1/contacts/avatarGETGet contact avatar
/v1/contacts/listGETList all contacts

​
Session

Manage WhatsApp connection.
EndpointMethodDescription
/v1/session/statusGETGet session status
/v1/session/qrGETGet QR code for pairing
/v1/session/connectPOSTConnect session
/v1/session/disconnectPOSTDisconnect session
/v1/session/logoutPOSTLogout from WhatsApp

​
Groups

Manage WhatsApp groups.
EndpointMethodDescription
/v1/groups/listGETList all groups
/v1/groups/infoGETGet group information
/v1/groups/createPOSTCreate new group
/v1/groups/invite-linkGETGet group invite link

​
Webhooks

Receive real-time events.
EndpointMethodDescription
/v1/webhookGETGet webhook configuration
/v1/webhookPOSTConfigure webhook URL

​
Response Format

​
Success Response

{
  "success": true,
  "code": 200,
  "data": {
    // Response payload
  }
}

​
Error Response

{
  "error": {
    "code": 400,
    "message": "Description of the error"
  }
}

​
HTTP Status Codes

CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Endpoint doesn’t exist
429Rate Limited - Too many requests
500Server Error - Something went wrong

​
Phone Number Format

Phone numbers should be in international format without + or spaces: 
5511999999999  # Brazil: +55 11 99999-9999
14155551234    # USA: +1 415 555 1234

​
JID Format

WhatsApp JIDs (Jabber IDs) are used internally: 
5511999999999@s.whatsapp.net  # Individual
120363123456789@g.us          # Group