FreeClimb Python SDK

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: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python 3.4+

Installation & Usage

pip install

pip install freeclimb

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

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

configuration = freeclimb.Configuration()
# Configure HTTP basic authorization: fc
configuration.username = 'ACCOUNT_ID'
configuration.password = 'AUTH_TOKEN'

# Defining host is optional and default to https://www.freeclimb.com/apiserver
configuration.host = "https://www.freeclimb.com/apiserver"
# 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 = freeclimb.DefaultApi(api_client)
    buy_incoming_number_request = freeclimb.BuyIncomingNumberRequest() # BuyIncomingNumberRequest | Incoming Number transaction details (optional)

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

Tests

Run tests with command:
python -m unittest test

Documentation for API Endpoints

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

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 example:

say = freeclimb.Say(text="Hello! This is a message sent using FreeClimb's Python SDK.")
return freeclimb.PerCLCommand.to_json(say.to_dict())

The JSON object below represents the PerCL object generated by the commands above.

[
    {
        "Say" : {
            "text" : "Hello! This is a message sent using FreeClimb's Python SDK."
        }
    }
]

Documentation For Models

• AccountRequest
• AccountResult
• AccountResultAllOf
• ApplicationList
• ApplicationListAllOf
• ApplicationRequest
• ApplicationResult
• ApplicationResultAllOf
• AvailableNumber
• AvailableNumberList
• AvailableNumberListAllOf
• BuyIncomingNumberRequest
• CallList
• CallListAllOf
• CallResult
• CallResultAllOf
• ConferenceList
• ConferenceListAllOf
• ConferenceParticipantList
• ConferenceParticipantListAllOf
• ConferenceParticipantResult
• ConferenceParticipantResultAllOf
• ConferenceResult
• ConferenceResultAllOf
• CreateConferenceRequest
• DequeueMemberRequest
• FilterLogsRequest
• IncomingNumberList
• IncomingNumberListAllOf
• IncomingNumberRequest
• IncomingNumberResult
• IncomingNumberResultAllOf
• LogList
• LogListAllOf
• LogResult
• MakeCallRequest
• MessageRequest
• MessageRequestAllOf
• MessageResult
• MessageResultAllOf
• MessagesList
• MessagesListAllOf
• MutableResourceModel
• PaginationModel
• QueueList
• QueueListAllOf
• QueueMember
• QueueMemberList
• QueueMemberListAllOf
• QueueRequest
• QueueResult
• QueueResultAllOf
• RecordingList
• RecordingListAllOf
• RecordingResult
• RecordingResultAllOf
• UpdateCallRequest
• UpdateConferenceParticipantRequest
• UpdateConferenceRequest

Documentation For Authorization

fc

• Type: HTTP basic authentication