Chat Bridge API

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

Coming soon

The following channels are part of the platform and will be added to this documentation 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"

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:

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
}

Support

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