Get HLR
messagebird.get_hlr
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Read the most recent HLR result for a number: its status, the operator holding it, and whether it is roaming or ported.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- MessageBird
- Secret shape
- the access key, or {"access_key": "…"}
- Config it needs
- originator, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
phone_number The number whose HLR result you want to read, in international format. A leading + and any spaces are stripped before the call. | string | Yes | — | — | 31612345678 |
country_code Two-letter country code, required only when the number is in national format. | string | No | — | ≤ 2 characters | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"phone_number": "31612345678"
}Output
One shape.
result
The provider's response object, as returned.
Extra keys beyond the ones listed can appear.
{}See Get HLR run in a workflow.
In a technical demo we add the MessageBird connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.