Look up a phone number by URL
GET
/v1/lookup/phone-number/{number}
curl -X GET "https://us1.platform.bird.com/v1/lookup/phone-number/{number}" \
-H "Authorization: Bearer $TOKEN"The same lookup as Look up a phone number, with the number in the URL instead of the body.
Returns what we know about the number: which network serves it, which network issued it, whether it has been ported, its country, and what kind of line it is. Add type query parameters to buy extra blocks, one parameter per property: ?type=classification&type=score. Every block you request comes back carrying a status, and you are billed for exactly the blocks whose status is ok.
Two differences from the POST form are worth knowing before you choose it. The number appears in the URL, so it will be recorded wherever request URLs are (proxies, access logs, browser history), which is why the POST form exists. And this form takes no Idempotency-Key, so a retry is a second lookup and is billed again.
参数
number
string
The number to look up, in E.164 format. Percent-encode the leading plus as %2B if your client does not do it for you.
查询参数
type
array
A property to buy for this number, on top of the free baseline. Repeat the parameter to request several. Each one is billed separately, and only when it is delivered.
响应载荷
phone_number
string
必填
The number that was looked up, in E.164 format.
country_code
nullable string
The ISO 3166-1 alpha-2 country of the number. Absent when the number belongs to no single country, as a non-geographic range does.
network_info
nullable object
The network that serves the number today. Absent when no network could be identified.
显示子属性
network_info.carrier_name
nullable string
The carrier's name, absent when the carrier could not be identified.
network_info.mcc
nullable string
The mobile country code, absent for a network that has none or could not be identified.
network_info.mnc
nullable string
The mobile network code, absent for a network that has none or could not be identified.
original_network_info
nullable object
The network that issued the number's range. It differs from network_info when the number has been ported. Absent when the issuing network could not be identified.
显示子属性
original_network_info.carrier_name
nullable string
The carrier's name, absent when the carrier could not be identified.
original_network_info.mcc
nullable string
The mobile country code, absent for a network that has none or could not be identified.
original_network_info.mnc
nullable string
The mobile network code, absent for a network that has none or could not be identified.
flags
array of string
必填
Notable characteristics of the number. Empty when none apply.
line_type
object
必填
classification
object
The allocated service of the number's range. Absent unless you requested the classification property.
显示子属性
classification.status
object
必填
classification.value
object
The allocated service of the range. Present only when status is ok.
presence
object
Whether the number is live on its network. Absent unless you requested the presence property.
显示子属性
presence.status
object
必填
presence.reachable
boolean
Whether the number is registered on a network and able to receive traffic. False means the network answered and reported the number as not currently reachable, which is different from us being unable to find out. Present only when status is ok.
roaming
object
Whether the number is roaming. Absent unless you requested the roaming property.
显示子属性
roaming.status
object
必填
roaming.is_roaming
boolean
Whether the number is currently roaming outside its home network. Present only when status is ok.
roaming.mcc
nullable string
The mobile country code of the visited network. Absent when the number is not roaming or the visited network is not reported.
roaming.mnc
nullable string
The mobile network code of the visited network. Absent when the number is not roaming or the visited network is not reported.
sim_swap
object
When the number's SIM last changed. Absent unless you requested the sim_swap property.
显示子属性
sim_swap.status
object
必填
sim_swap.last_swapped_at
nullable string
When the SIM was last changed. Absent when only a recency band is known.
sim_swap.min_days
nullable integer
The lower bound, in days, of how long ago the SIM was last changed. Networks that do not release an exact date report a band instead; absent when no lower bound is known.
sim_swap.max_days
nullable integer
The upper bound, in days, of how long ago the SIM was last changed. Absent when no upper bound is known; with a lower bound present, that means the change was at least min_days ago.
porting
object
The number's porting record. Absent unless you requested the porting property.
显示子属性
porting.status
object
必填
porting.ported
boolean
Whether the number has ever moved network. False is a positive finding rather than a lack of one: the registry was consulted and holds no move for this number. Present only when status is ok.
porting.last_ported_at
nullable string
When the number last moved network. Absent when it has never ported or when no date is on record.
porting.last_ported_at_is_approximate
boolean
Whether last_ported_at is an approximation. Some registries record only the period a move happened in, not the day.
porting.history
array of object
Every move on record, oldest first. Absent when the number has never ported or when its registry publishes no history.
显示子属性
porting.history.occurred_at
nullable string
必填
When the move was recorded, null when the record carries no date.
porting.history.action
nullable string
必填
What the record describes, as the number's registry reports it. Registries use their own short codes rather than a shared vocabulary, so treat this as a label to display rather than a value to branch on.
score
object
The number's credibility score. Absent unless you requested the score property.
显示子属性
score.status
object
必填
score.value
integer
Credibility from 0 (low) to 100 (high). A low score means the number looks less credible than a typical subscriber line in the same range; it is a signal to weigh, not a verdict. It is a composite and is not derivable from the other properties. Present only when status is ok.