Overview - Eazybe

Use this endpoint to send one supported free-form message to one recipient. Set type to choose the content format and include the fields required for that type.

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'

Message types

Text Message

Open the request fields and example for this message type.

Image Message

Open the request fields and example for this message type.

Document Message

Open the request fields and example for this message type.

Audio Message

Open the request fields and example for this message type.

Video Message

Open the request fields and example for this message type.

Sticker Message

Open the request fields and example for this message type.

Location Message

Open the request fields and example for this message type.

Interactive Message

Open the request fields and example for this message type.

Successful response

All eight content types use the same success envelope.

{
  "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 the selected type’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 total list rows are outside 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

This endpoint queues one message per request. For an approved template sent to multiple recipients, use Send a Template Broadcast.