Callchimp Python SDK
Project description
callchimp
Introduction👋
Introducing OpenAPI spec for doing almost anything in callchimp.ai. CallChimp is a Gen AI Call Center Enhancing telecommunication with GPT-driven bulk calling. It is scalable, user-friendly, and customizable. Optimized for seamless integration and usability.
API Categories📋
The APIs are divided in 7 categories listed below:
- Campaigns
- Supervisors
- Lists
- Subscribers
- Calls
- Phone Numbers
- Webhooks
API Operations✅
Campaign Operations
- List all Campaigns
- Create a Campaign
- Get Campaign by Id
- Delete Campaign by Id
- Update Campaign by Id
- Add Supervisors to Campaign by Id
- Remove Supervisors from Campaign by Id
- Upload audio file to Campaign by Id
Supervisor Operations
- List all Supervisors
- Create a Supervisor
- Get Supervisor by Id
- Delete Supervisor by Id
- Update Supervisor by Id
- Send OTP to Campaign by Id
- Verify Supervisor OTP by Id
List Operations
- List all Lists
- Create a List
- Get List by Id
- Delete List by Id
- Update List by Id
Subscriber Operations
- List all Subscribers
- Create one or more Subscriber(s)
- Get Subscriber by Id
- Delete Subscriber by Id
- Update Subscriber by Id
Call Operations
- List outbound Calls
- Create a Call
- Get Call by Id
- List Inbound Calls
- Generate Call Reports
Phone Number Operations
- List Phone Numbers
Webhook Operations
- List all Webhooks
- Create a Webhook
- Get Webhook by Id
- Delete Webhook by Id
- Update Webhook by Id
Authentication🔐
CallChimp public API offers authentication with API Keys. All endpoints accepts a header named x-api-key
. To get started follow the below steps:
- Login to callchimp dashboard.
- Click on your profile on the top-right corner.
- Click on Settings.
- On the settings page, click on
API Keys
from the left sidebar. - Click on
Add new
button, add an expiry date and click onAdd
. - An API Key will be generated, please save the key somewhere safe as it won't be shown again!
- You can use the API Key directly here in this playground to test out the APIs.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.1.3
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/callchimp/python-sdk.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import callchimp
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import callchimp
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import callchimp
from callchimp.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.callchimp.ai/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = callchimp.Configuration(
host = "https://api.callchimp.ai/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: x-api-key
configuration.api_key['x-api-key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with callchimp.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = callchimp.CallsApi(api_client)
id = 56 # int | Numeric call id to get
try:
# Get Call by Id
api_response = api_instance.calls_get(id)
print("The response of CallsApi->calls_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CallsApi->calls_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.callchimp.ai/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CallsApi | calls_get | GET /calls/{Id} | Get Call by Id |
CallsApi | calls_list_inbound | GET /calls/inbound | List Inbound Calls |
CallsApi | calls_list_outbound | GET /calls | List Outbound Calls |
CallsApi | calls_post | POST /calls | Create a Call |
CallsApi | calls_reports | POST /calls/reports | Generate Call Reports |
CampaignsApi | campaigns_addsuper | POST /campaigns/{Id}/add_super | Add Supervisors to Campaign by Id |
CampaignsApi | campaigns_delete | DELETE /campaigns/{Id} | Delete Campaign by Id |
CampaignsApi | campaigns_get | GET /campaigns/{Id} | Get Campaign by Id |
CampaignsApi | campaigns_list | GET /campaigns | List Campaigns |
CampaignsApi | campaigns_post | POST /campaigns | Create a Campaign |
CampaignsApi | campaigns_removesuper | POST /campaigns/{Id}/remove_super | Remove Supervisors from Campaign by Id |
CampaignsApi | campaigns_update | PATCH /campaigns/{Id} | Update Campaign by Id |
CampaignsApi | campaigns_uploadblast | PATCH /campaigns/{Id}/upload_blast_file | Upload audio file to Campaign by Id |
ListsApi | lists_delete | DELETE /lists/{Id} | Delete List by Id |
ListsApi | lists_get | GET /lists/{Id} | Get List by Id |
ListsApi | lists_list | GET /lists | List Lists |
ListsApi | lists_post | POST /lists | Create a List |
ListsApi | lists_update | PATCH /lists/{Id} | Update List by Id |
PhoneNumbersApi | phone_numbers_list | GET /phone_numbers | List Phone Numbers |
SubscribersApi | subscribers_delete | DELETE /subscribers/{Id} | Delete Subscriber by Id |
SubscribersApi | subscribers_get | GET /subscribers/{Id} | Get Subscriber by Id |
SubscribersApi | subscribers_list | GET /subscribers | List Subscribers |
SubscribersApi | subscribers_post | POST /subscribers | Create one or more Subscriber(s) |
SubscribersApi | subscribers_update | PATCH /subscribers/{Id} | Update Subscriber by Id |
SupervisorsApi | supervisors_delete | DELETE /supervisors/{Id} | Delete Supervisor by Id |
SupervisorsApi | supervisors_get | GET /supervisors/{Id} | Get Supervisor by Id |
SupervisorsApi | supervisors_list | GET /supervisors | List Supervisors |
SupervisorsApi | supervisors_post | POST /supervisors | Create a Supervisor |
SupervisorsApi | supervisors_sendotp | POST /supervisors/{Id}/send_otp | Send OTP to Supervisor by Id |
SupervisorsApi | supervisors_update | PATCH /supervisors/{Id} | Update Supervisor by Id |
SupervisorsApi | supervisors_verifyotp | POST /supervisors/{Id}/verify_otp | Verify Supervisor OTP by Id |
WebhooksApi | webhooks_delete | DELETE /webhooks/{Id} | Delete Webhook by Id |
WebhooksApi | webhooks_get | GET /webhooks/{Id} | Get Webhook by Id |
WebhooksApi | webhooks_list | GET /webhooks | List Webhooks |
WebhooksApi | webhooks_post | POST /webhooks | Create a Webhook |
WebhooksApi | webhooks_update | PATCH /webhooks/{Id} | Update Webhook by Id |
Documentation For Models
- CallListResponse
- CallReportRequest
- CallReportResponse
- CallReportResponseAnsweredCalls
- CallReportResponseStatsInner
- CallRequestByLeadId
- CallRequestByVendorLeadCode
- CallResponse
- CallsPostRequest
- CampaignAddSuperRequest
- CampaignAddSuperResponse
- CampaignListResponse
- CampaignRemoveSuperRequest
- CampaignRemoveSuperResponse
- CampaignRequest
- CampaignResponse
- CampaignUploadAudioResponse
- InboundCallListResponse
- InboundCallResponse
- InboundCallResponseCallchimpNumber
- InboundCallResponseHangupCause
- InboundCallResponseSupervisor
- ListsListResponse
- ListsRequest
- ListsResponse
- Model4XXResponse
- Model4XXResponseErrorsInner
- PhoneNumberListResponse
- PhoneNumberResponse
- SubscriberListResponse
- SubscriberRequest
- SubscriberResponse
- SubscribersUpdate
- SupervisorListResponse
- SupervisorRequest
- SupervisorResponse
- SupervisorSendOtpResponse
- SupervisorVerifyOtpRequest
- SupervisorVerifyOtpResponse
- TransactionCallRequestByLeadId
- WebhookListResponse
- WebhookRequest
- WebhookResponse
Documentation For Authorization
Authentication schemes defined for the API:
x-api-key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
Author
Dynopii Inc.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for callchimp-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a39869eb827a92d6804b520d22649531f9dfc632ed071d7116a65be91e97925 |
|
MD5 | d27861b61c290d814b0740756dcd568f |
|
BLAKE2b-256 | a99c94a48c97cbaf952a339b32a065397a0f5c1f9fd59d9755fd50b6d42c8e1d |