Calls API Documentation

Base URLs

    – Production: https://api.callease.ai/api/v1

Authentication

All endpoints require Bearer token authentication:

Authorization: Bearer <API KEY>

Endpoints

Make a Call

POST /calls

Create a new outbound call.

Request Body:

				
					{

    "assistant_id": "id",

    "name": "string",

    "phoneNumber": "string",

    "customVariables": [

        {

            "key": "string",

            "value": "string"

        }

    ]

}

				
			

Example Request:

				
					{

    "assistant_id": "CE_3228070481",

    "name": "John",

    "phoneNumber": "+123456789",

    "customVariables": [

        {

            "key": "name",

            "value": "John"

        },

        {

            "key": "cal_email", 

            "value": "abc@email.com"

        }

    ]

}

				
			

Get Call Details

GET /calls

Retrieve call details.

Response: Returns call information in JSON format.

  • Phone numbers should be in E.164 format
  • Custom variables are optional key-value pairs for call customization
  • Assistant ID must be a valid ID

Actions API Documentation

Base URL: https://api.callease.ai/api/v1

All endpoints require Bearer token authentication.

Endpoints

Create Action

POST /actions

Create a new action with SMS capabilities.

Request Body: 

				
					{

    "SEND_SMS": {

        "content": "message content",

        "instructions": "message instructions"

    }

}

				
			

List Actions

GET /actions

Retrieve a list of all actions.

Get Actions

GET /actions/{action_id}

Get details of a specific action.

Update Actions

PUT /actions/{action_id}

Update an existing action.

Request Body:

				
					{

    "SEND_SMS": {

        "content": "SMS CONTENT HERE",

        "instructions": "SMS CONDITION HERE" 

    }

}

				
			

Delete Actions

DELETE /actions/{action_id}

Delete a specific action.

Attach Actions

POST /actions/attach

Attach actions to an assistant.

Request Body:

				
					{

    "assistant_id": "assistant-d",

    "actions": [

        "action-id"

    ]

}

				
			

Dettach Actions

POST /actions/detach

Detach actions from an assistant.

				
					{

    "assistant_id": "assistant-id", 

    "actions": [

        "action-id-1",

        "action-id-2"

    ]

}

				
			

Data Handling and Security Documentation for Callease.ai Conversational AI WebApp

This document outlines the security practices and data handling measures implemented in Callease.ai, which uses third-party services, Large Language Models (LLM), and third-party VoIP services (such as Twilio), and is hosted on trusted third-party cloud service. The goal is to ensure that data privacy, security, and compliance are maintained throughout the system architecture.

Overview

Callease.ai is designed to provide users with conversational AI capabilities. The system integrates multiple third-party services, including:

  • Large Language Models (LLMs): Used for natural language processing, and is fine-tuned based on user requirements.
  • Twilio: Used for voice, messaging, and communication services.
  • Trusted Third-Party Cloud Service: Used for data storage, processing, and deployment.

The data flowing through the system is handled with the utmost security. This document specifies how data is handled, processed, stored, and protected throughout the web application’s architecture.

Data Collection and Processing

Types of Data Collected

Callease.ai collects several types of data from users and systems:

  • Personal Data: Name, email, phone number, address, and any other information users provide directly via the web application.
  • Conversational Data: Text or voice input from users (e.g., prompts or voice interactions).
  • Third-Party Service Data: Data generated or received from integrated services like Twilio (e.g., phone numbers, message history, call records).

Data Flow and Handling

  1. User Interaction with WebApp: Users interact with the conversational AI system, sending input via text or voice.
  2. LLM Processing: The input data is sent to the LLM service, where it is processed to generate a response. As the LLM is fine-tuned, it may retain some input data to improve the accuracy of future responses.
  3. Twilio Integration: In case of voice calls or messages, Twilio processes the data (e.g., call recordings, phone numbers, and message history).
  4. Trusted Third-Party Cloud Service: All data from interactions (including conversational logs and metadata) are stored securely on cloud.

Data Retention

Data retention policies vary by data type:

  • Conversation Logs: Stored temporarily for processing and improving user experience. Logs may be kept for a defined period (e.g., 30 days) and are anonymized or deleted after the retention period.
  • Personal Data: Retained based on user consent and business requirements. Can be deleted upon user request.
  • Call and Message Data from Twilio: Stored as per Twilio’s retention policies (typically for 30 days).

Data Minimization

Data collected is kept to the minimum necessary for the system’s operations. Personal and sensitive data is only processed when explicitly required for functionality (e.g., sending a voice message via Twilio or customizing conversational AI responses).

Third-Party Services

LLM Integration

As we’ve fine-tuned a third-party LLM, input data may be transmitted to and processed by the third-party models. To ensure privacy:

  • Data sent to third-party LLMs is anonymized, and only essential data is transmitted.
  • Sensitive or personally identifiable information (PII) is avoided unless required for the functionality.
  • The fine-tuning process may use user data in aggregate form, where specific user identifiers are not retained or used unless explicitly consented by the user.

Twilio Integration

