FreeClimb

FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.

This Python package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 4.5.3
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.freeclimb.com/support/

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/freeclimbapi/python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/freeclimbapi/python-sdk.git)

Then import the package:

import freeclimb

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 freeclimb

Running Tests

Ensure the test dependencies have been installed

pip install -r test-requirements.txt

Run tests with command:

pytest

Getting Started

Please follow the installation procedure and then run the following:

import time
import freeclimb
from pprint import pprint
from freeclimb.api.default_api import DefaultApi

from freeclimb.model.buy_incoming_number_request import BuyIncomingNumberRequest


# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# 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 HTTP basic authorization: fc
configuration = freeclimb.Configuration(
    username = 'ACCOUNT_ID',
    password = 'API_KEY'
)


# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = DefaultApi(api_client)
    buy_incoming_number_request = BuyIncomingNumberRequest(
        phone_number="phone_number_example",
        alias="alias_example",
        application_id="application_id_example",
    ) # BuyIncomingNumberRequest | Incoming Number transaction details
    

    try:
        # Buy a Phone Number
        api_response = api_instance.buy_a_phone_number(buy_incoming_number_request)
        pprint(api_response)
    except freeclimb.ApiException as e:
        print("Exception when calling DefaultApi->buy_a_phone_number: %s\n" % e)

Documentation for PerCL

The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts. PerCL commands are a part of the model schema and can be serialized into JSON like so:

import freeclimb

say = freeclimb.Say(text='Hello, World')
play = freeclimb.Play(file='Example File')
get_digits = freeclimb.GetDigits(
    action_url='Example Action URL', prompts=[play, say])
percl_script = freeclimb.PerclScript(commands=[get_digits])

print(percl_script.to_json())

Documentation for API Endpoints

All URIs are relative to https://www.freeclimb.com/apiserver

