Glossary
The terms this documentation uses, explained in plain language.
- API key
- Secret credential that identifies your organization on every request. It goes in the
Authorization:header and starts withBearer hk_. You create it in Cloud. - bind
- Session opened with the SMPP server. It can send (transmitter), receive (receiver) or both (transceiver).
- capability
- Permission over the account granted to an API key when it is created, apart from the services, for example
directoryto read the organization data. - cost center
- Unit of your organization that usage is attributed to. Every API key is bound to one. It is the same term Cloud uses.
- delivery receipt (DLR)
- Notice with the final status we know for your message. It does not guarantee that the message was read on the phone.
- envelope
- Common JSON structure of every API v6 response:
success,dataorerror, andmetawith therequestId. - inbound SMS
- Message that a person sends to your short code. It reaches you by webhook with the
sms.event.mo. <short code> - Number Lookup
- Service that looks up data about a phone number. This is its public name; the API route is still
/, because the route is part of the contract and does not change.numberinsight - rate limit
- Maximum number of requests you can make in a time window. When you exceed it, the API responds 429 and tells you when to retry.
- retention
- Time during which data is kept before it is deleted.
- short code
- Short number assigned to your organization that people send SMS to. In the inbound SMS webhook it arrives in the
shortCodefield. - signing secret
- Secret that starts with
whsec_and lets you verify that Hablame sent a webhook. Never share it or put it in browser code. - spending limit
- Maximum usage amount that your own organization sets. Once it is reached, operations that are charged are rejected without being carried out.
system_id- Username of your SMPP account. Support gives it to you along with the password, which you must never share.Written the same in both languages. It is a protocol or contract name.
- URL Shortener
- Service that creates short links that redirect to a destination URL and counts their visits.
- webhook endpoint
- HTTPS URL in your system that receives the events. Until Cloud has a screen for it, the Hablame team registers it on request.