API Introduction ​

Welcome to the AvenPing API! Our REST API allows you to integrate WhatsApp Business messaging into your applications and workflows.

Base URL ​

https://api.avenping.com/v1

Authentication ​

All API requests require authentication using an API key. Include your API key in the request headers:

http
Authorization: Bearer YOUR_API_KEY

WARNING

Keep your API key secure and never expose it in client-side code.

Rate Limits ​

  • 1000 requests per minute for premium user
  • Rate limit headers included in all responses

Response Format ​

All API responses are in JSON format:

json
{
  "success": true,
  "data": {
    // Response data
  },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}

Error Responses ​

json
{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is invalid",
    "details": "Phone number is required"
  }
}

Available Endpoints ​

Messages ​

  • POST /messages/send - Send a message
  • GET /messages/{id} - Get message status
  • GET /messages - List messages

Contacts ​

  • POST /contacts - Create a contact
  • GET /contacts - List contacts
  • PUT /contacts/{id} - Update contact
  • DELETE /contacts/{id} - Delete contact

Campaigns ​

  • POST /campaigns - Create campaign
  • GET /campaigns - List campaigns
  • POST /campaigns/{id}/send - Send campaign

Webhooks ​

  • POST /webhooks - Create webhook
  • GET /webhooks - List webhooks
  • DELETE /webhooks/{id} - Delete webhook

Quick Start ​

  1. Get your API key from your dashboard
  2. Send your first message via API
  3. Set up webhooks for real-time events
  4. Explore rate limits for optimal usage

SDKs and Libraries ​

  • Node.js - npm install avenping-sdk
  • Python - pip install avenping
  • PHP - composer require avenping/sdk
  • Java - Maven/Gradle support

Postman Collection ​

Download our Postman collection to test all endpoints quickly.

Next: Authentication Setup →