POST api/phonenumber/lookup

Does a metadata lookup on the given phonenumbers

Request Information

URI Parameters

None.

Body Parameters

Default region and phone numbers for lookup

PhoneNumberRequestDTO
NameDescriptionTypeAdditional information
DefaultRegion

ISO 3166-1 alpha-2 region code

string

None.

PhoneNumbers

A collection of phonenumbers to check

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "DefaultRegion": "sample string 1",
  "PhoneNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

Checked phone numbers with metadata

PhoneNumberResponseDTO
NameDescriptionTypeAdditional information
DefaultRegion

ISO 3166-1 alpha-2 region code

string

None.

PhoneNumbers

A collection of checked phonenumbers with metadata

Collection of PhoneNumberDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "DefaultRegion": "sample string 1",
  "PhoneNumbers": [
    {
      "Input": "sample string 1",
      "Type": "FIXED_LINE",
      "RegionCode": "sample string 2",
      "E164Format": "sample string 3",
      "NationalFormat": "sample string 4",
      "InternationalFormat": "sample string 5",
      "CountryCode": "sample string 6",
      "IsValid": true
    },
    {
      "Input": "sample string 1",
      "Type": "FIXED_LINE",
      "RegionCode": "sample string 2",
      "E164Format": "sample string 3",
      "NationalFormat": "sample string 4",
      "InternationalFormat": "sample string 5",
      "CountryCode": "sample string 6",
      "IsValid": true
    }
  ]
}