freeclimb-java-client

FreeClimb API

API version: 1.0.0

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.

For more information, please visit https://www.freeclimb.com/support/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

Java 1.7+
Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.github.freeclimbapi</groupId>
  <artifactId>freeclimb-java-client</artifactId>
  <version>5.5.4</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'freeclimb-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'freeclimb-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.github.freeclimbapi:freeclimb-java-client:5.5.4"
     implementation("com.squareup.okhttp3:okhttp:4.9.3")
     implementation("com.squareup.okhttp3:logging-interceptor:4.9.3")
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

target/freeclimb-java-client-5.5.4.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.github.freeclimbapi.ApiClient;
import com.github.freeclimbapi.ApiException;
import com.github.freeclimbapi.Configuration;
import com.github.freeclimbapi.auth.*;
import com.github.freeclimbapi.models.*;
import com.github.freeclimbapi.DefaultApi;

public class Example {
  public static void main(String[] args) {
    
    // Configure API client
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://www.freeclimb.com/apiserver");
    defaultClient.setAccountId("YOUR_ACCOUNT_ID");
    defaultClient.setApiKey("YOUR_API_KEY");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    
    BuyIncomingNumberRequest buyIncomingNumberRequest = new BuyIncomingNumberRequest(); // BuyIncomingNumberRequest | Incoming Number transaction details
    
    try {
      IncomingNumberResult result = apiInstance.buyAPhoneNumber(buyIncomingNumberRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#buyAPhoneNumber");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Using 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 com.github.freeclimbapi.*;
public class Example {
  public static void main(String[] args) {
    Say say = new Say().text("Hello FreeClimb!");
    Play play = new Play().file("Example File");
    GetDigits getDigits = new GetDigits().actionUrl("Example Action URL").addPromptsItem(say).addPromptsItem(play);
    PerclScript script = new PerclScript().addCommand(getDigits);
    JSON jsonObj = script.build(); // builds the list of PerclCommands needed for the response
    // or
    String jsonStr = script.toJson(); // similar to .build() but returns the serialized string for you.
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	buyAPhoneNumber	POST /Accounts/{accountId}/IncomingPhoneNumbers	Buy a Phone Number
DefaultApi	createAConference	POST /Accounts/{accountId}/Conferences	Create a Conference
DefaultApi	createAQueue	POST /Accounts/{accountId}/Queues	Create a Queue
DefaultApi	createAnApplication	POST /Accounts/{accountId}/Applications	Create an application
DefaultApi	deleteARecording	DELETE /Accounts/{accountId}/Recordings/{recordingId}	Delete a Recording
DefaultApi	deleteAnApplication	DELETE /Accounts/{accountId}/Applications/{applicationId}	Delete an application
DefaultApi	deleteAnIncomingNumber	DELETE /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Delete an Incoming Number
DefaultApi	dequeueAMember	POST /Accounts/{accountId}/Queues/{queueId}/Members/{callId}	Dequeue a Member
DefaultApi	dequeueHeadMember	POST /Accounts/{accountId}/Queues/{queueId}/Members/Front	Dequeue Head Member
DefaultApi	downloadARecordingFile	GET /Accounts/{accountId}/Recordings/{recordingId}/Download	Download a Recording File
DefaultApi	filterLogs	POST /Accounts/{accountId}/Logs	Filter Logs
DefaultApi	getACall	GET /Accounts/{accountId}/Calls/{callId}	Get a Call
DefaultApi	getAConference	GET /Accounts/{accountId}/Conferences/{conferenceId}	Get a Conference
DefaultApi	getAMember	GET /Accounts/{accountId}/Queues/{queueId}/Members/{callId}	Get a Member
DefaultApi	getAParticipant	GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Get a Participant
DefaultApi	getAQueue	GET /Accounts/{accountId}/Queues/{queueId}	Get a Queue
DefaultApi	getARecording	GET /Accounts/{accountId}/Recordings/{recordingId}	Get a Recording
DefaultApi	getAnAccount	GET /Accounts/{accountId}	Get an Account
DefaultApi	getAnApplication	GET /Accounts/{accountId}/Applications/{applicationId}	Get an Application
DefaultApi	getAnIncomingNumber	GET /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Get an Incoming Number
DefaultApi	getAnSmsMessage	GET /Accounts/{accountId}/Messages/{messageId}	Get an SMS Message
DefaultApi	getHeadMember	GET /Accounts/{accountId}/Queues/{queueId}/Members/Front	Get Head Member
DefaultApi	getTenDLCSmsBrand	GET /Accounts/{accountId}/Messages/10DLC/Brands/{brandId}	Get a 10DLC SMS Brand
DefaultApi	getTenDLCSmsBrands	GET /Accounts/{accountId}/Messages/10DLC/Brands	Get list of SMS 10DLC Brands
DefaultApi	getTenDLCSmsCampaign	GET /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}	Get a 10DLC SMS Campaign
DefaultApi	getTenDLCSmsCampaigns	GET /Accounts/{accountId}/Messages/10DLC/Campaigns	Get list of SMS 10DLC Campaigns
DefaultApi	getTenDLCSmsPartnerCampaign	GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}	Get a 10DLC SMS Partner Campaign
DefaultApi	getTenDLCSmsPartnerCampaigns	GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns	Get list of SMS 10DLC Partner Campaigns
DefaultApi	listActiveQueues	GET /Accounts/{accountId}/Queues	List Active Queues
DefaultApi	listAllAccountLogs	GET /Accounts/{accountId}/Logs	List All Account Logs
DefaultApi	listApplications	GET /Accounts/{accountId}/Applications	List applications
DefaultApi	listAvailableNumbers	GET /AvailablePhoneNumbers	List available numbers
DefaultApi	listCallLogs	GET /Accounts/{accountId}/Calls/{callId}/Logs	List Call Logs
DefaultApi	listCallRecordings	GET /Accounts/{accountId}/Calls/{callId}/Recordings	List Call Recordings
DefaultApi	listCalls	GET /Accounts/{accountId}/Calls	List Calls
DefaultApi	listConferences	GET /Accounts/{accountId}/Conferences	List Conferences
DefaultApi	listIncomingNumbers	GET /Accounts/{accountId}/IncomingPhoneNumbers	List Incoming Numbers
DefaultApi	listMembers	GET /Accounts/{accountId}/Queues/{queueId}/Members	List Members
DefaultApi	listParticipants	GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants	List Participants
DefaultApi	listRecordings	GET /Accounts/{accountId}/Recordings	List Recordings
DefaultApi	listSmsMessages	GET /Accounts/{accountId}/Messages	List SMS Messages
DefaultApi	makeACall	POST /Accounts/{accountId}/Calls	Make a Call
DefaultApi	removeAParticipant	DELETE /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Remove a Participant
DefaultApi	sendAnSmsMessage	POST /Accounts/{accountId}/Messages	Send an SMS Message
DefaultApi	streamARecordingFile	GET /Accounts/{accountId}/Recordings/{recordingId}/Stream	Stream a Recording File
DefaultApi	updateAConference	POST /Accounts/{accountId}/Conferences/{conferenceId}	Update a Conference
DefaultApi	updateALiveCall	POST /Accounts/{accountId}/Calls/{callId}	Update a Live Call
DefaultApi	updateAParticipant	POST /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId}	Update a Participant
DefaultApi	updateAQueue	POST /Accounts/{accountId}/Queues/{queueId}	Update a Queue
DefaultApi	updateAnAccount	POST /Accounts/{accountId}	Manage an account
DefaultApi	updateAnApplication	POST /Accounts/{accountId}/Applications/{applicationId}	Update an application
DefaultApi	updateAnIncomingNumber	POST /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId}	Update an Incoming Number

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

fc

Type: HTTP basic authentication

Documentation for verifying request signature

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

RequestVerifier.verifyRequestSignature(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 Integer

Example code down below

  package com.github.freeclimbapi;

  import com.github.freeclimbapi.utils.*;
  import java.security.NoSuchAlgorithmException;
  import java.security.InvalidKeyException;

  public class Example {
      public void verifyRequestSignatureExample() throws NoSuchAlgorithmException, InvalidKeyException {
          String requestBody = "{\"accountId\":\"AC1334ffb694cd8d969f51cddf5f7c9b478546d50c\",\"callId\":\"CAccb0b00506553cda09b51c5477f672a49e0b2213\",\"callStatus\":\"ringing\",\"conferenceId\":null,\"direction\":\"inbound\",\"from\":\"+13121000109\",\"parentCallId\":null,\"queueId\":null,\"requestType\":\"inboundCall\",\"to\":\"+13121000096\"}";
          String signingSecret = "sigsec_ead6d3b6904196c60835d039e91b3341c77a7793";
          String requestHeader = "t=1679944186,v1=c3957749baf61df4b1506802579cc69a74c77a1ae21447b930e5a704f9ec4120,v1=1ba18712726898fbbe48cd862dd096a709f7ad761a5bab14bda9ac24d963a6a8";
          Integer tolerance = 5 * 60;
          RequestVerifier.verifyRequestSignature(requestBody, requestHeader, signingSecret, tolerance);
      }
   }

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@freeclimb.com

Name		Name	Last commit message	Last commit date
Latest commit History 162 Commits
.github/workflows		.github/workflows
.openapi-generator		.openapi-generator
docs		docs
gradle/wrapper		gradle/wrapper
src		src
.gitignore		.gitignore
.openapi-generator-ignore		.openapi-generator-ignore
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
LICENSE.txt		LICENSE.txt
README.md		README.md
build.gradle		build.gradle
build.sbt		build.sbt
git_push.sh		git_push.sh
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
openapi.json		openapi.json
pom.xml		pom.xml
settings.gradle		settings.gradle

License

FreeClimbAPI/java-sdk

Folders and files

Latest commit

History

Repository files navigation

freeclimb-java-client

Requirements

Installation

Maven users

Gradle users

Others

Getting Started

Using PerCL

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

fc

Documentation for verifying request signature

Recommendation

Author

About

Topics

Resources

License

Stars

Watchers

Forks

Languages