- Prerequisite
- Authentication using Tokens.
- Introduction of API's
- Create a New User/Agent
- Update User/Agent
- Delete User/Agent
- Fetch List of User/Agent (with filter)
- User/Agent Active/Inactive
- Fetch User/Agent Details
- Resent Verification Link
- Reset Password
- Purchase Number
- Fetch Country List
- Fetch List of Available No.
- Fetch List of Number
- Update ASR Configration
- Update TTS Configration
- Attach DVA
- De-Attach DVA
- Assign Team
- Unassign Team
- Create SIP Trunk
- Update SIP Trunk
- Delete SIP Trunk
- Test SIP Trunk
- List SIP Trunk
- Update ASR Configration
- Update TTS Configration
- Attach DVA
- De-Attach DVA
- Assign Team
- Unassign Team
- Create SMS Gateway
- Update SMS Gateway
- Delete SMS Gateway
- List SMS Gateway
- Send SMS
- List Sent SMS
- Create FHIR
- Delete FHIR
- List FHIR
- CSV Uploads
- Fetch Call-ai DVA Template
- Create DVA
- List Your DVA
- Attach Number
- De-Attach Number
- Get Details of DVA
- Update DVA
- Delete DVA
- Make a Voice Call
- Schedule Voice Call
- Create Campaign
- Update Campaign
- Update Scheduler
- Update Dialer
- Call Status For a Number
- DialOut time for a Number
- Fetch List Campaign
- Fetch Single Campaign
- Delete Campaign
- Fetch List Dialer Base
- upload Contact in DialerBase By phonebook Id
- upload Individual Contact in DialerBase
- Upload Contacts in DialerBase through xlsx file For Outreach
- Create Campaign
- Update Campaign
- Update Scheduler
- Update Dialer
- Call Status For a Number
- DialOut time for a Number
- Fetch List Campaign
- Fetch Single Campaign
- Delete Campaign
- Fetch List Dialer Base
- upload Contact in DialerBase By phonebook Id
- upload Individual Contact in DialerBase
- Upload Contacts in DialerBase through xlsx file For Outreach
- Create Phonebook
- List Phonebook
- Fetch Phonebook
- Fetch Phonebook by ID
- Update Phonebook
- Delete Phonebook
- Create Contact
- List Contact
- Fetch Contact
- Fetch Contact by ID
- Update Contact
- Upload Contact Xlsx File
- Delete Contact
- API Reference
- Message Privacy
- Fetch CDR
- Fetch Agent Call Detail
- Fetch Queue|Team Detail
- Fetch Call Recording
- Fetch Call Transcript
- Delete Call Recording
- Delete Call Transcript
- Fetch Total Call Duration In/Out
Overview
Introducing Call-Ai Voice API: Empowering Developers with Seamless Voice Calling Integration
The realm of application development has been witnessing a revolutionary shift towards voice-based interactions. In this context, Call-Ai Voice API emerges as an indispensable toolset that empowers developers to seamlessly integrate voice calling functionality into their applications. Pioneering a new era of effortless voice communication, this cutting-edge API offers a comprehensive documentation that serves as a guiding beacon for developers.
Unveiling the Power of Call-Ai Voice API
At the core of Call-Ai Voice API lies a powerful set of tools that facilitate a wide array of voice calling functionalities. Whether it's making outbound calls or receiving incoming ones, managing call resources efficiently, or harnessing the full potential of voice-related features, this API has got developers covered.
A Comprehensive Guide: Navigating the Voice API Landscape
The documentation provided by Call-Ai Voice API is an all-encompassing resource that simplifies the process of integrating voice calling capabilities into any application. With its user-friendly approach, developers are guided through each step seamlessly, enabling them to harness the full potential of this robust RESTful API.
Making and Receiving Calls with Ease
With Call-Ai Voice API, developers can effortlessly implement voice calling in their applications. The API's intuitive methods and easy-to-understand instructions ensure that developers can initiate outbound calls and handle incoming ones with utmost simplicity.
Efficient Call Resource Management
Call-Ai Voice API introduces efficient call resource management to optimize the calling process. From call queue management to handling concurrent calls, the API empowers developers to create seamless voice experiences for their users.
Empowering Voice-Related Features
Gone are the days of monotonous robotic voices. Call-Ai Voice API opens the doors to a world of natural, human-like voice interactions. Developers can leverage the API's advanced features to customize voice personas, enabling a more engaging and personalized user experience.
RESTful API: A Smooth Integration Journey
Thanks to the RESTful architecture, integrating Call-Ai Voice API into applications is a breeze. Developers can effortlessly interact with the API using standard HTTP methods, making communication with the API more straightforward and efficient.
The Road Ahead: Endless Possibilities
With Call-Ai Voice API, developers are empowered to explore the limitless possibilities of voice communication. From interactive voice response systems to voice-activated virtual assistants, this API lays the foundation for groundbreaking voice-based applications.
Make a Voice Call
The Click to Call API allows you to phone a customer number just by entering the number.
The API enables the Care Person or users to make calls by entering the number to dial and then selecting the DID number from which to make the call.
Endpoint URL
https://api.call-ai.com/telephony/v1/outbound/api/v1/calling/dial-direct-call/{calling_no}/{called_no}
Request Variables (Header Params)
You can retrieve the access token by entering the below-mentioned values in the Request Variables:
Variable | Description | Data Type |
---|---|---|
Ocp-Apim-Subscription-Key | Subscription Key of Tenant | String |
Authorization | Jwt token | String |
Request Variables (Body Params)
The body params used for making calls are:
Variable | Description | Data Type |
---|---|---|
calling_no | The Number From which user wants to call Ref: https://developer.call-ai.com/api-details#api=number-management&operation=get-basic-api-v1-number-purchased-tenant_id | String |
called no | The number of the customer who will receive the call. Note: Customer numbers must be 12 Digits For example, 9173XXXXXX | String |
Sample Request
POST https://api.call-ai.com/telephony/v1/outbound/api/v1/calling/dial-direct-call/{calling_no}/{called_no} Content-Type: application/json Cache-Control: no-cache Authorization: Bearer ••••••• Ocp-Apim-Subscription-Key: ••••••• string
Response Variables
The response is as following:
Variable | Description | Data Type |
---|---|---|
reponse | SUCCESS or Error Code | String |
message | Call message on success or error | String |
Data.id | Unique ID Call | Float |
Data.creationtime | Creation time of call | Timestamp |
Schedule Voice Call
The Schedule Voice call API feature offers the below-mentioned advantages
This Run makes use of a campaign. Campaigns are quite effective at generating leads, conducting market research, reaching out to a large number of patients, and so on.
Dialer campaigns boost your productivity by sending calls at the scheduled time.
campaigns Calling can also aid with data management by providing information on call volume, conversion rates, and other key performance factors.
You can leverage the capabilities of this API to establish a new broadcast campaign and take advantage of its diverse features. With this API, you can create phone-based surveys, voice broadcasts, healthcare campaigns, patient polls and various other types communication campaign initiatives.
One notable benefit is the ability to efficiently handle high call volumes, allowing you to extend your customer reach effectively. By leveraging this API, you can engage with your customers through DVA, providing them hassle Free on-time Calls for their Medical Needs. This feature enables you to manage customer expectations and streamline the calling process, enhancing their overall experience.
Moreover, the API enables you to broadcast messages to a wide audience, enabling you to expand your reach significantly. This feature is particularly valuable for mass communication scenarios, where you can deliver important DVA Interactions to a large number of recipients simultaneously.
Endpoint URL
https://api.call-ai.com/telephony/v1/outbound/api/v1/calling/dial-campaign-call
Request Variables (Header Params)
You can retrieve the access token by entering the below-mentioned values in the Request Variables:
Variable | Description | Data Type |
---|---|---|
Ocp-Apim-Subscription-Key | Subscription Key of Tenant | String |
Authorization | Jwt token | String |
Request Variables (Body Parameters)
It takes a JSON request body with the following notable parameters:
Variable | Description | Data Type |
---|---|---|
variables.tenant_id | A tenant ID is used to associate each tenant's data with their specific account or instance | String |
variables.campaign_id | When a new campaign is created, a campaign ID is assigned to it Ref: https://developer.call-ai.com/api-details#api=outbound-api&operation=get-outbound-api-v1-campaign-tenant_id-page_size-page_index | String |
variables.called_no | Mobile_number defines the contact number that was dialed by campaign | String |
variables.name | Name of the user who is going to reveive the call | String |
variables.email | Email of the user who is inititing the call. | String |
Sample Request
POST https://api.call-ai.com/telephony/v1/outbound/api/v1/calling/dial-campaign-call Content-Type: application/json Cache-Control: no-cache Authorization: Bearer ••••••••• Ocp-Apim-Subscription-Key: ••••••••• { "tenant_id": "tenant_09722811", "campaign_id": "100", "called_no": "918178809127", "email": "sandeep.rawat@call-ai.com", "name": "Sandeep" }
Response Variables
The response is as following:
Variable | Description | Data Type |
---|---|---|
reponse | SUCCESS or Error Code | String |
message | Call message on success or error | String |
Data.id | Unique ID Call | Float |
Data.creationtime | Creation time of call | Timestamp |