Class	Method	HTTP request	Description
DefaultApi	buy_a_phone_number	POST /Accounts/{accountId}/IncomingPhoneNumbers	Buy a Phone Number
DefaultApi	create_a_conference	POST /Accounts/{accountId}/Conferences	Create a Conference
DefaultApi	create_a_queue	POST /Accounts/{accountId}/Queues	Create a Queue
DefaultApi	create_an_application	POST /Accounts/{accountId}/Applications	Create an application
DefaultApi	delete_a_recording	DELETE /Accounts/{accountId}/Recordings/{recordingId}	Delete a Recording
DefaultApi	delete_an_application	DELETE /Accounts/{accountId}/Applications/{applicationId}	Delete an application
DefaultApi	delete_an_incoming_number	DELETE /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Delete an Incoming Number
DefaultApi	dequeue_a_member	POST /Accounts/{accountId}/Queues/{queueId}/Members/{callId}	Dequeue a Member
DefaultApi	dequeue_head_member	POST /Accounts/{accountId}/Queues/{queueId}/Members/Front	Dequeue Head Member
DefaultApi	download_a_recording_file	GET /Accounts/{accountId}/Recordings/{recordingId}/Download	Download a Recording File
DefaultApi	filter_logs	POST /Accounts/{accountId}/Logs	Filter Logs
DefaultApi	get_a_call	GET /Accounts/{accountId}/Calls/{callId}	Get a Call
DefaultApi	get_a_conference	GET /Accounts/{accountId}/Conferences/{conferenceId}	Get a Conference
DefaultApi	get_a_member	GET /Accounts/{accountId}/Queues/{queueId}/Members/{callId}	Get a Member
DefaultApi	get_a_participant	GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Get a Participant
DefaultApi	get_a_queue	GET /Accounts/{accountId}/Queues/{queueId}	Get a Queue
DefaultApi	get_a_recording	GET /Accounts/{accountId}/Recordings/{recordingId}	Get a Recording
DefaultApi	get_an_account	GET /Accounts/{accountId}	Get an Account
DefaultApi	get_an_application	GET /Accounts/{accountId}/Applications/{applicationId}	Get an Application
DefaultApi	get_an_incoming_number	GET /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Get an Incoming Number
DefaultApi	get_an_sms_message	GET /Accounts/{accountId}/Messages/{messageId}	Get an SMS Message
DefaultApi	get_head_member	GET /Accounts/{accountId}/Queues/{queueId}/Members/Front	Get Head Member
DefaultApi	get_ten_dlc_sms_brand	GET /Accounts/{accountId}/Messages/10DLC/Brands/{brandId}	Get a 10DLC SMS Brand
DefaultApi	get_ten_dlc_sms_brands	GET /Accounts/{accountId}/Messages/10DLC/Brands	Get list of SMS 10DLC Brands
DefaultApi	get_ten_dlc_sms_campaign	GET /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}	Get a 10DLC SMS Campaign
DefaultApi	get_ten_dlc_sms_campaigns	GET /Accounts/{accountId}/Messages/10DLC/Campaigns	Get list of SMS 10DLC Campaigns
DefaultApi	get_ten_dlc_sms_partner_campaign	GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}	Get a 10DLC SMS Partner Campaign
DefaultApi	get_ten_dlc_sms_partner_campaigns	GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns	Get list of SMS 10DLC Partner Campaigns
DefaultApi	list_active_queues	GET /Accounts/{accountId}/Queues	List Active Queues
DefaultApi	list_all_account_logs	GET /Accounts/{accountId}/Logs	List All Account Logs
DefaultApi	list_applications	GET /Accounts/{accountId}/Applications	List applications
DefaultApi	list_available_numbers	GET /AvailablePhoneNumbers	List available numbers
DefaultApi	list_call_logs	GET /Accounts/{accountId}/Calls/{callId}/Logs	List Call Logs
DefaultApi	list_call_recordings	GET /Accounts/{accountId}/Calls/{callId}/Recordings	List Call Recordings
DefaultApi	list_calls	GET /Accounts/{accountId}/Calls	List Calls
DefaultApi	list_conferences	GET /Accounts/{accountId}/Conferences	List Conferences
DefaultApi	list_incoming_numbers	GET /Accounts/{accountId}/IncomingPhoneNumbers	List Incoming Numbers
DefaultApi	list_members	GET /Accounts/{accountId}/Queues/{queueId}/Members	List Members
DefaultApi	list_participants	GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants	List Participants
DefaultApi	list_recordings	GET /Accounts/{accountId}/Recordings	List Recordings
DefaultApi	list_sms_messages	GET /Accounts/{accountId}/Messages	List SMS Messages
DefaultApi	make_a_call	POST /Accounts/{accountId}/Calls	Make a Call
DefaultApi	remove_a_participant	DELETE /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Remove a Participant
DefaultApi	send_an_sms_message	POST /Accounts/{accountId}/Messages	Send an SMS Message
DefaultApi	stream_a_recording_file	GET /Accounts/{accountId}/Recordings/{recordingId}/Stream	Stream a Recording File
DefaultApi	update_a_conference	POST /Accounts/{accountId}/Conferences/{conferenceId}	Update a Conference
DefaultApi	update_a_live_call	POST /Accounts/{accountId}/Calls/{callId}	Update a Live Call
DefaultApi	update_a_participant	POST /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Update a Participant
DefaultApi	update_a_queue	POST /Accounts/{accountId}/Queues/{queueId}	Update a Queue
DefaultApi	update_an_account	POST /Accounts/{accountId}	Manage an account
DefaultApi	update_an_application	POST /Accounts/{accountId}/Applications/{applicationId}	Update an application
DefaultApi	update_an_incoming_number	POST /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Update an Incoming Number

Documentation For Models

Documentation For Authorization

fc

Type: HTTP basic authentication

Documentation for verifying request signature

To verify the request signature, we will need to use the verify_request_signature method within the Request Verifier class

RequestVerifier.verify_request_signature(requestBody, requestHeader, signingSecret, tolerance)

This is a method that you can call directly from the request verifier class, it will throw exceptions depending on whether all parts of the request signature is valid otherwise it will throw a specific error message depending on which request signature part is causing issues

This method requires a requestBody of type string, a requestHeader of type string, a signingSecret of type string, and a tolerance value of type int

Example code down below

from freeclimb.utils.request_verifier import RequestVerifier

class RequestVerifierExample():
      def verify_request_signature_example():
          request_body = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}"
          signing_secret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793"
          tolerance = 5 * 60
          request_header = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8"
          RequestVerifier.verify_request_signature(request_body, request_header, signing_secret, tolerance)

Author

support@freeclimb.com

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in freeclimb.apis and freeclimb.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

from freeclimb.api.default_api import DefaultApi
from freeclimb.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import freeclimb
from freeclimb.apis import *
from freeclimb.models import *