Skip to content

Add documentation: Provide Example Requests and Responses for Each Endpoint #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

quantstruct-dev-sarthak[bot]
Copy link

API Reference: Example Requests and Responses

This document provides example requests and responses for various API endpoints to help developers understand how to use the API and what to expect in return. These examples are designed to reduce integration time and improve overall developer experience.

Messages Endpoints

POST /messages/individual/{accountId}/send

Description: Send a message to an individual.

Parameters:

  • accountId (path): Your account ID.
  • x-api-key (header): Your API key.
  • x-api-secret (header): Your API secret.

Request Body:

{
  "content": "Hello, how are you?",
  "attachment_uri": "https://example.com/image.jpg",
  "from": "61421868490",
  "to": "61433174782",
  "service": "whatsapp"
}

Example Request (cURL):

curl -X POST \
  'https://api.example.com/v1/messages/individual/your_account_id/send' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: your_api_key' \
  -H 'x-api-secret: your_api_s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants