Chilkat Online Tools

DataFlex / Plivo REST API / Lookup a Phone Number

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vQueryParams
    Handle hoQueryParams
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Set ComBasicAuth Of hoHttp To True
    Set ComLogin Of hoHttp To "{{auth_id}}"
    Set ComPassword Of hoHttp To "password"

    Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
    If (Not(IsComObjectCreated(hoQueryParams))) Begin
        Send CreateComObject of hoQueryParams
    End
    Get ComUpdateString Of hoQueryParams "type" "carrier" To iSuccess

    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoQueryParams to vQueryParams
    Get pvComObject of hoResp to vResp
    Get ComHttpParams Of hoHttp "GET" "https://lookup.plivo.com/v1/Number/13863877367" vQueryParams vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1


End_Procedure

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