Overview

The Call-Ai Calling Campaign API's empower developers to efficiently manage and execute calling campaigns within their applications. These APIs offer functionalities for creating, scheduling, and monitoring outbound call campaigns, enabling effective communication with targeted audiences.

Create Campaign

Using this API, you have the ability to utilize campaign creation and scheduling features. It allows you to set specific dates, times, and days of the week for your campaigns to run. Additionally, you can integrate a dialer into your campaigns, and even attach a bot that will guide the outreach calls. Furthermore, you can configure the number of retry attempts for situations when customers don't answer the calls.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/create-campaign

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/campaign-ms/v1/outbound/api/v1/campaign/create-campaign

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

{
    "campaign": {
        "name": "abcd",
        "type": "voice"
    },
    "dialer": {
        "max_retry": "3",
        "time_out_dialing": "90000",
        "frequency": "5",
        "time_btw_retries": "10",
        "bot_key": "abcdefghijk1234567890abcdefghijklmnopqrstuvw",
        "caller_id": "123455678"
    },
    "scheduler": {
        "timezone": "Australia/sydney",
        "start_time": "2023-01-11 10:50:51",
        "end_time": "2023-01-15 15:46:27",
        "weekdays": "monday,tuesday,saturday"
    },
    "created_by": "abcd@call-ai.com",
    "tenant_id": "tenant_12345"
}

Response Variables

Response Schema

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

Update Campaign

This API will update the campaign information that is linked with the given campaign ID and tenant ID.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

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

{
    "campaign_name": "abcde",
    "modified_by": "abcd@call-ai.com",
    "status": "active",
    "type": "voice"
}

Response Schema

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

Update Scheduler

Using the provided API, you can modify the schedule of a campaign, such as its start and end dates, as well as the days of the week when the campaign will be active. Simply provide the campaign ID and tenant ID along with the updated schedule details to make the changes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/scheduler/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/scheduler/{tenant_id}/{campaign_id}

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

{
    "tenant_id": "tenant_12345",
    "modified_by": "abcd@call-ai.com",
    "timezone": "Australia/sydney",
    "start_time": "2023-01-11T10:50:51Z",
    "end_time": "2023-01-15T15:46:27Z",
    "campaign_id": "99",
    "weekdays": "monday,tuesday,wednesday,thursday,friday,saturday"
}

Response Variables

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

Response Schema

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

Update Dialer

Using the provided API, you have the capability to make changes to an existing dialer configuration. This involves modifying the attached bot for a specific campaign, allowing you to update the automated interaction that occurs when customers are reached. Additionally, you can specify the number of retry attempts to be made when a customer does not answer the call.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/update-interactive-dialer

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

{
    "ivr_type": "interactive",
    "max_retry": "2",
    "time_out_dialing": "90000",
    "frequency": "5",
    "time_btw_retries": "10",
    "bot_key": "L0ed2cb3haKNxSRZySVqWQVDWBED30Vi829",
    "caller_id": "12073000031",
    "tenant_id": "tenant_12345",
    "campaign_id": "99",
    "modified_by": "abcd@call-ai.com"
}

Response Variables

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

Response Schema

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

Update Call Status For a Number

TBy using this API, the call status of a specific number in the Dialer Base can be updated.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/number-status

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "phone_number": "1234567",
    "dial_base_id": "1234",
    "call_status": "dialing"
}

Response Variables

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

Response Schema

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

Update DialOut time for a Number

Using the ID associated with a number in the dialer base, this API enables the updating of the dial-out time for that number.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/dialouttime

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "id": "1234",
    "dial_out_time": "2023-05-23T05:41:18Z"
}

Response Variables

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

Response Schema

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

Fetch List Campaign

This API serves as a comprehensive source of information for all campaigns. It grants users the ability to retrieve and access details, data, and insights related to any campaign that exists within its scope. By utilizing this API, users can obtain a wide range of information, such as campaign metrics, performance statistics, target audience demographics, advertising strategies, and other relevant data points. This extensive access empowers users to gather valuable insights and make informed decisions based on the information available through the API.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

Response Variables

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

Response Schema

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

Fetch Single Campaign

When using an API (Application Programming Interface) to retrieve campaign information, you can utilize a campaign ID to specify which campaign's information you want to retrieve.

The API will respond to your request with the campaign information associated with the provided campaign ID and you can parse the data and extract the relevant campaign information based on your needs.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/single-campaign/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Delete Campaign

