Platform

NLPearl Documentation

API Reference

Support

Retrieves the calls within a specific date range of inbound

Search Calls

The phone number from which the call was made.

The date and time when the call processing started.

The phone number to which the call was made.

Represents the current status of a call.

`3 - InProgress`

`4 - Completed`

`5 - Busy`

`6 - Failed`

`7 - NoAnswer`

`8 - Canceled`



The outcome of the conversation during the call.

To determine the definition of 'Success' or 'Not Successful,' please refer to the [Create a Pearl](/pages/create_pearl#pearl-name) page at step 4.

`10 - NeedRetry`

`100 - Success`

`110 - NotSuccessfull`

`130 - Complete`

`500 - Error`



bearer auth

Welcome to NLPearl.AI - Revolutionizing Telecommunications with Conversational AI

Introduction

Explore the comprehensive capabilities of NLPearl.AI, revolutionizing telecommunications with advanced conversational AI.

Overview

Discover how to make the most of NLPearl.AI from your initial registration to full platform utilization.

Getting Started

First it is important to understand that the process of creating your phone agent is divided into two parts: the first part involves creating and customizing your Pearl for personalized conversational flows in NLPearl.AI, and the second part focuses on setting up your inbound or outbound campaign that will utilize your Pearl. Let’s start by explaining and detail the first part of this process.

Simple Pearl

Advanced Pearl

Variables

Explore the diverse range of languages and accents supported by NLPearl.AI.

Voices and Languages

NLPearl.AI provides a range of actions that can be performed by your Pearl both during and after calls. These actions are designed to automate tasks, improve efficiency, and enhance customer interactions.

Learn how to use the Transfer Call action in NLPearl.AI to seamlessly redirect calls during a conversation.

Transfer Call

Learn how to configure the "Send An Email" action within a Pearl, allowing your AI agent to send emails during a conversation.

Send An Email

Learn how to configure the "Send SMS" action within a Pearl, allowing your AI agent to send SMS messages during a conversation.

Send SMS

Learn how to configure your Pearl to call an API during a live conversation.

 When you click on a call row, you can access various details.At NLPearl.AI we offer robust analytics features to help you gain insights into your conversations. When you create a Pearl, you can define the flow of your interactions, specify the information to be collected about the leads, and set success criteria to evaluate the effectiveness of your calls.

Calls/Analytics

Learn how to set up Inbound Activities using your created Pearl to handle incoming calls effectively.

Inbound

Learn how to set up and manage Outbound Campaigns using NLPearl.AI to handle outbound calls effectively.

Outbound

Discover how to leverage the API for dynamic outbound activities, offering direct control over call operations and lead management.

Outbound/API

Learn how to purchase and manage agents in NLPearl.AI to optimize your inbound and outbound call activities.

Agents

Learn why phone numbers are essential for activities on NLPearl.AI and the available options for purchasing and integrating them.

Phone Numbers Overview

Learn how to purchase phone numbers directly from the NLPearl.AI platform.

NLPearl Phone Numbers

Learn how to integrate your Twilio account with NLPearl.AI and use your Twilio phone numbers.

Twilio Integration

Learn how to integrate your own VoIP service with NLPearl.AI.

Custom VoIP Integration

Learn how to manage your billing settings, subscriptions, and invoices on the NLPearl.AI platform.

Billing

Get started with the NLPearl.AI API by following these simple steps to set up your subscription, API secret key, and authentication.

Quick Start

Learn how to use the NLPearl Python wrapper to interact with the NLPearl API effortlessly.

Python Wrapper

Learn how to authenticate your API requests using your Account ID and API secret key.

API Authorization

Get Account

Retrieves all the informations about a call

Get Call

Get Inbounds

Get Inbound

Set Activity State

Get Outbounds

Get Outbound

Activates or deactivates a specified outbound

Retrieves the calls within a specific date range for a given outbound

Add Lead

Retrieves the leads associated with a specific outbound

Search Leads

Retrieves details of a specific lead within a outbound

Get Lead

Get Lead Via External ID

Initiates an outbound phone call associated with the specified outbound ID. The request body must contain the necessary details for making the call. Once initiated, the call will be routed to the first available agent.

Make Call

Fetches detailed information about a specific API request identified by its unique requestId.

Get Call Request

Fetches a list of API call requests associated with a specific outbound identifier. The search criteria, such as filters or pagination options, should be provided in the request body.

Account

Call

Inbound

Outbound

Search Calls

Authorizations

Path Parameters

Body

Response