HLR Lookup
seven.lookup_hlr
ActionVoice & SMSconnection required
Calls the seven.io API with the connection's credentials.
Query the home location register to see whether a number is live and reachable.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- seven.io
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- sender, account_id, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 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 |
|---|---|---|---|---|---|
number The phone number to look up, in international format. | string | Yes | — | — | +4917612345678 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"number": "+4917612345678"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
status seven.io's status flag for the HLR query. | any | — |
status_message What that status means, in English. | string | — |
lookup_outcome Whether the register answered the query. | any | — |
lookup_outcome_message What that outcome means, in English. | string | — |
international_format_number The number in E.164 form. | string | — |
national_format_number The number in its national format. | string | — |
country_code The number's country as an ISO code. | string | — |
country_name The number's country, in English. | string | — |
country_prefix The dialling prefix of that country. | string | — |
current_carrier The carrier currently serving the number. | object | — |
original_carrier The carrier the number was issued by. | object | — |
valid_number Whether the number is a valid subscriber number. | any | — |
reachable Whether the handset is currently reachable. | any | — |
ported Whether the number was ported to another carrier. | any | — |
roaming Whether the handset is roaming on another network. | any | — |
gsm_code The GSM result code for the query. | any | — |
gsm_message What that GSM code means, in English. | string | — |
{
"country_code": "",
"country_name": "",
"country_prefix": "",
"current_carrier": {},
"gsm_code": null,
"gsm_message": "",
"international_format_number": "",
"lookup_outcome": null,
"lookup_outcome_message": "",
"national_format_number": "",
"original_carrier": {},
"ported": null,
"reachable": null,
"roaming": null,
"status": null,
"status_message": "",
"valid_number": null
}See HLR Lookup run in a workflow.
In a technical demo we add the seven.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.