The delete campaign API allows you to remove a campaign from the system. You need to provide the campaign ID as a parameter or in the request payload, and authenticate the request using appropriate credentials. Once the API processes the request, the specified campaign will be permanently deleted from the system.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

DELETE https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Fetch List Dialer Base

Using this API, you can retrieve the foundational information of a dialer associated with a specific campaign ID and tenant ID. The dialer base encompasses crucial details, including the uploaded contacts for outreach. By leveraging this API, you can access and manage the contacts within the dialer base, enabling efficient and targeted outreach efforts for your campaign.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Upload Contact in DialerBase By phonebook Id

Using this API, all contacts that are associated with the phonebook ID can be retrieved and then added to the Dialer Basefor outreach purposes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/contact-copy

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/campaign-ms/v1/outbound/api/v1/dialer-base/contact-copy

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "email": "abcd@call-ai.com",
    "phone_book_id": "1"
}

Response Variables

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

Response Schema

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

Upload Individual Contact in DialerBase

With the help of this API, a single contact can be uploaded to the Dialer Basefor outreach purposes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/ind-contact-upload

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/campaign-ms/v1/outbound/api/v1/dialer-base/ind-contact-upload

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "email": "abcd@call-ai.com",
    "phone_book_id": "abc",
    "contact_meta": [{
        "name": "abcd",
        "phone_number": "12345678",
        "dial_out_time": "2023-01-12T13:35:38Z"
    }]
}

Response Variables

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

Response Schema

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

Upload Contacts in DialerBase through xlsx file For Outreach

By utilizing an XLSX file, this API allows for the uploading of contacts to the Dialer Baseto facilitate outreach efforts.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/contact-upload?tenant_id={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 Param)

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

Request Variables (Body Form-Data)

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

Response Schema

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

Create Campaign

Using this API, you have the ability to utilize campaign creation and scheduling features. It allows you to set specific dates, times, and days of the week for your campaigns to run. Additionally, you can integrate a dialer into your campaigns, and even attach a bot that will guide the outreach calls. Furthermore, you can configure the number of retry attempts for situations when customers don't answer the calls.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/create-campaign

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/campaign-ms/v1/outbound/api/v1/campaign/create-campaign

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

{
    "campaign": {
        "name": "abcd",
        "type": "voice"
    },
    "dialer": {
        "max_retry": "3",
        "time_out_dialing": "90000",
        "frequency": "5",
        "time_btw_retries": "10",
        "bot_key": "abcdefghijk1234567890abcdefghijklmnopqrstuvw",
        "caller_id": "123455678"
    },
    "scheduler": {
        "timezone": "Australia/sydney",
        "start_time": "2023-01-11 10:50:51",
        "end_time": "2023-01-15 15:46:27",
        "weekdays": "monday,tuesday,saturday"
    },
    "created_by": "abcd@call-ai.com",
    "tenant_id": "tenant_12345"
}

Response Variables

Response Schema

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

Update Campaign

This API will update the campaign information that is linked with the given campaign ID and tenant ID.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

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

{
    "campaign_name": "abcde",
    "modified_by": "abcd@call-ai.com",
    "status": "active",
    "type": "voice"
}

Response Schema

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

Update Scheduler

Using the provided API, you can modify the schedule of a campaign, such as its start and end dates, as well as the days of the week when the campaign will be active. Simply provide the campaign ID and tenant ID along with the updated schedule details to make the changes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/scheduler/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/scheduler/{tenant_id}/{campaign_id}

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

{
    "tenant_id": "tenant_12345",
    "modified_by": "abcd@call-ai.com",
    "timezone": "Australia/sydney",
    "start_time": "2023-01-11T10:50:51Z",
    "end_time": "2023-01-15T15:46:27Z",
    "campaign_id": "99",
    "weekdays": "monday,tuesday,wednesday,thursday,friday,saturday"
}

Response Variables

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

Response Schema

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

Update Dialer

Using the provided API, you have the capability to make changes to an existing dialer configuration. This involves modifying the attached bot for a specific campaign, allowing you to update the automated interaction that occurs when customers are reached. Additionally, you can specify the number of retry attempts to be made when a customer does not answer the call.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/update-interactive-dialer

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

{
    "ivr_type": "interactive",
    "max_retry": "2",
    "time_out_dialing": "90000",
    "frequency": "5",
    "time_btw_retries": "10",
    "bot_key": "L0ed2cb3haKNxSRZySVqWQVDWBED30Vi829",
    "caller_id": "12073000031",
    "tenant_id": "tenant_12345",
    "campaign_id": "99",
    "modified_by": "abcd@call-ai.com"
}

