Marketplace Add-on Listing Tutorial

Add-on listings can be installed and enabled through the Twilio Console. Once installed, they enhance specific Twilio APIs, such as Twilio Voice and Programmable Messaging. One popular feature from Marketplace Add-ons is ensuring a number is compliant with Telephone Consumer Protection Act (TCPA) regulations.

To install the Prove TCPA Compliance, follow these steps:

1. Select Prove TCPA Compliance from the catalog.
2. Click Install.
3. Under the Configure tab, check the Lookups box.
4. View all installed Marketplace Add-ons by clicking on Marketplace > Installed.

Prove TCPA Compliance is an Add-on that allows you to verify if a phone number is active and still owned by the customer before sending an SMS message. This helps ensure compliance with Telephone Consumer Protection Act (TCPA) regulations.

To use this Add-on, install it just like Trestle Reverse Phone. Go to the Add-on catalog, locate and click on Prove TCPA Compliance, and click Install.

Expand image

Since the goal is to leverage the Twilio Lookup API to find TCPA compliance information for a phone number, check the Lookups box under the Configure tab of the Prove TCPA Compliance Add-on. Afterwards, query for the TCPA compliance information on the target phone number using the following code:

curl --location --request GET 'https://lookups.twilio.com/v1/PhoneNumbers/+16505399600/?AddOns=prove_tcpa_compliance&AddOns.prove_tcpa_compliance.RightPartyContactedDate=20160101' -u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN

Example response:

1
{
2
    "Status": 0,
3
    "Description": "Success",
4
    "RequestId": "7f83-b0c4-90e0-90b3-11e10800200c9a66",
5
    "Response": {
6
        "VerifyNumberTransactionId": "144356671",
7
        "PayfoneAlias": "C24C4C54DR10481C4E0U44ERMVUP9S1TUNXPLA2T753ETMCFOA086TYMCAQL00B4E0CLC4C24BHZPO4QWPN68EAV14ERTVPMMEP7OCXTRBQR17YERTMK749",
8
        "MSISDNType": "Mobile",
9
        "NumberMatch": "Y"
10
    }
11
}

The results from the TCPA Compliance Lookup are organized into a structured format. The key NumberMatch indicates Y for a compliant number, N for a non-compliant number, and I for an indeterminate number. The response also includes keys related to the identification of the device claiming ownership of the number. For demographic and carrier information, use the Trestle Reverse Phone Add-on.

For more information on using Marketplace Add-ons, refer to the How to use Add-on Listings Guide.