Network/Country information for a phone number

Network/Country information for a phone number

get

Performs network lookup for a phone number

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

Query parameters

numberstring · min: 1 · max: 30Optional

The phone number in E.164 format.

Example: [phone]

Responses

200

OK

application/json

422

InvalidPayload

application/json

get

/workspaces/{workspaceId}/network-lookup

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/network-lookup HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "phoneNumber": "text",
  "countryCode": "US",
  "countryPrefix": 1,
  "mcc": "text",
  "mnc": "text",
  "mccmnc": "text",
  "operator": "text",
  "formats": {
    "e164": "text",
    "international": "text",
    "national": "text",
    "rfc3966": "text"
  },
  "typeOfService": "mobile",
  "validation": {
    "valid": true,
    "reason": "text"
  }
}