Callease.ai integrates with Twilio to enable voice, messaging, and communication features. Twilio handles communication data (e.g., phone numbers, text messages, voice recordings), and security measures are as follows:

  • Data is encrypted during transmission using TLS.
  • Twilio ensures data privacy and has safeguards in place for secure call and message storage.
  • We limit access to Twilio’s data to authorized personnel only, with logging for auditing purposes.

Trusted Third-Party Cloud Service

Trusted Third-Party Cloud Service is used for hosting and managing the backend of the web application. The security measures in place include:

  • Data Encryption: Data in transit is encrypted using industry-standard encryption protocols (e.g.TLS for data in transit).
  • Access Control: IAM roles and policies are used to ensure that only authorized personnel and services have access to sensitive data and resources.
  • Data Backup and Recovery: Data is backed up regularly using cloud services, ensuring availability and disaster recovery.

Security Measures

Data Encryption

Encryption in Transit: All data exchanged between users, third-party services (e.g., Twilio, LLM), and the Cloud services is encrypted using TLS 1.2 or higher.

Authentication and Access Control

  • User Authentication: User authentication is implemented via secure token-based methods to prevent unauthorized access to user data.
  • Role-Based Access Control (RBAC): Employees and third-party service access are governed by RBAC, ensuring that only authorized users can access sensitive data.
  • API Security: All internal and external APIs are protected using secure authentication mechanisms (e.g., API keys, OAuth tokens).

User Privacy and Control

User Consent

Before collecting any personal or sensitive data, users are informed about the data collection and its purpose. Consent is obtained where required, and users are provided with options to manage their preferences.

Data Access and Deletion

Users can:

  • Request access to their data stored by the system.
  • Request the deletion of their personal data (except where retention is legally required).
  • Manage preferences related to data usage, such as opting out of data collection for fine-tuning purposes.

Incident Response and Breach Notification

In case of a data breach or security incident:

  • Incident Response Plan: We have a documented incident response plan that includes immediate containment, investigation, and notification procedures.
  • Breach Notification: In case of a breach involving personal data, affected users will be notified within 72 hours.

Conclusion

Callease.ai  is designed with strong security and data protection practices, utilizing industry standards for encryption, access control, and data minimization. By integrating with third-party services like LLMs, Twilio, and trusted cloud services, the system ensures that data is processed securely while maintaining compliance with privacy regulations.

This document serves as a comprehensive guide to the data handling and security policies implemented within the Callease.ai. Regular security audits and reviews will be conducted to ensure that data protection practices are up-to-date and effective.

Calls API Documentation

Base URLs

    – Production: https://api.callease.ai/api/v1

Authentication

All endpoints require Bearer token authentication:

Authorization: Bearer <API KEY>

Endpoints

Make a Call

POST /calls

Create a new outbound call.

Request Body:

				
					{

    "assistant_id": "id",

    "name": "string",

    "phoneNumber": "string",

    "customVariables": [

        {

            "key": "string",

            "value": "string"

        }

    ]

}

				
			

Example Request:

				
					{

    "assistant_id": "CE_3228070481",

    "name": "John",

    "phoneNumber": "+123456789",

    "customVariables": [

        {

            "key": "name",

            "value": "John"

        },

        {

            "key": "cal_email", 

            "value": "abc@email.com"

        }

    ]

}

				
			

Get Call Details

GET /calls

Retrieve call details.

Response: Returns call information in JSON format.

  • Phone numbers should be in E.164 format
  • Custom variables are optional key-value pairs for call customization
  • Assistant ID must be a valid ID

Actions API Documentation

Base URL: https://api.callease.ai/api/v1

All endpoints require Bearer token authentication.

Endpoints

Create Action

POST /actions

Create a new action with SMS capabilities.

Request Body: 

				
					{

    "SEND_SMS": {

        "content": "message content",

        "instructions": "message instructions"

    }

}

				
			

List Actions

GET /actions

Retrieve a list of all actions.

Get Actions

GET /actions/{action_id}

Get details of a specific action.

Update Actions

PUT /actions/{action_id}

Update an existing action.

Request Body:

				
					{

    "SEND_SMS": {

        "content": "SMS CONTENT HERE",

        "instructions": "SMS CONDITION HERE" 

    }

}

				
			

Delete Actions

DELETE /actions/{action_id}

Delete a specific action.

Attach Actions

POST /actions/attach

Attach actions to an assistant.

Request Body:

				
					{

    "assistant_id": "assistant-d",

    "actions": [

        "action-id"

    ]

}

				
			

Dettach Actions

POST /actions/detach

Detach actions from an assistant.

				
					{

    "assistant_id": "assistant-id", 

    "actions": [

        "action-id-1",

        "action-id-2"

    ]

}

				
			

Data Handling and Security Documentation for Callease.ai Conversational AI WebApp

This document outlines the security practices and data handling measures implemented in Callease.ai, which uses third-party services, Large Language Models (LLM), and third-party VoIP services (such as Twilio), and is hosted on trusted third-party cloud service. The goal is to ensure that data privacy, security, and compliance are maintained throughout the system architecture.

Overview

