API Reference

Build powerful integrations with YupServe's WhatsApp and AI Voice infrastructure.

API Overview

YupServe provides robust, developer-friendly APIs designed to help you integrate WhatsApp chatbots and AI-driven voice assistants into your existing workflows. Our RESTful architecture ensures seamless communication between your platform and our AI infrastructure.

Base URL

https://api.yupserve.com/v1

Authentication

All API requests must be authenticated using an API Key. You can generate and manage your keys within the YupServe Dashboard.

Example Header

Authorization: Bearer YOUR_API_KEY

Security Best Practice

Never expose your API keys in client-side code. Always perform API calls from your secure backend server.

Webhooks

Receive real-time notifications about events happening on the YupServe platform. Configure your webhook URL in the dashboard to start receiving POST requests.

message.received

Triggered when a new WhatsApp message is received.

call.started

Triggered when an AI voice call begins.

call.ended

Triggered when a call finishes, includes transcript link.

subscription.updated

Triggered on plan changes or billing events.

WhatsApp APIs

Programmatically send messages, manage templates, and automate customer interactions via WhatsApp.

POST /messages/send

{
  "to": "919876543210",
  "type": "text",
  "content": "Hello from YupServe API!"
}

Send text, image, and document messages
Manage WhatsApp Business templates
Retrieve message delivery and read status

Voice APIs

Integrate AI voice capabilities to handle inbound calls and trigger outbound AI-driven conversations.

POST /calls/initiate

{
  "to": "+1234567890",
  "voice_id": "professional_female_01",
  "prompt": "Remind the client about their appointment tomorrow at 10 AM."
}

Interactive IVR Flows

Dynamically build call menus and handle user input through the API.

Real-time Transcripts

Access live call transcriptions as the conversation unfolds.

Rate Limits

To ensure platform stability and fair usage for all developers, YupServe implements the following rate limits based on your subscription tier:

Plan	Requests per Minute
Starter	60 RPM
Professional	300 RPM
Enterprise	Custom Limits

Error Handling

YupServe uses standard HTTP response codes to indicate the success or failure of an API request.

200

Request was successful.

400

Bad Request

Missing parameters or invalid JSON.

401

Unauthorized

Invalid or missing API key.

429

Too Many Requests

Rate limit exceeded.

500

Server Error

Internal server issue.

Developer Support

Stuck with an integration? Our engineering team is here to help.

labs@yupserve.com

YupServe Labs Private Limited

CIN: U72900OR2018PTC029068

Website: yupserve.com