Look Up Number
messagebird.lookup_number
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Validate a phone number and read back its country, its type and its E.164, international, national and RFC3966 formats.
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 to look up, in international format unless a country_code is given. MessageBird wants plain digits, so 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
| Field | Type | Example |
|---|---|---|
href URL of the lookup object on MessageBird. | string | — |
countryCode Two-letter country code the number belongs to. | string | — |
countryPrefix International dialling prefix for that country. | number | — |
phoneNumber The number as MessageBird parsed it. | number | — |
type What kind of line it is, such as mobile, fixed line or voip. | string | — |
formats The number rendered as e164, international, national and rfc3966. | object | — |
hlr The most recent HLR result for this number, or null when none has been requested. | object | — |
{
"countryCode": "",
"countryPrefix": 0,
"formats": {},
"hlr": {},
"href": "",
"phoneNumber": 0,
"type": ""
}See Look Up Number 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.