Callease.ai is designed to provide users with conversational AI capabilities. The system integrates multiple third-party services, including:

  • Large Language Models (LLMs): Used for natural language processing, and is fine-tuned based on user requirements.
  • Twilio: Used for voice, messaging, and communication services.
  • Trusted Third-Party Cloud Service: Used for data storage, processing, and deployment.

The data flowing through the system is handled with the utmost security. This document specifies how data is handled, processed, stored, and protected throughout the web application’s architecture.

Data Collection and Processing

Types of Data Collected

Callease.ai collects several types of data from users and systems:

  • Personal Data: Name, email, phone number, address, and any other information users provide directly via the web application.
  • Conversational Data: Text or voice input from users (e.g., prompts or voice interactions).
  • Third-Party Service Data: Data generated or received from integrated services like Twilio (e.g., phone numbers, message history, call records).

Data Flow and Handling

  1. User Interaction with WebApp: Users interact with the conversational AI system, sending input via text or voice.
  2. LLM Processing: The input data is sent to the LLM service, where it is processed to generate a response. As the LLM is fine-tuned, it may retain some input data to improve the accuracy of future responses.
  3. Twilio Integration: In case of voice calls or messages, Twilio processes the data (e.g., call recordings, phone numbers, and message history).
  4. Trusted Third-Party Cloud Service: All data from interactions (including conversational logs and metadata) are stored securely on cloud.

Data Retention

Data retention policies vary by data type:

  • Conversation Logs: Stored temporarily for processing and improving user experience. Logs may be kept for a defined period (e.g., 30 days) and are anonymized or deleted after the retention period.
  • Personal Data: Retained based on user consent and business requirements. Can be deleted upon user request.
  • Call and Message Data from Twilio: Stored as per Twilio’s retention policies (typically for 30 days).

Data Minimization

Data collected is kept to the minimum necessary for the system’s operations. Personal and sensitive data is only processed when explicitly required for functionality (e.g., sending a voice message via Twilio or customizing conversational AI responses).

Third-Party Services

LLM Integration

As we’ve fine-tuned a third-party LLM, input data may be transmitted to and processed by the third-party models. To ensure privacy:

  • Data sent to third-party LLMs is anonymized, and only essential data is transmitted.
  • Sensitive or personally identifiable information (PII) is avoided unless required for the functionality.
  • The fine-tuning process may use user data in aggregate form, where specific user identifiers are not retained or used unless explicitly consented by the user.

Twilio Integration

Callease.ai integrates with Twilio to enable voice, messaging, and communication features. Twilio handles communication data (e.g., phone numbers, text messages, voice recordings), and security measures are as follows:

  • Data is encrypted during transmission using TLS.
  • Twilio ensures data privacy and has safeguards in place for secure call and message storage.
  • We limit access to Twilio’s data to authorized personnel only, with logging for auditing purposes.

Trusted Third-Party Cloud Service

Trusted Third-Party Cloud Service is used for hosting and managing the backend of the web application. The security measures in place include:

  • Data Encryption: Data in transit is encrypted using industry-standard encryption protocols (e.g.TLS for data in transit).
  • Access Control: IAM roles and policies are used to ensure that only authorized personnel and services have access to sensitive data and resources.
  • Data Backup and Recovery: Data is backed up regularly using cloud services, ensuring availability and disaster recovery.

Security Measures

Data Encryption

Encryption in Transit: All data exchanged between users, third-party services (e.g., Twilio, LLM), and the Cloud services is encrypted using TLS 1.2 or higher.

Authentication and Access Control

  • User Authentication: User authentication is implemented via secure token-based methods to prevent unauthorized access to user data.
  • Role-Based Access Control (RBAC): Employees and third-party service access are governed by RBAC, ensuring that only authorized users can access sensitive data.
  • API Security: All internal and external APIs are protected using secure authentication mechanisms (e.g., API keys, OAuth tokens).

User Privacy and Control

User Consent

Before collecting any personal or sensitive data, users are informed about the data collection and its purpose. Consent is obtained where required, and users are provided with options to manage their preferences.

Data Access and Deletion

Users can:

  • Request access to their data stored by the system.
  • Request the deletion of their personal data (except where retention is legally required).
  • Manage preferences related to data usage, such as opting out of data collection for fine-tuning purposes.

Incident Response and Breach Notification

In case of a data breach or security incident:

  • Incident Response Plan: We have a documented incident response plan that includes immediate containment, investigation, and notification procedures.
  • Breach Notification: In case of a breach involving personal data, affected users will be notified within 72 hours.

Conclusion

Callease.ai  is designed with strong security and data protection practices, utilizing industry standards for encryption, access control, and data minimization. By integrating with third-party services like LLMs, Twilio, and trusted cloud services, the system ensures that data is processed securely while maintaining compliance with privacy regulations.

This document serves as a comprehensive guide to the data handling and security policies implemented within the Callease.ai. Regular security audits and reviews will be conducted to ensure that data protection practices are up-to-date and effective.

top
Seamless Integrations
Begin Now
Begin Now
Seamless Integrations

Inactive

Simplifying IT
for a complex world.
Platform partnerships