Operations (sample payloads)

Main operations

Format phone number

Given a country and a phone number, this operation will return a phone number with the country code in the desired format. Sample Input

\{
    "source_number": "+1 (555) 123-4567",
    "format": "e164",
    "region": "United States of America"
\}

Sample Output

{
    "result": "+15551234567"
}

Get details

Takes a phone number and outputs information on its characteristics, e.g. if it's valid, if it can be internationally dialed, if it's a mobile phone number, etc. Sample Input

\{
    "source_number": "+1 (555) 123-4567",
    "region": "United States of America"
\}

Sample Output

{
    "number": \{
        "input": "+1 (555) 123-4567",
        "international": "+1 555-123-4567",
        "national": "(555) 123-4567",
        "e164": "+15551234567",
        "rfc3966": "tel:+1-555-123-4567",
        "significant": "5551234567"
    \},
    "regionCode": "US",
    "valid": true,
    "possible": true,
    "canBeInternationallyDialled": true,
    "type": "FIXED_LINE_OR_MOBILE",
    "possibility": "IS_POSSIBLE"
}