Chat Bridge API | Chat Bridge

Chat Bridge is the omnichannel messaging platform by Voices. Its public API lets you integrate the platform’s communication services into your own applications through an HTTP REST interface. All requests are authenticated with an App-Key and use JSON as the data exchange format.

Available channels

Blaster

Automated phone calls with text-to-speech (TTS) or pre-recorded audio, outbound routes, audio upload, and webhook notifications.

Send text, media, interactive, and template messages; manage templates and accounts; and receive webhook notifications.

RCS

Send rich messages (text, rich cards, carousels) from RCS agents using templates, and receive delivery statuses, clicks, and replies through webhooks.

SMS

Send transactional and bulk SMS from the masks (senders) enabled for your account, append trackable short links, and receive delivery statuses through webhooks.

OMIA

Conversational AI phone calls: query the agents and dial types available for your account, originate calls with agent variables, and receive call results through webhooks.

Coming soon

The following channels are part of the platform and will be added to this documentation soon:

Email delivery. Coming soon.

Getting started

To use the API you need an App-Key, which you can request from the Chat Bridge team. The App-Key comes preconfigured with the account and channel it is enabled for, so you don’t need to specify them on each request.

Include it in the x-api-key header of every request:

$ curl https://connect.chatbridge.mx/v1/whatsapp/accounts \
>   -H "x-api-key: YOUR_APP_KEY"

A single App-Key enables one channel. If you need to operate both Blaster and WhatsApp, request one App-Key per channel.

Authentication

Every request requires the x-api-key header. The following scenarios produce an authentication or authorization error. The Message column shows the literal string returned by the API:

Scenario	HTTP	Message
No `x-api-key` sent	`401`	Token de autenticación requerido
The `x-api-key` does not exist or is incorrect	`401`	App-key inválida
The App-Key is disabled	`401`	App-key inactiva
The App-Key has no access to the requested channel	`403`	Esta app-key no tiene acceso a este canal

Rate limiting

If your App-Key has a configured limit, a 60-second window applies. When exceeded, the API responds with status 429:

1 {
2   "statusCode": 429,
3   "error": "Too Many Requests",
4   "message": "Has superado el límite de requests permitidos por minuto",
5   "errorCode": 300
6 }

Error format

Every error follows the same structure:

1 {
2   "statusCode": 400,
3   "error": "Bad Request",
4   "message": "Descripción del problema",
5   "errorCode": 301
6 }

Field	Type	Description
`statusCode`	number	HTTP status code.
`error`	string	HTTP error type.
`message`	string	Human-readable description of the problem.
`errorCode`	number	Internal code, useful when reporting to support.
`metadata`	object	Additional information (optional).

Support

For questions or to report an issue, contact the Chat Bridge team and include the errorCode shown in the error response.