Documentation
Sign inGet started

bird lookup phone-number

Usage

Code example
bird lookup phone-number [flags]

Description

Create a phone number lookup
Create a lookup for a phone number's networks, porting state, country, and line type. Pass type to request separately billed classification, porting, presence, roaming, sim_swap, or score blocks. Each block reports its own status, and only blocks with an ok status add a charge; the lookup does not contact the number.
Build the request from flags, a JSON PhoneNumberLookupRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example
# print the body shape (no credentials needed)
bird lookup phone-number --example

# the body it prints:
Code example
{
  "phone_number": "+31612345678",
  "type": ["classification", "presence"]
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--phone-numberThe phone number to look up, in international format: the country calling code, then the national number. The leading + is optional, and 00 works in its place, so +31612345678, 31612345678 and 0031612345678 are all the same number. A number written for dialling inside one country, with no country code, is rejected rather than guessed at.
--type <v1,v2,…>Properties to add to the base lookup. Omit this field or send an empty array to request only the base lookup. Each delivered property is billed in addition to the base lookup. A property that could not be answered is returned with its status and is not billed. Possible values: classification, porting, presence, roaming, sim_swap, score.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird lookup emailCreate an email address lookup