Overview

Create SIP Trunk

The save SIP trunk API facilitates user to save/create SIP Trunks for a specific number.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/voip

Request Variables (Header Params)

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

Request Variables (Body Params)

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

Sample Request

POST https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/voip

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

{
    "type": "VOIP",
    "msisdn": "19212093845",
    "cost": "0.9",
    "tenant_id": "tenant_12345",
    "features": ["VOICE"],
    "voip_user_id": "9897969594",
    "voip_user_password": "Abc123",
    "voip_sip_server": "test-server",
    "customer_email": "customer123@gmail.com",
    "country": "US"
}

Response Variables

Response Schema

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

Update SIP Trunk

The update SIP trunk API enables users to modify existing SIP Trunk information by providing updated data.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/update-voip-number

Request Variables (Header Params)

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

Request Variables (Body Params)

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

Sample Request

PATCH https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/update-voip-number

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

{
    "msisdn": "19212093845",
    "tenant_id": "tenant_12345",
    "voip_user_id": "9897969594",
    "voip_user_password": "Abc123",
    "voip_sip_server": "test-server",
    "customer_email": "customer123@gmail.com",
    "old_msisdn": "19212093845",
    "is_numberChanged": "true"
}

Response Variables

Response Schema

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

Delete SIP Trunk

The delete SIP trunk API facilitates user to delete a SIP Trunk from your account.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/delete-voip-number

Request Variables (Header Params)

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

Request Variables (Body Params)

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

Sample Request

DELETE https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/delete-voip-number

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

{
    "msisdn": "19212093845",
    "customer_email": "customer123@gmail.com",
    "tenant_id": "tenant_12345",
    "bot_attached": {
        "bot_id": "sadfsdf3dsf43v34nfn"
    }
}

Response Variables

Response Schema

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

Test SIP Trunk

The test SIP trunk API facilitates users to test a SIP Trunks for a given MSISDN number and will check the SIP Trunk connection to return a success or failure message

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/test-voip/{msisdn}

Request Variables (Header Params)

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

Request Variables (Path Params)

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

Sample Request

POST https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/test-voip/{msisdn}

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:

List SIP Trunk

The list all SIP trunks API facilitates user to retrieve a comprehensive list of SIP Trunks belonging to the specified tenant.

Endpoint URL

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

Request Variables (Header Params)

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

Request Variables (Path Params)

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

Sample Request

GET https://api.call-ai.com/basic-integrations/v1/basic/api/v1/number/voip-numbers/{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

Use the below-mentioned method to update a asr data:

POST https://api.call-ai.com/basic-integrations/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

Use the below-mentioned method to update a asr data:

POST https://api.call-ai.com/basic-integrations/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

Use the below-mentioned method to update a asr data:

POST https://api.call-ai.com/basic-integrations/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 deattached, 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

Use the below-mentioned method to update a asr data:

POST https://api.call-ai.com/basic-integrations/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": "sadfsdf3dsf43v34nfn"
}

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

Use the below-mentioned method to update a asr data:

POST https://api.call-ai.com/basic-integrations/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": "9876543210"
}

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

Use the below-mentioned method to update a asr data:

DELETE https://api.call-ai.com/basic-integrations/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:

Create SMS Gateway

The save configuration details API enables users to store the specific configuration details for an SMS connector. This functionality allows for the convenient preservation and retrieval of the configured settings related to the SMS connector, ensuring consistency and ease of use.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration

Request Variables (Header Params)

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

Request Variables (Body Params)

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

Sample Request

POST https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration

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

{
    "type": "sms",
    "tenant_id": "tenant_12345",
    "number": "1234567890",
    "id": "1234",
    "secret": "fejv43rdvnt43r3ff",
    "is_activated": true
}

Response Variables

Response Schema

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

Update SMS Gateway

The Integration API is a web-based interface that enables to search for available DID(Direct Inward Dialing) numbers and purchase them configure voice over internet protocol (VOIP) with call AI, and attach and detach numbers with virtual agents. The service also includes functionality for setting up automatic speech recognition (ASR) and text-to-speech (TTS) features for the numbers.Users can create and manage virtual agents through the service and virtual agent can also be updated at any time to keep up with changing business needs.Additionally, the service offers SMS connector configuration with popular providers like Twilio or Vonage, enabling users to manage SMS interactions with customers from within the microservice

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration

Request Variables (Header Params)

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

Request Variables (Body Params)

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

Sample Request

PATCH https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration

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

{
    "type": "sms",
    "tenant_id": "tenant_12345",
    "number": "1234567890",
    "id": "1234",
    "secret": "fejv43rdvnt43r3ff",
    "is_activated": true,
    "_id": "62d5164908eb6c8c036f591h"
}

Response Variables

Response Schema

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

Delete SMS Gateway

The delete SMS connector list API removes an SMS connector associated with a specific tenant based on its type and number. This API provides the functionality to delete the SMS connector from the list, ensuring efficient management of SMS connectors for the designated tenant.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration/{tenant_id}/{type}/{number}

Request Variables (Header Params)

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

Request Variables (Path Params)

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

Sample Request

DELETE https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration/{tenant_id}/{type}/{number}

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:

List SMS Gateway

The fetch SMS connector list api facilitates user to retrieve the list of SMS connectors for the specific tenant.

Endpoint URL

https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration/{tenant_id}

Request Variables (Header Params)

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

Request Variables (Path Params)

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

Sample Request

GET https://api.call-ai.com/basic-integrations/v1/basic/api/v1/sms_integration/{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:

Send SMS

Coming Soon

List Sent SMS

Coming Soon

Create FHIR

Coming Soon

Delete FHIR

Coming Soon

List FHIR

Coming Soon

CSV Uploads

Coming Soon