Response Variables

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

Response Schema

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

Update Call Status For a Number

TBy using this API, the call status of a specific number in the Dialer Base can be updated.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/number-status

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "phone_number": "1234567",
    "dial_base_id": "1234",
    "call_status": "dialing"
}

Response Variables

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

Response Schema

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

Update DialOut time for a Number

Using the ID associated with a number in the dialer base, this API enables the updating of the dial-out time for that number.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/dialouttime

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "id": "1234",
    "dial_out_time": "2023-05-23T05:41:18Z"
}

Response Variables

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

Response Schema

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

Fetch List Campaign

This API serves as a comprehensive source of information for all campaigns. It grants users the ability to retrieve and access details, data, and insights related to any campaign that exists within its scope. By utilizing this API, users can obtain a wide range of information, such as campaign metrics, performance statistics, target audience demographics, advertising strategies, and other relevant data points. This extensive access empowers users to gather valuable insights and make informed decisions based on the information available through the API.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{page_size}/{page_index}

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

Response Variables

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

Response Schema

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

Fetch Single Campaign

When using an API (Application Programming Interface) to retrieve campaign information, you can utilize a campaign ID to specify which campaign's information you want to retrieve.

The API will respond to your request with the campaign information associated with the provided campaign ID and you can parse the data and extract the relevant campaign information based on your needs.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer/single-campaign/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Delete Campaign

The delete campaign API allows you to remove a campaign from the system. You need to provide the campaign ID as a parameter or in the request payload, and authenticate the request using appropriate credentials. Once the API processes the request, the specified campaign will be permanently deleted from the system.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

DELETE https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/campaign/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Fetch List Dialer Base

Using this API, you can retrieve the foundational information of a dialer associated with a specific campaign ID and tenant ID. The dialer base encompasses crucial details, including the uploaded contacts for outreach. By leveraging this API, you can access and manage the contacts within the dialer base, enabling efficient and targeted outreach efforts for your campaign.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/{tenant_id}/{campaign_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/{tenant_id}/{campaign_id}

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

Response Variables

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

Response Schema

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

Upload Contact in DialerBase By phonebook Id

Using this API, all contacts that are associated with the phonebook ID can be retrieved and then added to the Dialer Basefor outreach purposes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/contact-copy

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/campaign-ms/v1/outbound/api/v1/dialer-base/contact-copy

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "email": "abcd@call-ai.com",
    "phone_book_id": "1"
}

Response Variables

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

Response Schema

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

Upload Individual Contact in DialerBase

With the help of this API, a single contact can be uploaded to the Dialer Basefor outreach purposes.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/ind-contact-upload

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/campaign-ms/v1/outbound/api/v1/dialer-base/ind-contact-upload

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

{
    "tenant_id": "tenant_12345",
    "campaign_id": "123",
    "email": "abcd@call-ai.com",
    "phone_book_id": "abc",
    "contact_meta": [{
        "name": "abcd",
        "phone_number": "12345678",
        "dial_out_time": "2023-01-12T13:35:38Z"
    }]
}

Response Variables

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

Response Schema

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

Upload Contacts in DialerBase through xlsx file For Outreach

By utilizing an XLSX file, this API allows for the uploading of contacts to the Dialer Baseto facilitate outreach efforts.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/dialer-base/contact-upload?tenant_id={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 Param)

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

Request Variables (Body Form-Data)

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

Response Schema

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

Create Phonebook

With this API, you can create a phone book that contains multiple contacts.

• The phonebook feature provides a convenient way to manage and organize contacts for campaign outreach by allowing users to upload them to the dialer base.
• Whether adding contacts individually or in bulk using an XLSX file, the phonebook feature streamlines the process of populating the dialer base, saving time and effort in preparing for campaign outreach activities.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook

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 parameters:

Sample Request

POST https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook

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

{
    "phonebook": {
        "name": "kirat",
        "description": "singh",
        "created_by": "abcd@call-ai.com"
    },
    "tenant_id": "tenant_12345"
}

Response Schema

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

List Phonebook

Using this API, you can retrieve all phone books associated with the given tenant ID.

• The API allows you to retrieve all the phonebooks associated with a customer, providing a comprehensive overview of the available contact lists.
• By utilizing the API, you can seamlessly upload any desired phonebook into the dialer base, empowering effective campaign outreach by leveraging the specific contacts contained within the uploaded phonebook.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{pageIndex}/{pageSize}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{pageIndex}/{pageSize}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Fetch Phonebook

