Inquiries API

🔍 Overview of Inquiries API

With the Inquiries API, you can trigger automated outgoing calls that play the audio file of your choice and capture the recipient’s input. Once the call ends, our servers return all the data related to each call to the callback URL you set.

This page also allows you to filter inquiries calls and export your inquiry data.

💡 Key Details

The Inquiries tab will include the below information:

• ID: Unique identifier for each inquiry call.

• Created: Timestamp of the call.

• State: Status of the call (e.g., Terminated = successfully initiated).

• To: Phone number of the contacted client.

• Entries: IVR input from the recipient.

• Trials: Number of retries before aborting the call.

• Duration: Total time of the call.

• Call State: Stage of the call (Initialized, Awaiting Connect, Awaiting Entry, Closing, Terminated).

• Recording: Audio recording of the call.

The filter tab will include the below information:

• Call States: Filter calls based on their state (Initialized, Awaiting Connect, Awaiting Entry, Closing, Terminated).
• To: Search by client phone number.

• Date Range: Filter calls within a specific time period.

⚙️ How to Create Inquiries

Follow the steps below to enable and set up the Inquiries API on your account:

1. Contact Support:

   • Reach out to support@maqsam.com to enable API access on your account.

2. Generate API Credentials:

   • Go to Account Settings, API Credentials , then Generate API Key.

   • Generate API key to generate your |access_key_id| and |access_secret|. 

   • Use these credentials on your platform (website/CRM) to set up inquiries.

3. Implement API:

   • Follow the implementation instructions in the Inquiries API according to the documentation.