Back to Docs

LiveChat API

Real-time customer support and messaging

Real-time

Instant messaging

Multi-agent

Team collaboration

Webhooks

Event notifications

History

Full transcripts

Dual-Key Authentication

API KeyPermanent

X-Smsly-Key-Id: sk_live_xxx

SDK KeyRotatable

X-SMSLY-SDK-KEY: sdk_live_xxx

Quick Start

Python
from smsly import SMSly

# === DUAL KEY SECURITY ===
# Two keys required (both can be in .env or embedded):
# 1. API Key - for authentication
# 2. SDK Key - for SDK validation

client = SMSly(
    api_key="setup_api_your_key",   # From dashboard
    sdk_key="setup_sdk_your_key"    # From dashboard
)

# Create a conversation
conversation = client.livechat.create_conversation(
    visitor_id="visitor_123",
    visitor_name="John Doe",
    metadata={"page_url": "https://yoursite.com/pricing"}
)

# Send a message
client.livechat.send_message(
    conversation_id=conversation.id,
    message="Hello! How can I help you today?",
    sender_type="agent"
)

# Get conversation history
messages = client.livechat.get_messages(conversation.id)
for msg in messages:
    print(f"{msg.sender}: {msg.text}")

# Update agent status
client.livechat.set_agent_status("agent_123", "online")

# Close conversation
client.livechat.close_conversation(conversation.id)

API Endpoints

POST/v1/livechat/conversationsCreate conversation
POST/v1/livechat/messagesSend message
GET/v1/livechat/conversations/:idGet conversation
GET/v1/livechat/conversations/:id/messagesGet messages
POST/v1/livechat/conversations/:id/closeClose conversation
POST/v1/livechat/agents/:id/statusUpdate agent status

Ready to add live chat?

Get API Keys