How To Use The Scout Twilio Lookup Add-on

Installation

Log in to your Twilio Console and open the Scout Lookup Add-on listing in the Add-ons Marketplace. Click Install, agree to the terms, and configure it for the Twilio Lookup request types you want Scout data on.

Credentials

You’ll authenticate to Twilio, not to Scout directly. Find your Account SID and Auth Token on your Twilio Console dashboard; the curl request below uses them as HTTP Basic Auth credentials (AccountSID:AuthToken). No separate Scout API key is needed for this Delivery Platform.

Parameter Overview

• Dialcode — the phone number to look up, in E.164 format, as part of the request URL.
• AddOns — set to icehook_scout, the unique name of the installed Scout Lookup Add-on. This tells Twilio Lookup to include Scout’s response alongside its own.

Curl Request

curl -XGET https://lookups.twilio.com/v1/PhoneNumbers/+16502530000/?AddOns=icehook_scout -u AC0xxxxxxxxxxxxx:[AuthToken]

Replace AC0xxxxxxxxxxxxx with your Account SID and [AuthToken] with your Auth Token.

Response Location

Scout’s data doesn’t appear at the top level of the Twilio Lookup response. Per Twilio’s Add-ons documentation, every installed Add-on’s output is nested under the response’s add_ons object, keyed by the Add-on’s unique name:

{
  "add_ons": {
    "status": "successful",
    "results": {
      "icehook_scout": {
        "status": "successful",
        "result": {
          // Scout's response fields
        }
      }
    }
  }
}

Look for add_ons.results.icehook_scout.result in the response; that object holds Scout’s data.

Response Reference

The icehook_scout result object is a Scout API response, the same underlying data returned via the RapidAPI Delivery Platform. See the API Response Overview for the field-by-field reference, geography, Operating Company, portability, and robocall risk fields included.