Skip to content

OpenAPI

The OpenAPI 3.1 specification of the Hablame API v6. Use it to generate a client in your language, import the API into your testing tool or review the whole contract in a single file.

Download

The Spanish and English files describe exactly the same thing; only the descriptions change.

What it includes

  • The 22 published endpoints of the Reference, with their parameters, bodies, response examples and possible errors.
  • A single server: https://developers.hablame.co. Everything you run against it is real and can be charged.
  • Authentication with your API key as a Bearer token. The key never goes inside the file.
  • What each operation does when you run it, in the x-hablame-efecto extension (ninguno, consulta-facturable, crea, modifica, borra, envia, llama), and whether the call is charged, in x-hablame-cobra.
  • The usage limit and the key each operation requires, in x-limit and x-access.
  • The notices (webhooks) Hablame sends to your server, starting with the inbound SMS (sms.mo).

How to use it

  1. Download it with the button above or from the terminal: curl -O https://developers.hablame.co/openapi.en.json.
  2. Import it as a file into the API testing tool or OpenAPI viewer you use.
  3. To generate a client, give it to the generator for your language (for example openapi-generator, oapi-codegen or NSwag) and review the generated code before taking it to production.

Always up to date

This file is generated from the same catalog as the Reference every time the site is published. If an endpoint changes, the file changes with it: there is no separate copy that can go stale.

See the API changelog · If you prefer Postman, go to the collection

If anything in the file does not match what you see when you run a call, write to us at developers@hablame.co with the endpoint and the request identifier (requestId).

Need help?

Was this page helpful?

See all support channels