bland-voice
v1.0.2
Published
The official SDK for Bland AI phone calls.
Downloads
248
Maintainers
Readme
Bland AI SDK README
Overview
The Node.js SDK for Bland AI simplifies integration with Bland AI's phone call automation API, offering functionalities such as making calls, batch operations, call recording management, among others.
Installation
To install the SDK, run the following command:
npm install bland-voice
Usage
Getting Started
Begin by importing the SDK and initializing it with your API key:
const Bland = require('bland-voice');
const bland = new Bland('YOUR_API_KEY');
Functions
startCall(phoneNumber, reduceLatency, voiceId, additionalParams)
: Initiates a phone call.fetchLogs(callId, poll)
: Fetches logs for a specific call. Ifpoll
istrue
, it continually polls the logs.endCall(callId)
: Ends an ongoing call.holdForMe(phoneNumber, holdConnect, task)
: Makes an outbound call and waits on hold.batchCall(basePrompt, callData, options = {})
: Sends out a batch of calls.retrieveBatch(batchId, includeCalls)
: Retrieves details of a batch of calls.cancelBatch(batchId)
: Cancels all calls in a batch.purchaseInboundNumber(options)
: Purchases and configures a new inbound phone number.
Error Handling
All functions throw meaningful errors for easy debugging.
Bland API Usage Examples
Starting a Call
bland.startCall('1234567890', true, 1, { task: 'Reminder call' });
Fetching Call Logs
bland.fetchLogs('call_id_here', true);
Purchasing an Inbound Number
bland.purchaseInboundNumber({ area_code: '123', prompt: 'Welcome to Bland AI' });
Additional Resources
- For more detailed documentation, visit Bland AI Documentation.
Important Notes
- Remember to replace placeholders such as 'YOUR_API_KEY'