Skip to main content

​
Chat API

​
Overview

Chat API provides a comprehensive suite of endpoints for managing customer interactions, user profiles, messaging, and integrated services. This documentation provides details on all available endpoints, request parameters, and response formats.

​
Base URL

All API endpoints are accessible at the following base URL: 
https://1-some-client.some-server.healvi-chat/third-party/v1

​
Authentication

All API endpoints require authentication using Bearer tokens. Include the token in the Authorization header of your requests: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
API Structure

The Chat API is organized into the following logical groups:

Support

System information and configuration

Auth

User authentication and login management

Users

User management and permissions

Settings

System configuration and preferences

Agents

Agent management and capabilities

Customers

Customer data and relationship management

Profiles

User profile management and activities

Tags

Content categorization and tagging

Files

File upload and management

Templates

Message template management

Marketing

WhatsApp marketing tools and QR codes

Ratings

Customer rating and feedback system

Conversations

Chat conversation management and notes

Messages

Send, receive, and manage messages

Search

Content search and discovery tools

Whatsapp

WhatsApp Business API integration

Metrics

Analytics and performance reporting

Deletion logs

Data deletion tracking and logs
Each section of the documentation provides detailed information about the endpoints within these groups, including parameters, request examples, and response formats.