Overview

Introducing the Call-Ai Number API: Streamlining Number Management and Revolutionizing Communication Systems

In today's fast-paced digital world, effective communication is a vital aspect of any successful business. However, managing phone numbers and incorporating advanced speech technologies can be a cumbersome and time-consuming process. That's where the innovative Call-Ai Number API comes into play, aiming to simplify number management and enhance communication systems with unparalleled ease and efficiency.

The Call-Ai Number API is a cutting-edge solution that empowers businesses and developers alike to harness the full potential of their communication infrastructure. By leveraging this powerful API, users can effortlessly search, purchase, and configure Direct Inward Dial (DID) numbers, while seamlessly integrating Text-to-Speech (TTS) and Automated Speech Recognition (ASR) functionalities through the Call AI RESTful API.

Let's delve deeper into the features and capabilities that the Call-Ai Number API offers:

1. Streamlined Number Management:

   With the Call-Ai Number API, the tedious process of managing phone numbers becomes a thing of the past. Users can now easily organize and administer their DID numbers from a single centralized platform, eliminating the need for multiple systems or complex manual interventions.

2. Effortless Number Acquisition:

   Acquiring new DID numbers has never been simpler. Through the Number API's intuitive interface, users can effortlessly search for available numbers based on their preferred criteria, such as location, area code, or specific digits. Once the desired number is found, the purchase process is seamless, ensuring businesses have instant access to the resources they need.

3. Seamless Configuration of TTS and ASR:

   Communication systems greatly benefit from the integration of advanced speech technologies like Text-to-Speech (TTS) and Automated Speech Recognition (ASR). The Call-Ai Number API facilitates easy configuration of TTS, allowing businesses to convert text into natural-sounding speech, enhancing customer interactions and automating voice responses. Simultaneously, ASR enables the API to transcribe spoken language into text, opening up possibilities for voice-enabled applications and voice analytics.

4. RESTful API Integration:

   The Call-Ai Number API adopts the widely acclaimed RESTful API architecture, ensuring smooth integration with existing communication systems and facilitating developers to build custom solutions tailored to their specific requirements. Its developer-friendly documentation and comprehensive SDKs (Software Development Kits) make the integration process straightforward, saving both time and resources.

5. Security and Reliability:

   Call-Ai prioritizes the security and reliability of its services, providing users with a robust and scalable platform. The API is designed to handle high call volumes and is equipped with top-notch security measures, ensuring sensitive information and interactions remain protected.

In conclusion, the Call-Ai Number API is a game-changer in the realm of communication systems. By simplifying number management and offering seamless integration of TTS and ASR capabilities, businesses can now provide enhanced customer experiences, drive productivity, and unlock new opportunities for growth. Whether you are a large enterprise seeking to optimize your communication infrastructure or a developer working on cutting-edge applications, the Call-Ai Number API is here to transform the way you interact and communicate. Embrace the future of communication technology today with Call-Ai!

Purchase Number

The "Buy Number" API allows you to programmatically purchase or acquire phone numbers from a service provider or telecommunications company.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/buy

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/buy

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "tenant_id": "tenant_12345",
    "msisdn": "19212093845",
    "customer_email": "customer123@gmail.com",
    "country": "US",
    "type": "mobile-lvn"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Country List

The "Fetch All Country List" API provides a comprehensive list of countries worldwide. It allows you to retrieve data about each country, including details such as country name, capital, population, area, languages spoken, currency used, time zones, and more. This API is commonly used in applications that require country-related information, such as travel websites, e-commerce platforms, or educational resources. By making a request to the API endpoint, you can obtain an array of country objects that can be used to populate dropdown menus, display country information, or perform various data operations related to countries.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/countries

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Sample Request

GET https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/countries

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch List of Available No.

The "Fetch All Available Numbers" API allows you to retrieve a list of available phone numbers from a service provider or telecommunications company. This API is commonly used in applications that require phone number selection.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/available?countryCode={countryCode}&index={index}&type={type}&page_size={page_size}[&pattern][&search_pattern]

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/available?countryCode={countryCode}&index={index}&type=mobile-lvn&page_size={page_size}&search_pattern=0

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch List of Number

The "Fetch All Purchased Numbers" API allows you to retrieve a list of phone numbers that have been purchased or acquired through a service provider.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/purchased/{tenant_id}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/purchased/{tenant_id}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Update ASR Configration

The "Update ASR Data" refers to an operation or API that allows you to modify or update the data used for Automatic Speech Recognition (ASR) systems. ASR technology is designed to convert spoken language into written text, and updating the ASR data involves making changes to the underlying language models, acoustic models, or other components used in the ASR system.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/googleASR/save

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/googleASR/save

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "asr": {
        "asr_engine": "google",
        "number": "1234567890",
        "language_code": "en-US",
        "model": "English-US",
        "tenant_id": "tenant_12345",
        "language": "Hindi (India)",
        "displayed_model": "Default"
    },
    "mode": "update"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Update TTS Configration

The "Update TTS (Text-to-Speech) Data" feature refers to the capability of modifying or updating the data used by a Text-to-Speech system. TTS technology converts written text into spoken words, allowing computer systems to generate human-like speech.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/tts/save

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/tts/save

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "tts": {
        "tts_engine": "google",
        "number": "1234567890",
        "language_code": "en-US",
        "ssml_gender": "MALE",
        "voice": " en-US-Standard-J",
        "voice_style ": "Newscast-Formal",
        "tenant_id": "tenant_12345",
        "pitch": "1",
        "speed": "1",
        "language": "Hindi (India)"
    },
    "mode": "update"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Attach A Number With DVA

The api allows you to attach a phone number to a virtual agent. Once the number is attached, the virtual agent can receive and respond to messages sent to that number.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/attach/numberBot

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/attach/numberBot

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "number": "1234567890",
    "tenant_id": "tenant_12345",
    "webhook": "http://39.228.104.43:8896/webhooks/rest/webhook",
    "bot_name": "abcd",
    "bot_id": "fsdhfb2324xcnvx34534vdnj"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Deattach A Number With DVA

The api allows you to deattach a phone number to a virtual agent. Once the number is attached, the virtual agent will no longer receive and respond to messages sent to that number.

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/deattach/numberBot

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/number/deattach/numberBot

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "number": "1234567890",
    "tenant_id": "tenant_12345",
    "bot_id": "sfsdjfds32534dvds5sdfh"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Assign Team

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/teams/save

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/basic-numbers/v1/basic/api/v1/teams/save

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "tenant_id": "tenant_12345",
    "name": "tester_09722811",
    "display_name": "tester",
    "number_attached": "1234567890"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Unassign Team

Endpoint URL

https://api.call-ai.com/basic-numbers/v1/basic/api/v1/teams

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

DELETE https://api.call-ai.com/basic-numbers/v1/basic/api/v1/teams

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
  "name": "tester_09722811"
}

Response Variables

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below: