No-code docs
Resources

Lookup

The current Lookup API is an early release, subject to changes. It currently only supports Phone Number Lookup

Scope

The Contact Lookup service is intended to provide key information about a number, such as

TypeOfServices

Type Of ServiceLegend

Fixed

The number belongs to a fixed or landline subscription. It likely supports voice but not SMS

    "mcc": "310",
    "mnc": "",
    "mccmnc": "310",
    "operator": "Comcast IP Phone, LLC",
    "typeOfService": "fixed",
    "validation": {
        "valid": true,
        "reason": ""
    }

Mobile

The number belongs to the Mobile Network active number range. It likely support both voice and SMS and to be own by a physical individual

    "mcc": "310",
    "mnc": "010",
    "mccmnc": "310010",
    "operator": "Verizon Wireless",
    "typeOfService": "mobile",
    "validation": {
        "valid": true,
        "reason": ""
    }

Others

The Number belongs to Other providers, such as, but not limited to, Premium Services, Toll-Free Numbers, Virtual Numbers, M2M or IOT, etc. Although such number may support both Voice and SMS are more likely own by corporation then an individuals 

    "mcc": "310",
    "mnc": "",
    "mccmnc": "310",
    "operator": "Onvoy, LLC - AL",
    "typeOfService": "other",
    "validation": {
        "valid": true,
        "reason": ""
    }

Validation

Indicating if the queried number is valid as correctly formed and associated with a active phone number range. Invalid number answer will contain a reason fields providing more details on the reason

Bird's Lookup do not return numbers' live status. Lookup validation occurs on number format, allocation and type only. Valid number may be inactive (not associated to active contract lines) or absent (temporary out of any carrier coverage) and fail to receive calls or SMS.

Network Data

Providing details about the network the number belong . Information will be provided in two format

  • Via a Numeric country (MCC : Mobile Country Code) and network (MNC: Mobile Network Code) code . This is an immutable identified linked to the carrier telecom license and the best indicator of a network identity

  • Via a human readable name , this is subject to changes following carrier rebranding and or corporate actions Contact lookup

API Calls

Network/Country information for a phone number

Performs network lookup for a phone number

GET/workspaces/{workspaceId}/network-lookup
Authorization
Path parameters
workspaceId*string
Query parameters
Response

OK

Body
phoneNumberstring
countryCodestring

The country code of the phone number in ISO 3166-1 alpha-2 format

countryPrefixinteger
mccstring
mncstring
mccmncstring
operatorstring
formatsobject

The phone number in various formats

typeOfServiceenum

The type of service that the phone number is provisioned for, mobile, fixed or other

mobilefixedother
validationobject

The validation status of the phone number, and the reason for the status

Request
const response = await fetch('/workspaces/{workspaceId}/network-lookup', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();
Response
{
  "phoneNumber": "text",
  "countryCode": "text",
  "mcc": "text",
  "mnc": "text",
  "mccmnc": "text",
  "operator": "text",
  "formats": {
    "e164": "text",
    "international": "text",
    "national": "text",
    "rfc3966": "text"
  },
  "typeOfService": "mobile",
  "validation": {
    "valid": false,
    "reason": "text"
  }
}

Last updated