API Documentation

Integrate any SMS platform with vChats using a single webhook endpoint.

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

Quick start

  1. Create an account at vChats and verify your email
  2. Open the Developer Console to create a platform and generate an API key
  3. Configure your SMS provider's webhook to POST to https://vchats.site/api/v1/messages/
  4. Rent a phone number and start receiving SMS in your inbox

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.