Network/Country information for a phone number

Network/Country information for a phone number

get

Performs network lookup for a phone number

Authorizations

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

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/network-lookup HTTP/1.1
Host: 
Authorization: Bearer jwt
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 and Type of Number Lookup

POST /workspaces/{workspaceId}/network-lookup

Perform a Network, Country, and type of Number lookup

Path

Name	Value
workspaceId	The ID for the workspace<string>

Headers

Name	Value
Authorization	ApiKey <string>

Body

Name	Type	Description
phoneNumber	string	phone Number in E164 format (ex + 1234567890)

Response

200

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

400

{
  "code": "text",
  "message": "service.",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}