Document Message - Eazybe

Send a supported document with an optional name and caption.

Endpoint

POST /broadcast/public/send-freeform

Rate limit: 20 requests per minute for each API key and fromPhoneNumber combination.

Common fields

Field	Type	Required	Description
`fromPhoneNumber`	string	Required	A sender from Get Phone Numbers, using digits only
`toPhoneNumber`	string	Required	The recipient’s complete international number, including country code and using digits only
`type`	string	Required	`text`, `image`, `document`, `audio`, `video`, `sticker`, `location`, or `interactive`

Every request uses the same headers and endpoint. Replace PAYLOAD with one of the JSON bodies in the sections below.

curl -X POST "https://cerberus.eazybe.com/prod/api/v2/broadcast/public/send-freeform" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d 'PAYLOAD'

Example payload

Set type to document and provide a public url. You can also set the displayed name and a caption. Accepted extensions: pdf, txt, doc, docx, ppt, pptx, xls, xlsx

{
  "fromPhoneNumber": "14844634680",
  "toPhoneNumber": "919675360316",
  "type": "document",
  "url": "https://cdn.example.com/invoice-4821.pdf",
  "name": "Invoice_4821.pdf",
  "caption": "Your invoice is ready"
}

Successful response

The endpoint returns the same success envelope for this content type.

{
  "status": true,
  "status_code": 200,
  "message": "Free-form message queued successfully",
  "data": {}
}

Errors

Status	Cause	What to check
`400`	A common or type-specific field is invalid	Check this page’s required fields
`400`	A media URL or extension is unsupported	Use `http` or `https` and an accepted path extension
`400`	Coordinates, button count, or list rows exceed their limits	Correct the payload limits
`401`	The key or sender does not belong to the organization	Use a sender returned for the same key
`429`	More than 20 requests in the current window	Wait for the interval in the response
`500` or `503`	Transient service failure	Retry with exponential backoff