API Documentation

Integrate any SMS platform or application with vChats using our high-performance REST APIs.

Base URL: https://vchats.site/api/v1/

Endpoints overview

Method Endpoint Description Docs
POST /api/v1/numbers/ Provision & rent a virtual number with automatic wallet deduction View docs →
GET /api/v1/numbers/ List active rented numbers provisioned for your account View docs →
GET / POST /api/v1/numbers/validate/ Check if a number is valid (already rented by a user) View docs →
POST /api/v1/messages/ Deliver incoming SMS to a rented number's inbox View docs →

Quick start

  1. Create an account at vChats and complete KYC
  2. Open the Developer Console to create a platform and generate an API key
  3. Top up your wallet balance to cover number rentals
  4. Rent numbers programmatically via POST https://vchats.site/api/v1/numbers/ with country and rental period
  5. Validate active numbers via https://vchats.site/api/v1/numbers/validate/
  6. Configure your SMS provider's webhook to POST messages to https://vchats.site/api/v1/messages/

Authentication

All API requests require an API key sent in the Authorization header:

HTTP Header
Authorization: Bearer vn_live_<your_api_key>

Errors

Status Meaning
201Message delivered to inbox
200Duplicate external_message_id — idempotent
400Invalid request payload
401Missing or invalid API key
403Platform is inactive
404Number not found or no active rental
429Rate limit exceeded

Rate limits

The default is 60 requests/minute. When exceeded, the API returns 429 Too Many Requests.