Endpoints, Method and Parameter

The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.

Contact Extractor API

The Contact Extractor API is defined as follows:

HTTP Request:
  • URL: https://plugin.rchilli.com/RChilliPlugin/rchilli/contactExtractor
  • Accept: application/json
  • Response Type: JSON

API Endpoint

The Contact Extractor API endpoint returns the parsed data in the JSON format. The Contact Extractor endpoint is mention below:

/contactExtractor

API Method

The Contact Extractor API uses only the POST method.

Request Headers

Header Data Type Description
Content-Type string Indicates the input type of the incoming request body. The only supported value is application/json.

API Parameters

The Contact Extractor API requires the following parameters in the JSON request format:
Name Type Description Remarks
filedata String File data in base64 (only support "text/plain" mimetype) Required
userkey String Valid User Key as provided by RChilli, see How to get user key. Required
version String Valid version as provided by RChilli Required
subuserid String As per contract Required

JSON Request for Contact Extractor Plugin

Below is the API Request in JSON Format:

{
  "filedata": "File data in base64",
  "userkey": "Your API UserKey",
  "version": "1.0.0",
  "subuserid": "Your Company Name"
}

API Response Parameters

Follow the below table for the Contact Extractor API response parameters details.
Name Type Description
Name Object The details of the Name entity.
Email Array The details of the Email entity.
PhoneNumber Array The details of the PhoneNumber entity.
WebSite Array The details of the WebSite entity.
Location Array The details of the Location entity.

JSON Response for Contact Extractor Plugin

Below is the API Response in JSON Format:
{
  "Name": {
    "FullName": "BISHWAJIT DEY",
    "TitleName": "",
    "FirstName": "BISHWAJIT",
    "MiddleName": "",
    "LastName": "DEY",
    "FormattedName": "Bishwajit Dey",
    "ConfidenceScore": 10
  },
  "Email": [
    {
      "EmailAddress": "ketki@bluemountimm.com",
      "ConfidenceScore": 10
    }
  ],
  "PhoneNumber": [
    {
      "Number": "8775727737",
      "ISDCode": "+91",
      "OriginalNumber": "877 572 7737",
      "FormattedNumber": "+91 877 572 7737",
      "Type": "Phone",
      "ConfidenceScore": 10
    }
  ],
  "WebSite": [
    {
      "Type": "Website",
      "Url": "www.bluemounttest.com"
    }
  ],
  "Location": [
    {
      "Street": "",
      "City": "Pune",
      "State": "Maharashtra",
      "StateIsoCode": "IN-MH",
      "Country": "India",
      "CountryCode": {
        "IsoAlpha2": "IN",
        "IsoAlpha3": "IND",
        "UNCode": "356"
      },
      "ZipCode": "",
      "FormattedAddress": "Pune, Maharashtra, India"
    },
    {
      "Street": "",
      "City": "Delhi",
      "State": "",
      "StateIsoCode": "",
      "Country": "India",
      "CountryCode": {
        "IsoAlpha2": "IN",
        "IsoAlpha3": "IND",
        "UNCode": "356"
      },
      "ZipCode": "",
      "FormattedAddress": "Delhi, India"
    }
  ]
}