Use Chatly API From A User Account

What Can A User Use The API For?

A user can use the API to operate their own Chatly workspace from another system. The API is scoped by user API key and JWT user token, so user data is separated by the logged-in user/client staff account.

Base URL

Use this base URL for user API requests:

https://vueping.com/auth/api

If your app is configured with language prefixes, this may also work:

https://vueping.com/auth/en/api

User Authentication

Step 1: Copy User API Key

Go to Client Panel -> API and copy the API Key. Send it in every API request as:

apikey: YOUR_USER_API_KEY

Step 2: Login To Get JWT Token

Use user/client-staff email and password. The login response contains the JWT token used for protected user APIs.

curl -X POST "https://vueping.com/auth/api/login" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -F "email=user@example.com" \
  -F "password=your-password"

Step 3: Use Bearer Token

Authorization: Bearer YOUR_JWT_TOKEN

How To Use These Examples

Words You Must Replace

Recommended Testing Tool

1. Open Postman or any API testing tool.
2. Paste the URL, for example https://vueping.com/auth/api/login.
3. Add header apikey with your API key.
4. Add form fields shown in the example.
5. Click Send.

First API Test

After login, test the user profile endpoint:

curl -X GET "https://vueping.com/auth/api/profile" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

If it returns user account data, authentication is working.

User Contacts

List Contacts

Use this to check whether your contact already exists or to find a CONTACT_ID.

curl -X GET "https://vueping.com/auth/api/whatsapp-contact" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Create Contact

Required fields from this installation: phone, country_id. Phone must be numeric and at least 11 digits.

1. Replace John Customer with the customer's name.
2. Replace 919999999999 with the customer's WhatsApp number including country code.
3. Use country_id=101 for India.

curl -X POST "https://vueping.com/auth/api/whatsapp-contact-store" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "name=John Customer" \
  -F "phone=919999999999" \
  -F "country_id=101"

Contact Lists

Use contact lists to group customers, for example Hot Leads, Paid Customers, or May Campaign.

User Messaging

Send Text Message

Required: receiver_id and one of message, image, or document.

1. First call /api/whatsapp-contact and copy the contact id.
2. Put that ID in receiver_id.
3. Type your message in the message field.

curl -X POST "https://vueping.com/auth/api/send-message" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "receiver_id=CONTACT_ID" \
  -F "message=Hello from user API"

Send Image Or Document

Use this for sending a bill, brochure, product image, report, or other file.

curl -X POST "https://vueping.com/auth/api/send-message" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "receiver_id=CONTACT_ID" \
  -F "image=@/local/path/image.jpg"

Send Approved WhatsApp Template

Required: template_id, contact_id. Optional arrays: body_values, button_values. Optional media: image, document, video, audio.

Use this when WhatsApp requires an approved template, like marketing, utility, or authentication messages.

curl -X POST "https://vueping.com/auth/api/whatsapp/send-template" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "template_id=TEMPLATE_ID" \
  -F "contact_id=CONTACT_ID"

User Campaigns

WhatsApp Campaign

Required fields for create: campaign_name, template_id, contact_list_id, segment_id. If send_scheduled=1, also send schedule_time.

1. Create or choose a contact list in Chatly.
2. Create or choose a segment.
3. Choose an approved WhatsApp template.
4. Use their IDs in the API request.

curl -X POST "https://vueping.com/auth/api/whatsapp-campaign-store" \
  -H "Accept: application/json" \
  -H "apikey: YOUR_USER_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -F "campaign_name=May Offer" \
  -F "template_id=1" \
  -F "contact_list_id=1" \
  -F "segment_id=1"

Telegram Campaign

Use this if the user has connected Telegram and wants to manage Telegram campaigns through API.

User Inbox And Chat

Tickets, Team, Notes, Tags

Tickets

Create user support tickets from an external client portal.

Team

Use team APIs to create staff accounts for the user's workspace.

Notes And Tags

Use notes and tags to mark contacts, like Interested, Follow Up, VIP, or Issue Open.

Webhook Automation

Where To Set It

Go to Client Dashboard -> Webhook, or open https://vueping.com/auth/client/webhook after login. Enter your webhook URL, choose events, enable webhook, and save.

Available Events

How To Test Without Coding

1. Open Client Dashboard -> Webhook.
2. Paste a webhook URL from Zapier, Make, Pabbly, webhook.site, your CRM, or your own website.
3. Select Test webhook and any other events you want.
4. Switch on Enable Webhook and save.
5. Click Send Test Webhook. If the other app receives data, your webhook is working.

Payload Example

{
  "event": "contact.created",
  "client_id": 1,
  "created_at": "2026-05-14T10:00:00+05:30",
  "data": {
    "name": "John Customer",
    "phone": "919999999999",
    "source": "api"
  }
}

If you add a secret, Chatly sends X-Chatly-Signature so your app can verify the webhook came from Chatly. Keep this secret private, like a password.

Good Automation Examples

Response Format And Errors

Most successful user API responses:

{
  "success": true,
  "message": "data_retrieved_successfully",
  "data": {}
}

Most error responses:

{
  "success": false,
  "message": "validation_failed",
  "data": {
    "field": ["Error message"]
  }
}