Using this API, you can search for a phonebook ID based on the given parameters and retrieve it.

• With this API, you can retrieve phone books based on specific criteria such as names and descriptions. By providing the desired name or description in your request, you can retrieve phone books that match the given criteria. This capability allows you to efficiently filter and access phone books that are relevant to your campaign outreach.
• Once you have retrieved the desired phone book, you can make modifications to it using the API. This includes updating its name, description, or other attributes as required. By leveraging the provided functionalities, you can tailor the phone book to suit your campaign outreach needs, ensuring accurate and effective communication with the intended audience.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/search/{key}/{value}/{tenant_id}/{pageIndex}/{pageSize}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/search/{key}/{value}/{tenant_id}/{pageIndex}/{pageSize}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Fetch Phonebook by ID

Using this API, you can retrieve a single phone book associated with the specified phone book ID and tenant ID.

• The API allows you to fetch a single phone book based on the provided phone book ID and tenant ID. This means you can retrieve specific phone book data by specifying the unique identifiers associated with it.
• By making a request to the API, you can retrieve the details of a phone book that corresponds to the given phone book ID and tenant ID. This enables you to access the specific phone book you need, allowing for targeted retrieval of phone book information.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{id}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Update Phonebook

This API allows you to make modifications to an existing phone book, such as changing its name and description, by providing the phone book ID.

• Using this API, you can update an existing phone book by providing its unique identifier, known as the phone book ID. By including the phone book ID in your request, you can specifically target the phone book you wish to modify.
• The API allows you to make changes to various attributes of the phone book, such as its name and description. By specifying the desired modifications in your request, you can /ieffectively update the corresponding phone book with the new information, enabling you to manage and customize phone book details as needed.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook

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 parameters:

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook

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

{
    "phonebook": {
        "id": "32",
        "name": "kirat",
        "description": "singh",
        "modified_by": "abcd@call-ai.com"
    },
    "tenant_id": "tenant_12345"
}

Response Schema

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

Delete Phonebook

Using this API, you can delete a phone book and all contacts associated with the specified phone book ID will also be removed.

• The API allows you to delete a phone book by specifying its unique identifier, known as the phone book ID. When you invoke the delete, operation using the API, the specified phone book will be permanently removed from the system.
• When a phone book is deleted using the API, all contacts associated with that particular phone book ID will also be permanently removed. This means that the contacts cannot be recovered once the deletion process is complete. It's important to exercise caution when performing this operation to ensure that unintended data loss does not occur.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

DELETE https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/phonebook/{tenant_id}/{id}

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

{
    "tenant_id": "tenant_12345",
    "id": "32"
}

Response Schema

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

Create Contact

This API allows you to create a new contact within a specific phonebook associated with a given phonebook ID and tenant ID. When the phonebook is uploaded into the campaign, this contact will be included for outreach.

• The API enables the creation of contacts within phonebooks by providing a specific phonebook ID and tenant ID. These contacts can then be included in outreach campaigns once the phonebook is uploaded.
• With this API, you can easily add new contacts to a designated phonebook using the associated phonebook ID and tenant ID. These contacts will be seamlessly integrated into your outreach efforts once the phonebook is uploaded into the campaign.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact

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 b Response variables

After the execution of the API, you will get the following response variables:

Sample Request

POST https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact

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

{
    "contact": {
        "phone_book_id": "9",
        "name": "kirat",
        "phone_number": "12345677",
        "metadata": "",
        "created_by": "abcd@call-ai.com"
    },
    "tenant_id": "tenant_12345"
}

Response Schema

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

List Contact

This API allows you to list all the contacts that are associated with the provided tenant ID.

• The API supports the ability to list all contacts associated with a specific tenant ID. This functionality allows users to retrieve a comprehensive list of contacts linked to their organization or specific campaign.
• By combining the two functionalities mentioned earlier, users can effectively manage their contacts within phonebooks. They can create new contacts using the first API, associate them with a specific phonebook using the phonebook ID and tenant ID, and then retrieve a list of all contacts associated with that tenant ID using the second API. This provides a seamless workflow for managing and organizing contacts for outreach campaigns.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/{tenant_id}/{phonebook_id}/{pageIndex}/{pageSize}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/{tenant_id}/{phonebook_id}/{pageIndex}/{pageSize}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Fetch Contact

Using this API, you can search for and retrieve contacts based on the provided parameters.

