- Home
- /
- Callfluent API documentation
Table of Contents
Agent Services
- Base URL
- Authentication
- 1. Get Twilio Number List
- 2. Create a New Agent
- 3. Get All Agents in Workspace
- 4. Get Agent Details
- 5. Delete an Agent
- 6. Get an Agent’s Call History
- 7. Update an Agent
- 8. Upload an Agent’s Knowledge Base File
- 9. Delete an Agent’s Knowledge Base File
- 10. Delete an Agent’s Call
- 11. Hang Up an In-Progress Twilio Call
- 12. Create an Agent’s Custom Fields
- 13. Delete an Agent’s Custom Fields
- 14. Create a New Agent Action
- 15. Update an Agent Action
- 16. Delete an Agent Action
- 17. Set Agent’s CORS Origin
Call Services
Resource Services
CallFluent API documentation
CallFluent API Documentation Overview
The CallFluent API provides a comprehensive interface for managing AI-powered voice agents, workspaces, and user settings. This documentation covers all available endpoints to help developers integrate CallFluent’s capabilities into their applications.
API Base URL
All API requests should be made to:https://api.callfluent.ai/api
Authentication
All API requests require an API key in the Authorization header:Authorization: Bearer {api_key}
Main API Categories
Workspace Management
Endpoints for creating, managing, and organizing workspaces:
- Create, update, and delete workspaces
- Manage workspace members and invitations
- Configure workspace settings and integrations
- Retrieve workspace voice options
Read more about Workspace API endpoints
Agent Services
Endpoints for creating and managing AI voice agents:
- Create, configure, and delete agents
- Manage agent knowledge files
- Configure agent behaviors and responses
- Handle call recordings and history
- Set up agent actions (email, SMS, webhooks, etc.)
Read more about Agent Services
Call Services
Endpoints for making and managing calls:
- Initiate outbound calls
- Manage in-progress calls
- Retrieve call history
User Services
Endpoints for user account management:
- Update user profiles and settings
- Change passwords
- Configure SMTP settings
- Manage custom domains
Resource Services
Endpoints for retrieving system resources:
- Get timezone options
- Retrieve language lists
- Access agent tone options
- Get background noise options
Read more about Resource Services
Constants
Response Format
All successful API responses return JSON with a status: true field. Errors include a status: false field with error details.
Rate Limits
The API currently enforces standard rate limits. Contact support if you require higher limits.
Getting Started
To begin using the CallFluent API:
- Obtain your API key from the CallFluent dashboard
- Start with workspace creation
- Configure your agents
- Make your first call
For detailed implementation guides and code examples, explore our sub-category documentation.
Note: This documentation is regularly updated. Please check back for new features and endpoints.
Workspace Management
The Workspace API allows you to create, manage, and organize workspaces in CallFluent. Each workspace can contain multiple AI agents, members, and configurations.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
Workspace Endpoints
1. Create a New Workspace
POST: /workspace/create
Creates a new workspace with the given name.
Header
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name | string | true | Name of the new workspace | "First Workspace" |
Example Body
{
“name”: “First Workspace”
}
Example Request
curl -X POST https://api.callfluent.ai/api/workspace/create \
-H "Authorization: Bearer {api_key}" \
-H "Content-Type: application/json" \
-d '{"name": "First Workspace"}'
Response
- Example Success – 200
status code: 200: workspace list
{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 400 (Limit Error) – Workspace limit error.
workspace limit error: status code: 400
{
status: false,
error: "Workspace creation limit exceeded.",
message: "Please delete some before creating new ones.",
}
2. Get All Workspaces
GET: /workspace/get-all
Retrieves all workspaces.
Header
Authorization: Bearer {api_key}
Parameter
None
Example Request
curl -X GET https://api.callfluent.ai/api/workspace/get-all \
-H "Authorization: Bearer {api_key}"
Response
- Example Success
status code: 200: workspace list
{workspaces: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
3. Get Workspace Details
GET: /workspace/get/{id}
Retrieves details of a specific workspace.
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 1 |
Example Request
curl -X GET https://api.callfluent.ai/api/workspace/get/1 \
-H "Authorization: Bearer {api_key}"
Response
- Example Success
status code: 200: workspace detail
{status: true, data: workspaceInfo }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
4. Get Workspace Voice List
GET: /workspace/{id}/voices
Retrieves the available voice list for a workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 14 |
Example Request
curl -X GET https://api.callfluent.ai/api/workspace/14/voices \
-H "Authorization: Bearer {api_key}"
Response
- Example Success
status code: 200: workspace voice list
[
{
"value": "alloy",
"label": "Friendly and expressive male",
"brand": "openai"
},
{
"value": "echo",
"label": "Clear and natural male",
"brand": "openai"
}
]
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
5. Update Workspace
PUT: /workspace/update/{id}
Updates a workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 14 |
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name | string | false | Workspace name | "New Workspace" |
sid | string | false | Twilio SID | ACXXXXXXXX |
auth_token | string | false | Twilio auth token | b3a1dXXXX |
elevenlabs_key | string | false | ElevenLabs API key | sk_XXX |
openai_key | string | false | OpenAI API key | sk-proj-XXX |
maxMins | number | false | Workspace monthly limit minutes | 300 |
maxMembers | number | false | Max member count | 10 |
maxAgents | number | false | Max agent count | 6 |
Example Request
curl -X PUT https://api.callfluent.ai/api/workspace/update/14 \
-H "Authorization: Bearer {api_key}" \
-H "Content-Type: application/json" \
-d '{ "name": "New Workspace", "maxMins": 9999 }'
Response
- Example Success
status code: 200: workspace list
{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }
Errors
- 500 (Server error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
6. Invite User to Workspace
POST: /workspace/invite-user
Create a new guest and send an invite email.
Header
Authorization: Bearer {api_key}
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
workspace_id | number | true | Workspace ID | 14 |
email | string | true | Email of the new member | [email protected] |
Example Request
curl -X POST https://api.callfluent.ai/api/workspace/invite-user \
-H "Authorization: Bearer {api_key}" \
-H "Content-Type: application/json" \
-d '{ "workspace_id": 14, "email": "[email protected]" }'
Response
- Example Success
status code: 200: workspace list
{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
7. Delete Workspace Member
DELETE: /workspace/invite-delete/{id}
Deletes a member from the workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace user ID | 11 |
Example Request
curl -X DELETE https://api.callfluent.ai/api/workspace/invite-delete/11 \
-H "Authorization: Bearer {api_key}"
Response (Success – 200)
- Example Success
status code: 200: workspace list
{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
8. Delete a Workspace
DELETE: /workspace/delete/{id}
Deletes a workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 1 |
Example Request
curl -X DELETE https://api.callfluent.ai/api/workspace/delete/1 \
-H "Authorization: Bearer {api_key}"
Response
- Example Success
status code: 200: workspace list
{status: true, data: [ {id: 2, name: “second workspace} ] }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{ status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
9. Get GHL Calendar List
GET: /workspace/calendars/{id}
Retrieves the list of GHL calendars linked to the workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 1 |
Response
- Example Success
status code: 200: workspace list
{status: true, data: GHL_CALENDAR_LIST}
Errors
- 500 (Server Error) – Server error.
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
Conclusion
This covers all Workspace API endpoints for managing workspaces in CallFluent. For agent management, see the Agent Services Documentation.
Agent Services
The Agent Services API allows you to create, configure, and manage AI-powered voice agents within your CallFluent workspace. Agents can handle inbound/outbound calls, execute actions (email, SMS, webhooks), and integrate with third-party services.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
Agent Endpoints
1. Get Twilio Number List
GET: /agent/number-list/{id}/{agentType}
Retrieves the Twilio number list.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Workspace ID | 1 |
agentType | string | true | outbound or inbound | outbound |
Example Request
curl -X GET https://api.callfluent.ai/api/agent/number-list/1/outbound \
-H "Authorization: Bearer {api_key}"
Response
- Example Success
status code: 200: workspace list
{ status: true, data: number_list, agentNumMap: {used_number: used_avatar_url, …}}
number_list: [
{number: twlio_number, sid: twilio_sid, type: “twilio/verified”}
]
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
2. Create a New Agent
POST: /agent/create
Creates a new voice agent with customizable settings.
Header
Authorization: Bearer {api_key}
Request Body (agentPayload)
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
workspaceId | number | true | Workspace ID | 1 |
format | string | true | outbound/inbound | outbound |
timezone | string | true | Agent timezone | UTC+00:00 |
name | string | true | Agent name | Sales assistant |
avatar | string | XX | Public image URL/image’s base64 | https://... |
lang | string | true | Value of language list | en |
voice | string | true | Value of workspace voice | alloy |
phone_number | string | true (outbound) false (inbound) | Agent phone number | +123456789 |
welcome_msg_flag | boolean | false | Turn on/off welcome message | true |
welcome_msg | string | false | Turn on/off the welcome message | How are you today? |
welcome_msg_delay | number | false | Wait time (in seconds) before playing the welcome message | 3 |
call_recording | boolean | false | Enable call recording | true |
blocked_phone_types | string | false | Block phone type list | 1,2,3 |
enable_voice_mail | boolean | false | Enable machine detection | true |
voice_mail_mode | number | false | 1. Leave a voice message. 2. hang up the call | 1 |
voice_mail_text | string | false | 1. Leave a voice message. 2. Hang up the call | Please try again. |
machine_detection_timeout | number | false | Twilio machine detection timeout | 10 |
openai_model | string | false | OpenAI model name (only available when openAI key is valid) | gpt-4o |
answer_creativity | number | false | OpenAI temperature (0–10) | 3 |
context_max_tokens | number | false | OpenAI prompt max token count | 350 |
speech_stop_sensitivity | number | false | Word count that stops the agent’s speech (0-10) | 5 |
answer_length | number | false | Limit the maximum no. of words (approximatively) per answer | 25 |
silence_message_delay | number | false | Trigger the “are you there?” message after X seconds | 10 |
silence_end_call | number | false | End the call if there is no sound for XX seconds | 20 |
utterance_detection | number | false | How long to wait before an utterance ends (min 500ms) | 1000 |
transcribe_filler_words | boolean | false | Transcribe words like “hmm” or “uhm” | true |
agent_type | string | true | Agent type | sales |
background | string | true | Agent’s background | You are a support agent. |
goal | string | true | Agent’s goal | Support clients |
tone | string | true | Agent’s tone | Professional |
instructions | string | true | Agent’s instructions | |
script_option | boolean | false | Enable agent’s script | true |
script | text | false | Agent’s script | Enable the agent’s script |
background_sound | string | false | Background noise (only for browser call) | office-ambience.wav |
Example Request
curl -X POST https://api.callfluent.ai/api/agent/create \
-H "Authorization: Bearer {api_key}" \
-H "Content-Type: application/json" \
-d '{
"workspaceId": 1,
"format": "outbound",
"name": "Sales Bot",
"voice": "alloy",
"phone_number": "+123456789",
"agent_type": "sales",
"background": "You are a sales agent.",
"goal": "Close deals."
}'
Response
- Example Success
status code: 200: workspace list
{status: true, data: new_agent }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 400 (Bad Request) – Agent limit reached.
{
status: false,
msg: "You have reached limit.",
}
3. Get All Agents in Workspace
GET: /agent/get-all/{workspaceId}
Retrieves the agents’ list in a workspace.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
workspaceId | number | true | Workspace ID | 1 |
Response
- Example Success
status code: 200: workspace list
{"status": true, "data": "agent_list" }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
4. Get Agent Details
GET: /agent/get-one/{agentId}
Retrieves details for a specific agent.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
agentId | number | true | Agent ID | 1 |
Response
- Example Success
status code: 200: workspace list
{
status: true,
data: {
agent,
files,
totalCalls,
averageDuration
}
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
5. Delete an Agent
DELETE: /agent/delete/{agentId}
Deletes a specific agent.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
agentId | number | true | Agent ID | 11 |
Response
- Example Success
status code: 200: workspace list
{ status: true, data: agent_list }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
6. Get an Agent’s Call History
GET: /agent/{agentId}/calls
Gets an agent’s call history.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
agentId | number | true | Agent ID | 1 |
Query Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
page | number | false | Page number | 1 |
Response
- Example Success
status code: 200: workspace list
{
status: true,
data: calls
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
7. Update an Agent
PUT: /agent/update/{id}
Updates an agent.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Id | number | true | agent ID | 14 |
Request Body
{
Payload: agentPayload
}
agentPayload
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
workspaceId | number | true | Workspace ID | 1 |
format | string | true | outbound/inbound | outbound |
timezone | string | true | Agent timezone | UTC+00:00 |
name | string | true | Agent name | Sales assistant |
avatar | string | XX | Public image URL/image’s base64 | https://... |
lang | string | true | Value of language list | en |
voice | string | true | Value of workspace voice | alloy |
phone_number | string | true (outbound) false (inbound) | Agent phone number | +123456789 |
welcome_msg_flag | boolean | false | Turn on/off welcome message | true |
welcome_msg | string | false | Turn on/off the welcome message | How are you today? |
welcome_msg_delay | number | false | Wait time (in seconds) before playing the welcome message | 3 |
call_recording | boolean | false | Enable call recording | true |
blocked_phone_types | string | false | Block phone type list | 1,2,3 |
enable_voice_mail | boolean | false | Enable machine detection | true |
voice_mail_mode | number | false | 1. Leave a voice message. 2. hang up the call | 1 |
voice_mail_text | string | false | 1. Leave a voice message. 2. Hang up the call | Please try again. |
machine_detection_timeout | number | false | Twilio machine detection timeout | 10 |
openai_model | string | false | OpenAI model name (only available when openAI key is valid) | gpt-4o |
answer_creativity | number | false | OpenAI temperature (0–10) | 3 |
context_max_tokens | number | false | OpenAI prompt max token count | 350 |
speech_stop_sensitivity | number | false | Word count that stops the agent’s speech (0-10) | 5 |
answer_length | number | false | Limit the maximum no. of words (approximatively) per answer | 25 |
silence_message_delay | number | false | Trigger the “are you there?” message after X seconds | 10 |
silence_end_call | number | false | End the call if there is no sound for XX seconds | 20 |
utterance_detection | number | false | How long to wait before an utterance ends (min 500ms) | 1000 |
transcribe_filler_words | boolean | false | Transcribe words like “hmm” or “uhm” | true |
agent_type | string | true | Agent type | sales |
background | string | true | Agent’s background | You are a support agent. |
goal | string | true | Agent’s goal | Support clients |
tone | string | true | Agent’s tone | Professional |
instructions | string | true | Agent’s instructions | |
script_option | boolean | false | Enable agent’s script | true |
script | text | false | Agent’s script | Enable the agent’s script |
background_sound | string | false | Background noise (only for browser call) | office-ambience.wav |
Response
- Example Success
status code: 200: updated agent
{ status: true, data: updated_agent }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
8. Upload an Agent’s Knowledge Base File
PUT: /agent/knowledge/{id}
Upload an agent’s knowledge base file.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
agentId | number | true | Agent ID | 1 |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
files | binary | true | The file to be uploaded (Content-Type: multipart/form-data) |
Response
- Example Success
status code: 200: updated agent
{ status: true, data: agent_list }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
9. Delete an Agent’s Knowledge Base File
DELETE: /agent/knowledge/{id}
Deletes an agent’s knowledge base file.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Knowledge file ID | 11 |
Response
- Example Success
status code: 200: workspace list
{ status: true, data: agent_list }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
10. Delete an Agent’s Call
DELETE: /agent/delete-call/{call_id}
Deletes an agent’s call.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
call_id | number | true | Call ID | 11 |
Response
- Example Success
status code: 200: workspace list
{ status: true, data: agent_list }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
11. Hang Up an In-Progress Twilio Call
POST: /agent/hangup-call
Hangs up an in-progress Twilio call.
Header
Authorization: Bearer {api_key}
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
callid | number | true | Call ID | 1 |
Response
- Example Success
status code: 200: updated agent
{ status: true, data: agent_list }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
12. Create an Agent’s Custom Fields
PUT: /agent/custom-field/{id}
Creates an agent’s custom fields.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | number | true | Agent ID | 1 |
Body
{
data: custom_field
}
custom_field
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | create: false update: true | Field ID | d7d6946a-d90a-438e-954f-08cb5950d680 |
name | string | true | Field name | name |
label | string | true | Field description | Call’s name |
Response
- Example Success
status code: 200: workspace list
{ status: true, data: updated_custom_field }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
13. Delete an Agent’s Custom Fields
DELETE: /agent/remove-custom-fields/{agent_id}/{field_id}
Deletes an agent’s custom fields.
Header
Authorization: Bearer {api_key}
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
agent_id | number | true | Agent ID | 1 |
| field_id | number | true | Field ID | d7d6946a-d90a-438e-954f-08cb5950d680 |
Response
- Example Success
status code: 200: updated custom field
{ status: true, data: updated_custom_field }
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{status: false, error: error_message}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
14. Create a New Agent Action
POST: /agent/create-action
Creates a new action for a specified agent.
Header
Authorization: Bearer {api_key}
Request Body
{
payload: actionPayload
}
actionPayload Types
1. Send Email
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | sendEmail |
| name | string | true | Action name | Send email action |
| instruction | string | true | Instruction to trigger action | This is a test email |
| content | string | true | Email content | This is test email |
| subject | string | true | Email subject | Introduction email |
2. Call Forwarding
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | callForwarding |
| name | string | true | Action name | Call forwarding action |
| instruction | string | true | Instruction to trigger action | Forward to the phone number |
| forwardNumber | string | true | Forward to phone number | +1XXXXXXXX |
3. Send Text Message
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | sms |
| name | string | true | Action name | Sms action |
| instruction | string | true | Instruction to trigger action | Trigger when user wants sms |
| content | string | true | SMS content | It is test sms |
4. Webhook / Zapier
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | webhook |
| name | string | true | Action name | webhook action |
| webhook_url | string | true | Webhook URL | https://webhook-test/XXX |
| fields | string | true | JSON string of custom fields | [{"value":"dev1","label":"dev1"},{"value":"email","label":"email"}] |
5. Data Collection
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | dataCollection |
| name | string | true | Action name | Data collection action |
| instruction | string | true | Instruction to trigger action | Trigger when user shares his name |
| collectField | string | true | Field value of custom field |
6. Email Data Push
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | email_push |
| name | string | true | Action name | Email push action |
| target_email | string | true | Email address to push data | [email protected] |
| subject | string | true | Email subject | Call summary |
| fields | string | true | JSON string of custom fields | [{"value":"dev1","label":"dev1"},{"value":"email","label":"email"}] |
7. GHL Calendar
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | ghl_calendar |
| name | string | true | Action name | GHL meeting action |
| ghlCalendarId | string | true | GHL calendar ID | B6blCXXXXX |
| calendarPeriod | string | true | Date range for scheduling | 1week |
| instruction | string | true | Instruction to trigger action | Trigger when user want to schedule call |
8. Google Calendar
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agentId | number | true | Agent ID | 1 |
| actionType | string | true | Action type | google_calendar |
| name | string | true | Action name | GHL meeting action |
| google_title | string | true | Google meeting title | Introduction meeting |
| google_description | string | false | Google meeting description | |
| instruction | string | true | Instruction to trigger action | Trigger when user want to schedule call |
| calendarPeriod | string | true | Date range for scheduling | 1week |
| google_duration | string | true | Meeting duration | 30 mins |
Response
Example Success
status code: 200: created action
{
status: true,
data: created_action
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{
status: false,
error: error_message
}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
15. Update an Agent Action
POST: /agent/update-action/{actionId}
Updates an existing action for a specified agent.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionId | number | true | Action ID | 1 |
Request Body
actionPayload:
actionPayload Types
1. Send Email
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | sendEmail |
| name | string | true | Action name | Send email action |
| instruction | string | true | Instruction to trigger action | Trigger when user asks to send email |
| content | string | true | Email content | This is test email |
| subject | string | true | Email subject | Introduction email |
2. Call Forwarding
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | callForwarding |
| name | string | true | Action name | Call forwarding action |
| instruction | string | true | Instruction to trigger action | Trigger when user want to connect with a manager |
| forwardNumber | string | true | Forward to phone number | +1XXXXXXXX |
3. Send Text Message
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | sms |
| name | string | true | Action name | Sms action |
| instruction | string | true | Instruction to trigger action | Trigger when user wants sms |
| content | string | true | SMS content | It is a test SMS |
4. Webhook / Zapier
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | webhook |
| name | string | true | Action name | webhook action |
| webhook_url | string | true | Webhook URL | https://webhook-test/XXX |
| fields | string | true | JSON string of custom fields | [{"value":"dev1","label":"dev1"},{"value":"email","label":"email"}] |
5. Data Collection
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | dataCollection |
| name | string | true | Action name | Data collection action |
| instruction | string | true | Instruction to trigger action | Trigger when user shares his name |
| collectField | string | true | Field value of custom field |
6. Email Data Push
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | email_push |
| name | string | true | Action name | Email push action |
| target_email | string | true | Email address to push data | [email protected] |
| subject | string | true | Email subject | Call summary |
| fields | string | true | JSON string of custom fields | [{"value":"dev1","label":"dev1"},{"value":"email","label":"email"}] |
7. GHL Calendar
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | ghl_calendar |
| name | string | true | Action name | GHL meeting action |
| ghlCalendarId | string | true | GHL calendar ID | B6blCXXXXX |
| calendarPeriod | string | true | Date range for scheduling | 1week |
| instruction | string | true | Instruction to trigger action | Trigger when user want to schedule call |
8. Google Calendar
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionType | string | true | Action type | google_calendar |
| name | string | true | Action name | GHL meeting action |
| google_title | string | true | Google meeting title | Introduction meeting |
| google_description | string | false | Google meeting description | |
| instruction | string | true | Instruction to trigger action | Trigger when user want to schedule call |
| calendarPeriod | string | true | Date range for scheduling | 1week |
| google_duration | string | true | Meeting duration | 30 mins |
Response
Example Success
Status code: 200: created action
{
status: true,
data: created_action
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{
status: false,
error: error_message
}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
16. Delete an Agent Action
DELETE: /agent/delete-action/{actionId}
Deletes an existing action for a specified agent.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| actionId | number | true | Action ID | 1 |
Response
Example Success
Status code: 200: deleted action
{
status: true,
data: deleted_action
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{
status: false,
error: error_message
}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
17. Set Agent’s CORS Origin
PUT: /agent/webhook-cors-origin/{agent_id}
Sets the agent’s CORS origin.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agent_id | number | true | Agent ID | 1 |
Request Body
{
data: webhookPayload
}
webhookPayload
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| has_webhook_cors_origin | boolean | true | Enable CORS origin | true |
| webhook_cors_origin | array | true | Domains | [“https://google.com“, “https://yahoo.com“] |
Response
Example Success
Status code: 200: updated webhook
{
status: true,
data: updated_webhook
}
Errors
- 500 (Server Error) – Server error.
server error: status code: 500
{
status: false,
error: error_message
}
- 403 (Permission Error) – Permission error.
permission error: status code: 403
{
status: false,
msg: "Your account doesn't have the permission to access that page."
}
Conclusion
This covers all Agent Services API endpoints. For workspace management, refer to the Call Services Documentation.
Call Services
The Call Services API allows you to initiate outbound calls using your AI-powered agents within the CallFluent platform. You can also pass custom field data that the agent can reference during the call.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
1. Make a New Outbound Call
POST: /call/make-call/{agent_id}
Makes a new outbound call using the specified agent.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agent_id | number | true | Agent ID | 1 |
Request Body
{
data: webhookPayload
}
webhookPayload
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| phone_number | string | true | International phone number | +1 234 5678910 |
| […custom fields] | string | false | Custom fields (optional) | name, email, address, etc. |
Response
Example Success
Status code: 200: agent list
{
status: true,
data: agent_list
}
Errors
- 500 (Server Error) – Server error.
{
status: false,
error: error_message
}
Conclusion
This covers all Agent Services API endpoints. For managing your CallFluent workspace (creating users, updating settings, etc.), refer to the Workspace API Documentation.
Resource Services
Resource Services API
The Resource Services API is used to retrieve branding and configuration details for a specific CallFluent workspace based on a custom domain. This is useful for white-labeled portals, branded dashboards, or embedded experiences.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
1. Get Custom Domain Configuration
GET: /resource
Fetches the branding configuration for a given domain.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| domain | string | true | Custom domain | app.callfluent.ai |
Response
Example Success
Status code: 200: custom domain configuration
{
"website_icon": "https://api.callfluent.ai/image/agent/XXXXX.png",
"website_logo": "https://api.callfluent.ai/image/agent/XXXXX.png",
"primary_color": "#00ff9c",
"support_desk_url": "",
"website_description": "",
"website_name": "Callfluent AI"
}
Errors
500 (Server Error) – Server error.
{
status: false,
error: error_message
}
Conclusion
This covers all Resource Services API endpoints.
For constants, refer to the Constants Documentation.
User Services
User Services API
The User Services API enables users to manage their account details, passwords, profile settings, SMTP configuration, and branding preferences. These endpoints are essential for customizing your CallFluent experience at the user level.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
1. Get a User Profile
GET: /user/profile
Retrieves the current user’s profile details and custom branding settings.
Header
Authorization: Bearer {api_key}
Response
Example Success
Status code: 200: user detail with custom setting
{
"user": {
"name": "test",
"email": "[email protected]"
},
"setting": {
"website_name": "callfluent",
"website_description": "save time"
}
}
Errors
500 (Server Error) – Server error.
{
status: false,
error: error_message
}
2. Update User Detail
POST: /user/update-detail
Updates user-related details.
Header
Authorization: Bearer {api_key}
Path Parameter
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| agent_id | number | true | Agent ID | 1 |
Request Body
{
data: webhookPayload
}
webhookPayload
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| phone_number | string | true | International phone number | +1 234 5678910 |
| […custom fields] | string | false | Custom fields | name, email, address, etc. |
Response
Example Success
Status code: 200: agent list
{
status: true,
data: agent_list
}
Errors
500 (Server Error) – Server error.
{
status: false,
error: error_message
}
3. Reset User Password
POST: /user/reset-password
Updates the user’s password.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
oldPass: "123456",
newPass: "abcdefg"
}
}
data
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| oldPass | string | true | Current password | 123456 |
| newPass | string | true | New password | abcdefg |
Response
Example Success
Status code: 200
{ status: true }
Errors
{ status: false, msg: "Please input correct current password" }
4. Update User Settings
POST: /user/update-setting
Updates user branding and domain-level settings.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
userId: "12",
domain_name: "app.automation.ai",
website_logo: "https://google.com/1.jpg",
website_icon: "https://google.com/2.jpg",
support_desk_url: "https://google.com/help",
website_name: "Call Agent AI",
website_description: "AI is a game changer",
primary_color: "#0019FF"
}
}
data
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| userId | string | true | User ID | 12 |
| domain_name | string | false | Custom domain name | app.automation.ai |
| website_logo | string | false | Custom logo (image/base64) | https://google.com/1.jpg |
| website_icon | string | false | Custom icon (image/base64) | https://google.com/2.jpg |
| support_desk_url | string | false | Support page link | https://google.com/help |
| website_name | string | false | Custom site name | Call Agent AI |
| website_description | string | false | Custom site description | AI is a game changer |
| primary_color | string | false | Custom primary color | #0019FF |
Response
Example Success
Status code: 200
{ status: true }
Errors
- Something is wrong with your domain, please check if A record is added correctly.
domain_namedoesn’t point to23.29.127.132correctly- Something went wrong
- To install domain isn’t failed
5. Update SMTP Settings
POST: /user/update-smtp-setting
Updates the SMTP configuration used for sending emails.
Header
Authorization: Bearer {api_key}
Request Body
{
data: {
userId: "12",
smtp_host: "gm.co",
smtp_port: "465",
smtp_username: "...",
smtp_password: "...",
from_name: "...",
from_email: "..."
}
}
data
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| userId | string | true | User ID | 12 |
| smtp_host | string | true | SMTP host | gm.co |
| smtp_port | string | true | SMTP port | 465, 587 |
| smtp_username | string | true | SMTP username | |
| smtp_password | string | true | SMTP password | |
| from_name | string | true | From name | |
| from_email | string | true | From email address |
Response
Example Success
Status code: 200
{ status: true, user: updatedUserData }
Errors
{ status: false, error: "Something went wrong" }
Conclusion
This completes the User Services API section.
For user services, continue with the User Services Documentation.
Constants
Constants Reference
This section includes various constants used throughout the CallFluent platform for agent setup, UI configuration, and third-party integrations. These are typically used in dropdowns or predefined selections.
Base URL
All requests must be sent to:https://api.callfluent.ai/api
Authentication
Include your API key in the Authorization header:
Authorization: Bearer {api_key}
1. Timezones
An array of supported timezones used for scheduling and agent settings.
[
{
"label": "Pacific/Midway UTC-11:00",
"value": "UTC-11:00"
},
{
"label": "Pacific/Honolulu UTC-10:00",
"value": "UTC-10:00"
},
{
"label": "America/Anchorage UTC-08:00",
"value": "UTC-08:00"
},
{
"label": "America/Los Angeles UTC-07:00",
"value": "UTC-07:00"
},
{
"label": "America/Chihuahua UTC-06:00",
"value": "UTC-06:00"
},
{
"label": "America/Chicago UTC-05:00",
"value": "UTC-05:00"
},
{
"label": "America/New York UTC-04:00",
"value": "UTC-04:00"
},
{
"label": "America/Caracas UTC-04:30",
"value": "UTC-04:30"
},
{
"label": "America/Asuncion UTC-03:00",
"value": "UTC-03:00"
},
{
"label": "America/St Johns UTC-02:30",
"value": "UTC-02:30"
},
{
"label": "America/Godthab UTC-02:00",
"value": "UTC-02:00"
},
{
"label": "Atlantic/Cape Verde UTC-01:00",
"value": "UTC-01:00"
},
{
"label": "Europe/London UTC+00:00",
"value": "UTC+00:00"
},
{
"label": "Europe/Budapest UTC+01:00",
"value": "UTC+01:00"
},
{
"label": "Europe/Amsterdam UTC+02:00",
"value": "UTC+02:00"
},
{
"label": "Europe/Athens UTC+03:00",
"value": "UTC+03:00"
},
{
"label": "Asia/Tehran UTC+03:30",
"value": "UTC+03:30"
},
{
"label": "Asia/Muscat UTC+04:00",
"value": "UTC+04:00"
},
{
"label": "Asia/Baku UTC+05:00",
"value": "UTC+05:00"
},
{
"label": "Asia/Kabul UTC+04:30",
"name": "Kabul",
"value": "UTC+04:30"
},
{
"label": "Asia/Kolkata UTC+05:30",
"value": "UTC+05:30"
},
{
"label": "Asia/Katmandu UTC+05:45",
"value": "UTC+05:45"
},
{
"label": "Asia/Almaty UTC+06:00",
"value": "UTC+06:00"
},
{
"label": "Asia/Rangoon UTC+06:30",
"value": "UTC+06:30"
},
{
"label": "Asia/Bangkok UTC+07:00",
"value": "UTC+07:00"
},
{
"label": "Asia/Chongqing UTC+08:00",
"value": "UTC+08:00"
},
{
"label": "Asia/Tokyo UTC+09:00",
"value": "UTC+09:00"
},
{
"label": "Australia/Adelaide UTC+10:30",
"value": "UTC+10:30"
},
{
"label": "Australia/Darwin UTC+09:30",
"value": "UTC+09:30"
},
{
"label": "Australia/Brisbane UTC+10:00",
"value": "UTC+10:00"
},
{
"label": "Australia/Canberra UTC+11:00",
"value": "UTC+11:00"
},
{
"label": "Asia/Fiji UTC+12:00",
"value": "UTC+12:00"
},
{
"label": "Pacific/Auckland UTC+13:00",
"value": "UTC+13:00"
},
{
"label": "Pacific/Apia UTC+14:00",
"value": "UTC+14:00"
}
]
2. Languages
List of supported languages and regional variants.
[
{ value: "en", label: "English" },
{ value: "en-US", label: "English (United States)" },
{ value: "en-AU", label: "English (Australia)" },
{ value: "en-GB", label: "English (United Kingdom)" },
{ value: "en-NZ", label: "English (New Zealand)" },
{ value: "en-IN", label: "English (India)" },
{ value: "bg", label: "Bulgarian" },
{ value: "ca", label: "Catalan" },
{ value: "cs", label: "Czech" },
{ value: "da", label: "Danish" },
{ value: "da-DK", label: "Danish (Denmark)" },
{ value: "nl", label: "Dutch" },
{ value: "nl-BE", label: "Flemish (Belgium)" },
{ value: "et", label: "Estonian" },
{ value: "fi", label: "Finnish" },
{ value: "fr", label: "French" },
{ value: "fr-CA", label: "French (Canada)" },
{ value: "de", label: "German" },
{ value: "de-CH", label: "German (Switzerland)" },
{ value: "el", label: "Greek" },
{ value: "hi", label: "Hindi" },
{ value: "hi-Latn", label: "Hindi (Latin)" },
{ value: "hu", label: "Hungarian" },
{ value: "id", label: "Indonesian" },
{ value: "ja", label: "Japanese" },
{ value: "it", label: "Italian" },
{ value: "ko", label: "Korean" },
{ value: "ko-KR", label: "Korean (South Korea)" },
{ value: "lv", label: "Latvian" },
{ value: "ms", label: "Malay" },
{ value: "lt", label: "Lithuanian" },
{ value: "no", label: "Norwegian" },
{ value: "pl", label: "Polish" },
{ value: "pt", label: "Portuguese" },
{ value: "pt-BR", label: "Portuguese (Brazil)" },
{ value: "ro", label: "Romanian" },
{ value: "ru", label: "Russian" },
{ value: "sk", label: "Slovak" },
{ value: "es", label: "Spanish" },
{ value: "es-419", label: "Spanish (Latin America)" },
{ value: "sv", label: "Swedish" },
{ value: "sv-SE", label: "Swedish (Sweden)" },
{ value: "th", label: "Thai" },
{ value: "th-TH", label: "Thailand" },
{ value: "tr", label: "Turkish" },
{ value: "uk", label: "Ukrainian" },
{ value: "vi", label: "Vietnamese" },
]
3. Block Phone Types
Defines types of phone numbers that may be blocked or categorized for validation and routing.
[
{
id: 1,
type: "landline",
label: "Land Line",
description:
"The phone number is a landline number; generally not capable of receiving SMS messages.",
},
{
id: 2,
type: "mobile",
label: "Mobile",
description:
"The phone number is a mobile number; generally capable of receiving SMS messages.",
},
{
id: 3,
type: "fixedVoip",
label: "Fixed Voip",
description:
"A virtual phone number associated with a physical device (e.g., Comcast or Vonage).",
},
{
id: 4,
type: "nonFixedVoip",
label: "Non Fixed Voip",
description:
"A virtual phone number that can be obtained on the internet without the need for a physical device (e.g., Google Voice or Enflick).",
},
{
id: 5,
type: "personal",
label: "Personal",
description: "A phone number designated for personal use.",
},
{
id: 6,
type: "tollFree",
label: "Toll Free",
description:
"A toll-free phone number, which is one where calls are free for the calling party.",
},
{
id: 7,
type: "premium",
label: "Premium",
description:
"A premium rate phone number, which typically charges higher than normal rates for special services.",
},
{
id: 8,
type: "sharedCost",
label: "Shared Cost",
description:
"A shared cost phone number, which is one where the charge is partially paid by the calling party and charges higher than normal rates.",
},
{
id: 9,
type: "uan",
label: "UAN",
description:
"A universal access number, which is a national number which can route incoming calls to different destinations.",
},
{
id: 10,
type: "voicemail",
label: "Voice Email",
description: "A phone number associated with a voicemail service.",
},
{
id: 11,
type: "pager",
label: "Pager",
description: "A phone number associated with a pager device.",
},
{
id: 12,
type: "unknown",
label: "Unknown",
description:
"A valid phone number, but the line type could not be determined.",
},
{
id: 13,
type: "none",
label: "None",
description: "not allow non phone type",
},
]
4. OpenAI Model List
Defines supported OpenAI models for agents using LLMs.
[
{ value: "gpt-3.5-turbo", label: "gpt-3.5-turbo" },
{ value: "gpt-3.5-turbo-1106", label: "gpt-3.5-turbo-1106" },
{ value: "gpt-4-turbo", label: "gpt-4-turbo" },
{ value: "gpt-4", label: "gpt-4" },
{ value: "gpt-4o", label: "gpt-4o" },
{ value: "gpt-4o-mini", label: "gpt-4o-mini" },
]
5. Agent Tone List
Available tones an agent can use during conversation.
[
{ value: "a Professional", label: "Professional" },
{ value: "a Conversational", label: "Conversational" },
{ value: "an Humorous", label: "Humorous" },
{ value: "an Empathic", label: "Empathic" },
{ value: "a Simple", label: "Simple" },
{ value: "an Academic", label: "Academic" },
{ value: "a Creative", label: "Creative" },
]
6. Agent Type List
Defines roles an agent can be configured for.
[
{ value: "sales", label: "Sales representative" },
{ value: "support", label: "Support agent" },
{ value: "lead", label: "Lead engagement" },
]
7. Background Noise List
Pre-recorded ambient sounds that simulate different environments for the agent’s voice.
[
{
value: "no",
label: "No",
},
{
value: "medical-office-building.wav",
label: "Medical office building",
},
{
value: "office-ambience.wav",
label: "Office ambience",
},
{
value: "office-ambience2.wav",
label: "Office ambience second",
},
{
value: "office-environment.wav",
label: "Office environment",
},
{
value: "office-keyboard-typing.wav",
label: "Office keyboard typing",
},
{
value: "office-keyboard-typing.wav",
label: "Office keyboard typing",
},
{
value: "pub-background.wav",
label: "Pub background",
},
]
8. Agent Action List
All available action types that agents can trigger during a call.
[
{ value: "sendEmail", label: "Send email" },
{ value: "callForwarding", label: "Call forwarding" },
{ value: "sms", label: "Send text message" },
{ value: "webhook", label: "Webhook" },
{ value: "zapier", label: "Zapier" },
{ value: "dataCollection", label: "Data collection" },
{ value: "ghl_calendar", label: "GHL Calendar" },
{ value: "google_calendar", label: "Google Calendar (Beta)" },
{ value: "email_push", label: "Email data Push" },
{ value: "sms_push", label: "SMS data Push" },
]
9. Action Period List
Predefined scheduling intervals used in booking workflows.
[
{ value: "1day", label: "1 Day" },
{ value: "1week", label: "1 Week" },
{ value: "1month", label: "1 Month" },
]
10. Google Action Duration List
Preset durations used when scheduling meetings with Google Calendar.
[
{ value: "30 mins", label: "30 mins" },
{ value: "45 mins", label: "45 mins" },
{ value: "1 hr", label: "1 hr" },
{ value: "1.5 hrs", label: "1.5 hrs" },
{ value: "2 hrs", label: "2 hrs" },
{ value: "2.5 hrs", label: "2.5 hrs" },
{ value: "3 hrs", label: "3 hrs" },
{ value: "12 hrs", label: "12 hrs" },
{ value: "24 hrs", label: "24 hrs" },
]
Conclusion
This concludes the Constants Reference section. These values are typically used in dropdowns, form selectors, and frontend logic across the CallFluent platform. The culmination of this section also concludes the API documentation for CallFluent AI.
Automate your phone calls with AI
Create artificial inteligence powered, human-like voice agents ready to handle inbound and outbound calls 24/7
Discover CallfluentFrequently asked questions
Get answers to commonly asked questions about our cutting-edge AI voice call technology & learn how our platform revolutionizes customer engagement line never before.
No, you don’t need to download or install anything. Callfluent is a cloud based app, that means that it is hosted in the cloud and you can access it from any device anytime.
Yes, absolutely! CallFluent is designed to enhance sales calls by providing AI-powered agents that can engage with customers, answer questions, and assist in closing deals effectively.
Certainly! CallFluent is ideal for customer support, allowing you to automate responses, handle inquiries, and provide assistance to customers in a timely and efficient manner.
Absolutely! Callfluent is perfectly suited for e-commerce businesses. You can use AI agents to handle customer inquiries, provide product information, process orders, and more, enhancing the overall shopping experience.
Yes, indeed! CallFluent is versatile and can be tailored to suit the needs of local businesses. Whether you're a small retail store, a restaurant, or a service provider, you can use AI agents to engage with customers and streamline operations.
CallFluent is a web-based platform and works seamlessly on both Mac and Windows operating systems. All you need is a compatible web browser to access your account and start using CallFluent.
Yes, CallFluent offers flexible integration options to seamlessly connect with your existing tools and platforms. Whether it's CRM software, helpdesk systems, or other communication channels, you can integrate CallFluent to enhance workflow efficiency and maximize productivity.
Yes, you can! CallFluent offers customization options that allow you to tailor the behavior of AI agents to match your brand's tone, style, and specific requirements. From scripting responses to adjusting conversational flow, you have full control over how your AI agents interact with customers.
CallFluent provides comprehensive support to assist you every step of the way. Our dedicated support team is available to address any questions, concerns, or technical issues you may encounter. You can reach out to us via email at [email protected] or through our online chat feature within the platform.
Not at all! CallFluent provides user-friendly tools and resources to simplify the training process for AI agents. With intuitive interfaces and step-by-step guidance, you can easily upload data, train agents, and fine-tune their performance to meet your business needs.
CallFluent offers a diverse range of voices to choose from, allowing you to customize the voice of your AI agents to best suit your brand and preferences.
Absolutely! Try it now for free to explore CallFluent and experience its capabilities firsthand. Have a call with one of our callfluent voice agents and discover how CallFluent can transform your customer interactions.
Have more questions ? Check out our Knowledge base