Chilkat Online Tools

autoit / Plivo REST API / Lookup a Phone Number

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "{{auth_id}}"
$oHttp.Password = "password"

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("type","carrier")

$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.QuickRequestParams("GET","https://lookup.plivo.com/v1/Number/13863877367",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -G -d "type=carrier"
	-u '{{auth_id}}:password'
	-H "Content-Type: application/json"
https://lookup.plivo.com/v1/Number/13863877367

Postman Collection Item JSON

{
  "name": "Lookup a Phone Number",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://lookup.plivo.com/v1/Number/13863877367?type=carrier",
      "protocol": "https",
      "host": [
        "lookup",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Number",
        "13863877367"
      ],
      "query": [
        {
          "key": "type",
          "value": "carrier"
        },
        {
          "key": "",
          "value": "",
          "disabled": true
        }
      ]
    },
    "description": "Returns phone number information matching the specified request. Formatting information is standard. Carrier, Portability Information (Only for the US & CA), and phone number type information can be requested.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/lookup/api/content-type/)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| type      | The value of the parameter should be the string \"carrier\"| Required |\n\nWe will be adding other phone number information in the future for which this value has to be changed accordingly."
  },
  "response": [
    {
      "name": "Lookup a Phone Number",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://lookup.plivo.com/v1/Number/{PhoneNumber}?type=carrier",
          "protocol": "https",
          "host": [
            "lookup",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Number",
            "{PhoneNumber}"
          ],
          "query": [
            {
              "key": "type",
              "value": "carrier",
              "description": "The value of the parameter should be the string \"carrier\"."
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"b61f8119-09d5-49f9-8101-406bf91da709\",\n    \"phone_number\": \"+13308702395\",\n    \"country\": {\n        \"name\": \"United States\",\n        \"iso2\": \"US\",\n        \"iso3\": \"USA\"\n    },\n    \"format\": {\n        \"e164\": \"+13308702395\",\n        \"national\": \"(330) 870-2395\",\n        \"international\": \"+1 330-870-2395\",\n        \"rfc3966\": \"tel:+1-330-870-2395\"\n    },\n    \"carrier\": {\n        \"mobile_country_code\": \"\",\n        \"mobile_network_code\": \"\",\n        \"name\": \"Bandwidth.com\",\n        \"type\": \"voip\",\n        \"ported\": \"no\"\n    },\n    \"resource_uri\": \"/v1/Number/+13308702395?type=carrier\"\n}"
    }
  ]
}