• The API offers the capability to search and retrieve contacts based on specific parameters. This feature allows users to perform targeted searches and retrieve only the contacts that meet certain criteria or match specific search parameters.
• By utilizing the search functionality of the API in conjunction with the previously mentioned functionalities, users can efficiently manage their contacts. They can create new contacts, associate them with phonebooks, and then perform targeted searches to retrieve contacts that match specific criteria or requirements. This empowers users to effectively filter and retrieve the contacts they need for their outreach campaigns.

Endpoint URL

https://api.call-ai.com/token/v1/auth/api/v1/authentication/get-auth-token/{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 Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/search/{tenant_id}/{phonebook_id}/{key}/{value}/{pageIndex}/{pageSize}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Fetch Contact by ID

Using this API, you can retrieve a single contact associated with the provided contact ID and tenant ID.

• The API provides the capability to retrieve a single contact by specifying the contact ID and the associated tenant ID. This feature enables users to fetch specific contact information based on their unique identifiers, allowing for precise access to individual contacts within the system.
• Combining the contact retrieval functionality with the other features mentioned earlier, users can efficiently manage their contacts. They can create new contacts, associate them with phonebooks, search and filter contacts based on parameters, and finally retrieve specific contacts using their unique contact ID and associated tenant ID. This comprehensive set of functionalities ensures effective control and access to contacts for various outreach campaigns and organizational needs.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/byId/{tenant_id}/{contact_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Sample Request

GET https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/byId/{tenant_id}/{contact_id}

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

Response Variables

After the execution of the API, you will get the following response variables:

Response Schema

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

Update Contact

Using this API, you can modify existing contacts associated with a phonebook by changing their name or phone numbers.

• The API allows users to modify existing contacts associated with a phonebook. This functionality enables users to make changes to contact information such as the contact's name or phone numbers, ensuring accurate and up-to-date data within their phonebook.
• By utilizing the contact modification feature of the API along with the other functionalities mentioned earlier, users can have full control over their contact management. They can create new contacts, associate them with phonebooks, search for specific contacts, retrieve individual contacts by their unique identifiers, and now modify existing contacts as needed. This comprehensive set of capabilities provides a robust framework for efficient contact management and customization to meet the requirements of outreach campaigns and organizational needs.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact

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 b Response variables

After the execution of the API, you will get the following response variables:

Sample Request

PATCH https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact

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

{
    "contact": {
        "contact_id": "24",
        "name": "kirat",
        "phone_number": "12345677",
        "modified_by": "abcd@call-ai.com"
    },
    "tenant_id": "tenant_12345"
}

Response Schema

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

Upload Contact Xlsx File

Using this API, you can upload multiple contacts associated with a single phonebook through an XLSX file. When the phonebook is uploaded into the campaign, these contacts will be included for outreach.

• The API supports the ability to upload multiple contacts associated with a single phonebook using an XLSX file. This feature provides a convenient and efficient way to import a large number of contacts into the system at once, saving time and effort in manually entering each contact individually.
• By leveraging the contact upload functionality of the API, users can easily add multiple contacts to a phonebook in bulk. These contacts, included in the uploaded XLSX file, will be seamlessly integrated into the campaign for outreach purposes. This streamlined process simplifies the management of a large number of contacts and ensures they are readily available for effective outreach campaigns.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact-upload?tenant_id={tenant_id}&phonebook_id={phonebook_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

Response Schema

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

Delete Contact

Using this API, you can delete the contact associated with the provided contact.

• The API offers the capability to delete a specific contact associated with the provided contact ID. This functionality allows users to remove unwanted or outdated contacts from their phonebooks, ensuring the accuracy and relevancy of the contact data.
• By combining the contact deletion feature with the other functionalities mentioned earlier, users have complete control over their contact management. They can create new contacts, associate them with phonebooks, search for specific contacts, retrieve individual contacts, modify contact information, and now delete contacts when needed. This comprehensive set of capabilities empowers users to maintain a clean and up-to-date contact database, optimizing their outreach campaigns and organizational efficiency.

Endpoint URL

https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/{tenant_id}/{contact_id}

Request Variables (Header Params)

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

Request Variables (Path Param)

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

Request Variables (Body Param)

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

Sample Request

DELETE https://api.call-ai.com/campaign-ms/v1/outbound/api/v1/directory/contact/{tenant_id}/{contact_id}

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

{
    "tenant_id": "tenant_12345",
    "id": "24"
}

Response Schema

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

API Reference

API Reference

Message Privacy

Message Privacy