ResponseiQ Call Reports API Integration

1. Overview

An API (Application Programming Interface) is a messenger that enables applications to communicate with backend systems by processing requests and ensuring seamless functionality within enterprise systems.

Setting up API integrations for your Web Application with ResponseiQ is quite simple. This guide will assist you in setting up your API requests within a few minutes.

 

2. Authentication

Before users can make requests with our platform’s API, you’ll need an Authorisation Token in order to proceed with requests.

An Authentication token acts as the API Key for the ResponseiQ platform. This functions mainly as a way to identify the system which is making the API call to our system (authenticating you to use the API).

You can follow the below steps to set up the authentication for API integrations:

2.1.   Login to your company account on ResponseiQ Application panel

2.2.   From the left main menu, go to My Widget Domains. Then select the widget domain you wish the API Integration executed from.

2.3.   Then Settings > API Integration

2.4.  Here you will find your Authorisation Token. This will act as your API Key. You will need this while making POST requests on the platform

2.5.   In the same menu, you will also find Widget API Key. This will be representative of the specific widget domain you selected in step 2.2. You will need this to be used as an API Key to identify widget while making a POST request to our platform. 

Tip: You can send multiple Widget API Keys in a comma-separated format, while making a POST request to the ResponseiQ platform, in order to capture data for multiple widgets at once.

 

3. Call Reports API

3.1 The Call Reports API will let your web application share all the information related to our Widget, into our platform in order to collate and generate meaningful reports for you. Our system accepts POST requests for the API calls.

3.2  URL - https://app.responseiq.com/apis/reports

3.3 PHP Code Sample (cURL):

3.4  Parameters

4. Verify Number API

4.1  The Verify Number API will share the lead’s phone number information into our platform. Our system can then verify if the contact number provided by your lead is valid or not, as well as identify who the carrier of the number is.

 4.2  URL - https://app.responseiq.com/apis/verify

4.3  PHP Code Sample (cURL):

4.4  Parameters

4.5  Return Values

5. Call Agents API

5.1 The Call Agents API is the POST request where your web application will share the lead’s contact number captured via the widget with the ResponseiQ platform. Based on the same contact information, our system will initiate a call to an available agent configured for the respective web application and widget.

 5.2  URL - https://app.responseiq.com/apis/callnow

 5.3  PHP Code Sample (cURL):

5.4  Parameters

5.5  Return Values

Did this answer your question?