Email Append Banner

Engage, Retain & Grow your Customer Base
Faster & Smarter

Phone Scrub HTTP API

  • Description

    This API scrubs single / multiple numbers and returns the response in the same call. It supports HTTP POST requests.

  • API Format

    Currently we support HTTP request. Data in following json format must be send in ‘post’ request.

    {
          "ApiKey": "put your key here", 
          "AppendModule": "PhoneScrub", 
          "Data": [  {  "Phone": "1313212323132"}  ]    
    }
  • Example

    {
        "ApiKey": "put your key here", 
        "AppendModule": "PhoneScrub", 
        "Data": [
        	  {
          	  "Phone": "1xxxxxxxxx132"
              },
              {
             "Phone": "2xxxxxx391"
              },
              {
              "Phone": "axxxxxxx439"
              },
              {
               "Phone": "2xxxxxx563"
               }
               ]  
    }
  • Response

    If success:

    {
      "ResponseDetail": {
        "Token": "Token will returned",
        "Data": [
          {
            "ClientPhone": "1xxxxxxxxx132",
            "Phone": "1xxxxxxxxx132",
            "PhoneType": "I",
            "DoNotCall": "No"
          },
          {
            "ClientPhone": "2xxxxxx391",
            "Phone": "2xxxxxx391",
            "PhoneType": "L",
            "DoNotCall": "YES"
          },
          {
            "ClientPhone": "a20xxxx439",
            "Phone": "20xxxx439",
            "PhoneType": "L",
            "DoNotCall": "No"
          },
          {
            "ClientPhone": "2xxxxxx563",
            "Phone": "2xxxxxx563",
            "PhoneType": "L",
            "DoNotCall": "YES"
          }
        ],
        "OrderAmount": "$0.02",
        "Count": 5
      },
      "Status": true,
      "Message": null
    }
    

    If failed:

    {
            "ResponseDetail": null,"Status": false,
            "Message": "Invalid API Key."
    }
    
  • Phone Type Code Description:

    W – Wireless
    L – Landline
    V – VOIP

Request More Information