API reference

A summary of the REST API surface. Base URL, authentication and conventions first, then the endpoints.

Base URL

     https  :  //api.whatsyncs.com/v1   

Conventions

• Authentication — bearer token in the Authorization header on every request.
• Content type — application/json for request and response bodies.
• Pagination — cursor based, using limit and a cursor returned in the response.
• Errors — a machine-readable code with a human-readable message.
• Idempotency — write requests accept an idempotency key so retries are safe.

Endpoints

• POST /messages Send a message from a connected number
• GET /messages List synchronized messages
• GET /conversations List conversations across connections
• GET /conversations/:id Fetch one conversation with its messages
• GET /media/:id Media metadata for a synchronized file
• GET /media/:id/download Download the file itself
• GET /connections List connections and their health
• GET /connections/:id Inspect one connection
• POST /webhooks Register a webhook endpoint
• GET /webhooks/deliveries Inspect recent delivery attempts

Messages

     curl     https://api.whatsyncs.com/v1/messages     \          -H     "Authorization: Bearer YOUR_API_KEY"     \          -H     "Content-Type: application/json"     \          -d   '  {            "connection"  :     "sales"  ,            "to"  :     "971500000000"  ,            "text"  :     "Hello from WhatSyncs"          }  '   

Conversations

     curl     "https://api.whatsyncs.com/v1/conversations?connection=sales&limit=25"     \          -H     "Authorization: Bearer YOUR_API_KEY"   

Media

     curl     "https://api.whatsyncs.com/v1/media/med_01H9X2K7Q4/download"     \          -H     "Authorization: Bearer YOUR_API_KEY"     \          -o   villa-17-brochure.pdf   

Connections

     curl     https://api.whatsyncs.com/v1/connections     \          -H     "Authorization: Bearer YOUR_API_KEY"