Package: callchimp
callchimpIntroduction👋Introducing OpenAPI spec for doing almost anything incallchimp.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:CampaignsSupervisorsListsSubscribersCallsPhone NumbersWebhooksAPI Operations✅Campaign OperationsList all CampaignsCreate a CampaignGet Campaign by IdDelete Campaign by IdUpdate Campaign by IdAdd Supervisors to Campaign by IdRemove Supervisors from Campaign by IdUpload audio file to Campaign by IdSupervisor OperationsList all SupervisorsCreate a SupervisorGet Supervisor by IdDelete Supervisor by IdUpdate Supervisor by IdSend OTP to Campaign by IdVerify Supervisor OTP by IdList OperationsList all ListsCreate a ListGet List by IdDelete List by IdUpdate List by IdSubscriber OperationsList all SubscribersCreate one or more Subscriber(s)Get Subscriber by IdDelete Subscriber by IdUpdate Subscriber by IdCall OperationsList outbound CallsCreate a CallGet Call by IdList Inbound CallsGenerate Call ReportsPhone Number OperationsList Phone NumbersWebhook OperationsList all WebhooksCreate a WebhookGet Webhook by IdDelete Webhook by IdUpdate Webhook by IdAuthentication🔐CallChimp public API offers authentication with API Keys. All endpoints accepts a header namedx-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 onAPI Keysfrom the left sidebar.Click onAdd newbutton, 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 theOpenAPI Generatorproject:API version: 1.0.0Package version: 0.1.3Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python 3.7+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/callchimp/python-sdk.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importcallchimpSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importcallchimpTestsExecutepytestto run the tests.Getting StartedPlease follow theinstallation procedureand then run the following:importtimeimportcallchimpfromcallchimp.restimportApiExceptionfrompprintimportpprint# 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-keyconfiguration.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 clientwithcallchimp.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=callchimp.CallsApi(api_client)id=56# int | Numeric call id to gettry:# Get Call by Idapi_response=api_instance.calls_get(id)print("The response of CallsApi->calls_get:\n")pprint(api_response)exceptApiExceptionase:print("Exception when calling CallsApi->calls_get:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://api.callchimp.ai/v1ClassMethodHTTP requestDescriptionCallsApicalls_getGET/calls/{Id}Get Call by IdCallsApicalls_list_inboundGET/calls/inboundList Inbound CallsCallsApicalls_list_outboundGET/callsList Outbound CallsCallsApicalls_postPOST/callsCreate a CallCallsApicalls_reportsPOST/calls/reportsGenerate Call ReportsCampaignsApicampaigns_addsuperPOST/campaigns/{Id}/add_superAdd Supervisors to Campaign by IdCampaignsApicampaigns_deleteDELETE/campaigns/{Id}Delete Campaign by IdCampaignsApicampaigns_getGET/campaigns/{Id}Get Campaign by IdCampaignsApicampaigns_listGET/campaignsList CampaignsCampaignsApicampaigns_postPOST/campaignsCreate a CampaignCampaignsApicampaigns_removesuperPOST/campaigns/{Id}/remove_superRemove Supervisors from Campaign by IdCampaignsApicampaigns_updatePATCH/campaigns/{Id}Update Campaign by IdCampaignsApicampaigns_uploadblastPATCH/campaigns/{Id}/upload_blast_fileUpload audio file to Campaign by IdListsApilists_deleteDELETE/lists/{Id}Delete List by IdListsApilists_getGET/lists/{Id}Get List by IdListsApilists_listGET/listsList ListsListsApilists_postPOST/listsCreate a ListListsApilists_updatePATCH/lists/{Id}Update List by IdPhoneNumbersApiphone_numbers_listGET/phone_numbersList Phone NumbersSubscribersApisubscribers_deleteDELETE/subscribers/{Id}Delete Subscriber by IdSubscribersApisubscribers_getGET/subscribers/{Id}Get Subscriber by IdSubscribersApisubscribers_listGET/subscribersList SubscribersSubscribersApisubscribers_postPOST/subscribersCreate one or more Subscriber(s)SubscribersApisubscribers_updatePATCH/subscribers/{Id}Update Subscriber by IdSupervisorsApisupervisors_deleteDELETE/supervisors/{Id}Delete Supervisor by IdSupervisorsApisupervisors_getGET/supervisors/{Id}Get Supervisor by IdSupervisorsApisupervisors_listGET/supervisorsList SupervisorsSupervisorsApisupervisors_postPOST/supervisorsCreate a SupervisorSupervisorsApisupervisors_sendotpPOST/supervisors/{Id}/send_otpSend OTP to Supervisor by IdSupervisorsApisupervisors_updatePATCH/supervisors/{Id}Update Supervisor by IdSupervisorsApisupervisors_verifyotpPOST/supervisors/{Id}/verify_otpVerify Supervisor OTP by IdWebhooksApiwebhooks_deleteDELETE/webhooks/{Id}Delete Webhook by IdWebhooksApiwebhooks_getGET/webhooks/{Id}Get Webhook by IdWebhooksApiwebhooks_listGET/webhooksList WebhooksWebhooksApiwebhooks_postPOST/webhooksCreate a WebhookWebhooksApiwebhooks_updatePATCH/webhooks/{Id}Update Webhook by IdDocumentation For ModelsCallListResponseCallReportRequestCallReportResponseCallReportResponseAnsweredCallsCallReportResponseStatsInnerCallRequestByLeadIdCallRequestByVendorLeadCodeCallResponseCallsPostRequestCampaignAddSuperRequestCampaignAddSuperResponseCampaignListResponseCampaignRemoveSuperRequestCampaignRemoveSuperResponseCampaignRequestCampaignResponseCampaignUploadAudioResponseInboundCallListResponseInboundCallResponseInboundCallResponseCallchimpNumberInboundCallResponseHangupCauseInboundCallResponseSupervisorListsListResponseListsRequestListsResponseModel4XXResponseModel4XXResponseErrorsInnerPhoneNumberListResponsePhoneNumberResponseSubscriberListResponseSubscriberRequestSubscriberResponseSubscribersUpdateSupervisorListResponseSupervisorRequestSupervisorResponseSupervisorSendOtpResponseSupervisorVerifyOtpRequestSupervisorVerifyOtpResponseTransactionCallRequestByLeadIdWebhookListResponseWebhookRequestWebhookResponseDocumentation For AuthorizationAuthentication schemes defined for the API:x-api-keyType: API keyAPI key parameter name: x-api-keyLocation: HTTP headerAuthorDynopii Inc.