Overview

The Call-Ai Digital Virtual Agent API's allows developers to seamlessly create and configure virtual agents using predefined Call-Ai templates which can be customized as per your process requirements. It provides an RESTful API's to create, manage, and customize virtual agents.

Call-ai DVA Template

This API endpoint retrieves a list of all available Digital virtual agent templates.

• The Digital Virtual Agent (DVA) offers users the flexibility to modify slots, webhooks, and utterances, allowing for customization and adaptation of the virtual agent's behavior to meet specific requirements.
• Users can define and manage variables through slot modifications, integrate external services through webhooks, and shape the language and responses of the virtual agent by fine-tuning utterances, providing control and versatility in creating a tailored virtual agent experience.

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot/template/bots

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-dva/v1/basic/api/v1/bot/template/bots

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

Response Variable

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:

Create DVA

This API endpoint allows you to create a new Digital virtual Agent.

• The Digital Virtual Agent (DVA) offers users the flexibility to modify slots, webhooks, and utterances, allowing for customization and adaptation of the virtual agent's behaviour to meet specific requirements.
• Users can define and manage variables through slot modifications, integrate external services through webhooks, and shape the language and responses of the virtual agent by fine-tuning utterances, providing control and versatility in creating a tailored virtual agent experience.

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot/create

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-dva/v1/basic/api/v1/bot/create

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

{
    "bot": {
        "template_id": "ssdc213vnvn",
        "customer_nam"adbc",
        "bot_name": "abcd",
        "webhook": "http://31.228.104.43:8896/webhooks/rest/webhook",
        "slots": [{
            "seq_no": "123",
            "slot_name": "abcd",
            "display_name": "abcd",
            "slot_utterance": "abcd",
            "is_mandatory": true,
            "utterance_updatable": true,
            "is_enabled": true
        }],
        "created_by": "admin@123gmail.com",
        "end_webhook": {
            "is_enabled": true,
            "url": "http://37.228.104.43:8896/webhooks/rest/webhook"
        },
        "fhir_specs": {
            "client_id": "123354",
            "secret_key": "as123zx",
            "url": "http://abcd.com",
            "fhir_resource_name": "abcd"
        }
    },
    "tenant_id": "tenant_12345"
}
                      

Response Variable

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:

List Your DVA

This API endpoint retrieves a list of all virtual agent by its tenant ID.

• The Digital Virtual Agent (DVA) offers users the flexibility to modify slots, webhooks, and utterances, allowing for customization and adaptation of the virtual agent's behaviour to meet specific requirements.
• Users can define and manage variables through slot modifications, integrate external services through webhooks, and shape the language and responses of the virtual agent by fine-tuning utterances, providing control and versatility in creating a tailored virtual agent experience.

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot

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-dva/v1/basic/api/v1/bot

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

{
    "tenant_id": "tenant_12345",
    "itemsPerPage": 5,
    "pageIndex": 0
}
                  

Response Variable

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:

Attach Number

This endpoint 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-dva/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 Params)

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

Sample Request

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

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:

De-Attach Number

This endpoint allows you to deattach a phone number from a virtual agent. Once the number is deattached, the virtual agent will no longer receive messages sent to that number.

Endpoint URL

https://api.call-ai.com/basic-dva/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 Params)

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

Sample Request

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

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:

Get Details of DVA

Retrieves the configuration information for the specified virtual agent identified by {bot_id}.

• The Digital Virtual Agent (DVA) offers users the flexibility to modify slots, webhooks, and utterances, allowing for customization and adaptation of the virtual agent's behavior to meet specific requirements.
• Users can define and manage variables through slot modifications, integrate external services through webhooks, and shape the language and responses of the virtual agent by fine-tuning utterances, providing control and versatility in creating a tailored virtual agent experience.
````

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot/{bot_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-dva/v1/basic/api/v1/bot/{bot_id}

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

Response Variable

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 DVA

This API endpoint allows you to update a virtual agent.

• The Digital Virtual Agent (DVA) offers users the flexibility to modify slots, webhooks, and utterances, allowing for customization and adaptation of the virtual agent's behaviour to meet specific requirements.
• Users can define and manage variables through slot modifications, integrate external services through webhooks, and shape the language and responses of the virtual agent by fine-tuning utterances, providing control and versatility in creating a tailored virtual agent experience.

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot

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-dva/v1/basic/api/v1/bot

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

{
    "bot": {
        "customer_name": "abcd",
        "bot_name": "abcd",
        "slots": [{
            "seq_no": "123",
            "slot_name": "abcd",
            "display_name": "abcd",
            "slot_utterance": "abcd",
            "is_mandatory": true,
            "utterance_updatable": true,
            "is_enabled": true
        }],
        "updated_by": "admin@123gmail.com",
        "end_webhook": {
            "is_enabled": true,
            "url": "http://37.228.104.43:8896/webhooks/rest/webhook"
        },
        "fhir_specs": {
            "client_id": "123354",
            "secret_key": "as123zx",
            "url": "http://abcd.com",
            "fhir_resource_name": "abcd"
        }
    },
    "tenant_id": "tenant_12345",
    "bot_id": "sfsdjfds32534dvds5sdfh",
    "is_bot_name_updated": true
}
                      

Response Variable

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 DVA

This API endpoint allows you to delete a virtual agent.

Endpoint URL

https://api.call-ai.com/basic-dva/v1/basic/api/v1/bot

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-dva/v1/basic/api/v1/bot

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

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

Response Variable

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: