Welcome to Pealchat Live Chat Service
At Pealchat, we understand the importance of delivering exceptional customer service. That’s why we’ve partnered with a powerful live chat solution, similar to Tawk.to, to help you connect with your customers instantly, provide timely support, and enhance their overall experience.
Get Started Today!
Ready to improve your customer service and increase conversions? It’s easy to get started with our live chat service. Simply sign up, integrate the widget, and start chatting with your customers in real time.
customers
happy customers
Deployment
What is Our Live Chat Service?
Our live chat service offers a seamless way for your customers to reach out to you, ask questions, and get the help they need right when they need it. With real-time messaging, you can engage with visitors on your website, offer assistance, and guide them through their buying journey without delay. Say goodbye to long wait times and missed opportunities – with live chat, help is always just a click away!
Choose Pealchat
Why Choose Our Live Chat Service?
With this API, you can enhance your website’s customer support system, deliver real-time communication, and improve user engagement. Start integrating today!
How It Works
Install the Chat Widget
Add our live chat widget to your website with just a few clicks.
Connect with Customers:
Visitors will be able to initiate a conversation with you directly through the chat window.
Respond Instantly:
Engage with customers in real time, answer questions, solve problems, and provide guidance
Review Analytics
Track chat performance, visitor engagement, and customer satisfaction to continuously improve your service.
API Documentation for Pealchat Live Chat Service
Welcome to the Pealchat Live Chat Service API documentation. This API allows you to integrate our live chat solution with your website or application seamlessly. You can use our API to send and receive messages, track user sessions, and customize chat behavior to suit your business needs.
Base URL:
Authentication
To use our API, you will need an API Key. This key authenticates your requests.
Obtain Your API Key:
1. Log in to your Pealchat account.
2. Navigate to the API Settings section.
3. Generate and copy your API key.
1. Create a New Chat Session
Endpoints
Create a New Chat Session
Endpoint: POST /sessions
Description: Starts a new chat session with a visitor.
Request Body:
{
"visitor_name": "John Doe",
"visitor_email": "john.doe@example.com",
"source": "website",
"custom_data": {
"user_type": "prospective",
"referrer": "google.com"
}
}
Response:
{
"session_id": "12345",
"status": "active",
"visitor_name": "John Doe",
"created_at": "2025-03-24T12:00:00Z"
}
2. Send a Message
Description: Sends a message to a visitor within an active chat session.
Request Body:
{
"session_id": "12345",
"sender": "agent",
"message": "Hello! How can I assist you today?"
}
Response:
{
"message_id": "67890",
"session_id": "12345",
"sender": "agent",
"message": "Hello! How can I assist you today?",
"timestamp": "2025-03-24T12:05:00Z"
}
3. Get Messages in a Session
Description: Retrieves all messages for a specific chat session.
Response:
{
"session_id": "12345",
"messages": [
{
"message_id": "67890",
"sender": "agent",
"message": "Hello! How can I assist you today?",
"timestamp": "2025-03-24T12:05:00Z"
},
{
"message_id": "67891",
"sender": "visitor",
"message": "I have a question about your product.",
"timestamp": "2025-03-24T12:06:00Z"
}
]
}
4. Close a Session
Description: Ends the chat session.
Response:
{
"session_id": "12345",
"status": "closed",
"closed_at": "2025-03-24T12:15:00Z"
}
5. Get Session Details
Description: Fetches details of a specific chat session.
Response:
{
"session_id": "12345",
"status": "closed",
"visitor_name": "John Doe",
"created_at": "2025-03-24T12:00:00Z",
"closed_at": "2025-03-24T12:15:00Z",
"messages": [
{
"sender": "agent",
"message": "Hello! How can I assist you today?",
"timestamp": "2025-03-24T12:05:00Z"
}
]
}
6. Get Active Sessions
Description: Retrieves a list of all active chat sessions.
Response:
{
"sessions": [
{
"session_id": "12345",
"status": "active",
"visitor_name": "John Doe",
"created_at": "2025-03-24T12:00:00Z"
}
]
}
Webhooks
To keep your application in sync with live events (such as new messages or session closures), you can subscribe to our webhooks.
Webhook URL: https://your-application.com/webhook
Event Types:
- session_started: Triggered when a new chat session begins.
- message_sent: Triggered when a new message is sent in a session.
- session_closed: Triggered when a session is closed.
Example Webhook Payload:
{
“event”: “message_sent”,
“data”: {
“session_id”: “12345”,
“sender”: “agent”,
“message”: “How can I assist you?”,
“timestamp”: “2025-03-24T12:05:00Z”
}
}
Error Codes
Here are some common error responses you might encounter:
- 400 Bad Request: The request is malformed or missing required parameters.
- 401 Unauthorized: API key is invalid or not provided.
- 404 Not Found: The requested resource could not be found.
- 500 Internal Server Error: Something went wrong on our end.
Example Error Response:
{
“error”: “Invalid API Key”,
“status_code”: 401
}