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"
  }
}

Network/Country information for a phone number

post

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

Body

application/json

phoneNumberstringRequired

The phone number to look up

Example: [phone]

Responses

200

OK

application/json

422

InvalidPayload

application/json

post

/workspaces/{workspaceId}/network-lookup

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/network-lookup HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "phoneNumber": "[phone]"
}

{
  "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"
  }
}

Bulk lookups

Our bulk API supports up to 50 phone number lookups in one request. This number lookup will only be performed on our set of curated number databases and will not perform a network lookup for the given numbers.

Batch network/country information for multiple phone numbers

get

Performs network lookup for multiple phone numbers using the local embedded database

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

numbersstringRequired

Comma-separated list of phone numbers to look up (max 50)

Example: [phone],[phone]

Responses

200

OK

application/json

422

InvalidPayload

application/json

get

/workspaces/{workspaceId}/network-lookup/batch

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/network-lookup/batch?numbers=%2B31612345678%2C%2B1234567890 HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "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"
      }
    }
  ]
}

Batch network/country information for multiple phone numbers

post

Performs network lookup for multiple phone numbers using the local embedded database

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

Body

application/json

phoneNumbersstring[] · max: 50Required

List of phone numbers to look up

Example: [phone]

Responses

200

OK

application/json

422

InvalidPayload

application/json

post

/workspaces/{workspaceId}/network-lookup/batch

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/network-lookup/batch HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "phoneNumbers": [
    "[phone]"
  ]
}

{
  "results": [
    {
      "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"
      }
    }
  ]
}