https://github.com/freeclimbapi/java-sdk
Java SDK for the FreeClimb API
https://github.com/freeclimbapi/java-sdk
library sdk
Last synced: 9 months ago
JSON representation
Java SDK for the FreeClimb API
- Host: GitHub
- URL: https://github.com/freeclimbapi/java-sdk
- Owner: FreeClimbAPI
- License: mit
- Created: 2019-10-30T14:44:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T20:28:26.000Z (11 months ago)
- Last Synced: 2025-04-23T19:04:06.219Z (9 months ago)
- Topics: library, sdk
- Language: Java
- Size: 2.18 MB
- Stars: 0
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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/](https://www.freeclimb.com/support/)
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
## Requirements
Building the API client library requires:
1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
com.github.freeclimbapi
freeclimb-java-client
6.1.2
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
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:6.1.2"
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:
```shell
mvn clean package
```
Then manually install the following JARs:
* `target/freeclimb-java-client-6.1.2.jar`
* `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
// 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:
```typescript
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**](docs/DefaultApi.md#buyAPhoneNumber) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
*DefaultApi* | [**createAConference**](docs/DefaultApi.md#createAConference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
*DefaultApi* | [**createAQueue**](docs/DefaultApi.md#createAQueue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
*DefaultApi* | [**createAnApplication**](docs/DefaultApi.md#createAnApplication) | **POST** /Accounts/{accountId}/Applications | Create an application
*DefaultApi* | [**createKnowledgeBaseCompletion**](docs/DefaultApi.md#createKnowledgeBaseCompletion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
*DefaultApi* | [**deleteARecording**](docs/DefaultApi.md#deleteARecording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
*DefaultApi* | [**deleteAnApplication**](docs/DefaultApi.md#deleteAnApplication) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
*DefaultApi* | [**deleteAnIncomingNumber**](docs/DefaultApi.md#deleteAnIncomingNumber) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
*DefaultApi* | [**dequeueAMember**](docs/DefaultApi.md#dequeueAMember) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
*DefaultApi* | [**dequeueHeadMember**](docs/DefaultApi.md#dequeueHeadMember) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
*DefaultApi* | [**downloadARecordingFile**](docs/DefaultApi.md#downloadARecordingFile) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
*DefaultApi* | [**filterLogs**](docs/DefaultApi.md#filterLogs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
*DefaultApi* | [**getACall**](docs/DefaultApi.md#getACall) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
*DefaultApi* | [**getAConference**](docs/DefaultApi.md#getAConference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
*DefaultApi* | [**getAMember**](docs/DefaultApi.md#getAMember) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member
*DefaultApi* | [**getAParticipant**](docs/DefaultApi.md#getAParticipant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
*DefaultApi* | [**getAQueue**](docs/DefaultApi.md#getAQueue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
*DefaultApi* | [**getARecording**](docs/DefaultApi.md#getARecording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
*DefaultApi* | [**getAnAccount**](docs/DefaultApi.md#getAnAccount) | **GET** /Accounts/{accountId} | Get an Account
*DefaultApi* | [**getAnApplication**](docs/DefaultApi.md#getAnApplication) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
*DefaultApi* | [**getAnIncomingNumber**](docs/DefaultApi.md#getAnIncomingNumber) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
*DefaultApi* | [**getAnSmsMessage**](docs/DefaultApi.md#getAnSmsMessage) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
*DefaultApi* | [**getHeadMember**](docs/DefaultApi.md#getHeadMember) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
*DefaultApi* | [**getTenDLCSmsBrand**](docs/DefaultApi.md#getTenDLCSmsBrand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand
*DefaultApi* | [**getTenDLCSmsBrands**](docs/DefaultApi.md#getTenDLCSmsBrands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands
*DefaultApi* | [**getTenDLCSmsCampaign**](docs/DefaultApi.md#getTenDLCSmsCampaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign
*DefaultApi* | [**getTenDLCSmsCampaigns**](docs/DefaultApi.md#getTenDLCSmsCampaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns
*DefaultApi* | [**getTenDLCSmsPartnerCampaign**](docs/DefaultApi.md#getTenDLCSmsPartnerCampaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign
*DefaultApi* | [**getTenDLCSmsPartnerCampaigns**](docs/DefaultApi.md#getTenDLCSmsPartnerCampaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns
*DefaultApi* | [**getTollFreeSmsCampaign**](docs/DefaultApi.md#getTollFreeSmsCampaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign
*DefaultApi* | [**getTollFreeSmsCampaigns**](docs/DefaultApi.md#getTollFreeSmsCampaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns
*DefaultApi* | [**listActiveQueues**](docs/DefaultApi.md#listActiveQueues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
*DefaultApi* | [**listAllAccountLogs**](docs/DefaultApi.md#listAllAccountLogs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
*DefaultApi* | [**listApplications**](docs/DefaultApi.md#listApplications) | **GET** /Accounts/{accountId}/Applications | List applications
*DefaultApi* | [**listAvailableNumbers**](docs/DefaultApi.md#listAvailableNumbers) | **GET** /AvailablePhoneNumbers | List available numbers
*DefaultApi* | [**listCallLogs**](docs/DefaultApi.md#listCallLogs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
*DefaultApi* | [**listCallRecordings**](docs/DefaultApi.md#listCallRecordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
*DefaultApi* | [**listCalls**](docs/DefaultApi.md#listCalls) | **GET** /Accounts/{accountId}/Calls | List Calls
*DefaultApi* | [**listConferenceRecordings**](docs/DefaultApi.md#listConferenceRecordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings
*DefaultApi* | [**listConferences**](docs/DefaultApi.md#listConferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
*DefaultApi* | [**listIncomingNumbers**](docs/DefaultApi.md#listIncomingNumbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
*DefaultApi* | [**listMembers**](docs/DefaultApi.md#listMembers) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
*DefaultApi* | [**listParticipants**](docs/DefaultApi.md#listParticipants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
*DefaultApi* | [**listRecordings**](docs/DefaultApi.md#listRecordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
*DefaultApi* | [**listSmsMessages**](docs/DefaultApi.md#listSmsMessages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
*DefaultApi* | [**makeACall**](docs/DefaultApi.md#makeACall) | **POST** /Accounts/{accountId}/Calls | Make a Call
*DefaultApi* | [**makeAWebrtcJwt**](docs/DefaultApi.md#makeAWebrtcJwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling
*DefaultApi* | [**removeAParticipant**](docs/DefaultApi.md#removeAParticipant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
*DefaultApi* | [**sendAnSmsMessage**](docs/DefaultApi.md#sendAnSmsMessage) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
*DefaultApi* | [**streamARecordingFile**](docs/DefaultApi.md#streamARecordingFile) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
*DefaultApi* | [**updateAConference**](docs/DefaultApi.md#updateAConference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
*DefaultApi* | [**updateALiveCall**](docs/DefaultApi.md#updateALiveCall) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call
*DefaultApi* | [**updateAParticipant**](docs/DefaultApi.md#updateAParticipant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant
*DefaultApi* | [**updateAQueue**](docs/DefaultApi.md#updateAQueue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue
*DefaultApi* | [**updateAnAccount**](docs/DefaultApi.md#updateAnAccount) | **POST** /Accounts/{accountId} | Manage an account
*DefaultApi* | [**updateAnApplication**](docs/DefaultApi.md#updateAnApplication) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
*DefaultApi* | [**updateAnIncomingNumber**](docs/DefaultApi.md#updateAnIncomingNumber) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
| *DefaultApi* | [**getNextPage**](docs/DefaultApi.md#getNextPage) | **GET** | Get next page of paginated resource
## Documentation for Models
- [AccountRequest](docs/AccountRequest.md)
- [AccountResult](docs/AccountResult.md)
- [AccountStatus](docs/AccountStatus.md)
- [AccountType](docs/AccountType.md)
- [AddToConference](docs/AddToConference.md)
- [AddToConferenceNotificationWebhook](docs/AddToConferenceNotificationWebhook.md)
- [AddToQueueNotificationWebhook](docs/AddToQueueNotificationWebhook.md)
- [AnsweredBy](docs/AnsweredBy.md)
- [ApplicationList](docs/ApplicationList.md)
- [ApplicationRequest](docs/ApplicationRequest.md)
- [ApplicationResult](docs/ApplicationResult.md)
- [AvailableNumber](docs/AvailableNumber.md)
- [AvailableNumberList](docs/AvailableNumberList.md)
- [BargeInReason](docs/BargeInReason.md)
- [BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)
- [CallControlWebhook](docs/CallControlWebhook.md)
- [CallDirection](docs/CallDirection.md)
- [CallEndedReason](docs/CallEndedReason.md)
- [CallList](docs/CallList.md)
- [CallResult](docs/CallResult.md)
- [CallStatus](docs/CallStatus.md)
- [CallStatusWebhook](docs/CallStatusWebhook.md)
- [Capabilities](docs/Capabilities.md)
- [CompletionRequest](docs/CompletionRequest.md)
- [CompletionResult](docs/CompletionResult.md)
- [CompletionResultStatus](docs/CompletionResultStatus.md)
- [ConferenceList](docs/ConferenceList.md)
- [ConferenceParticipantList](docs/ConferenceParticipantList.md)
- [ConferenceParticipantResult](docs/ConferenceParticipantResult.md)
- [ConferenceRecordingStatusWebhook](docs/ConferenceRecordingStatusWebhook.md)
- [ConferenceResult](docs/ConferenceResult.md)
- [ConferenceStatus](docs/ConferenceStatus.md)
- [ConferenceStatusWebhook](docs/ConferenceStatusWebhook.md)
- [CreateConference](docs/CreateConference.md)
- [CreateConferenceRequest](docs/CreateConferenceRequest.md)
- [CreateConferenceWebhook](docs/CreateConferenceWebhook.md)
- [CreateWebRTCToken](docs/CreateWebRTCToken.md)
- [Dequeue](docs/Dequeue.md)
- [DequeueWebhook](docs/DequeueWebhook.md)
- [Enqueue](docs/Enqueue.md)
- [FilterLogsRequest](docs/FilterLogsRequest.md)
- [GetDigits](docs/GetDigits.md)
- [GetDigitsReason](docs/GetDigitsReason.md)
- [GetDigitsWebhook](docs/GetDigitsWebhook.md)
- [GetSpeech](docs/GetSpeech.md)
- [GetSpeechReason](docs/GetSpeechReason.md)
- [GetSpeechWebhook](docs/GetSpeechWebhook.md)
- [GrammarFileBuiltIn](docs/GrammarFileBuiltIn.md)
- [GrammarType](docs/GrammarType.md)
- [Hangup](docs/Hangup.md)
- [IfMachine](docs/IfMachine.md)
- [InboundCallWebhook](docs/InboundCallWebhook.md)
- [IncomingNumberList](docs/IncomingNumberList.md)
- [IncomingNumberRequest](docs/IncomingNumberRequest.md)
- [IncomingNumberResult](docs/IncomingNumberResult.md)
- [Language](docs/Language.md)
- [LeaveConferenceWebhook](docs/LeaveConferenceWebhook.md)
- [LogLevel](docs/LogLevel.md)
- [LogList](docs/LogList.md)
- [LogResult](docs/LogResult.md)
- [MachineDetectedWebhook](docs/MachineDetectedWebhook.md)
- [MachineType](docs/MachineType.md)
- [MakeCallRequest](docs/MakeCallRequest.md)
- [MessageDeliveryWebhook](docs/MessageDeliveryWebhook.md)
- [MessageDirection](docs/MessageDirection.md)
- [MessageRequest](docs/MessageRequest.md)
- [MessageResult](docs/MessageResult.md)
- [MessageStatus](docs/MessageStatus.md)
- [MessageStatusWebhook](docs/MessageStatusWebhook.md)
- [MessagesList](docs/MessagesList.md)
- [MutableResourceModel](docs/MutableResourceModel.md)
- [OutDial](docs/OutDial.md)
- [OutDialApiConnectWebhook](docs/OutDialApiConnectWebhook.md)
- [OutDialConnectWebhook](docs/OutDialConnectWebhook.md)
- [OutDialStartWebhook](docs/OutDialStartWebhook.md)
- [PaginationModel](docs/PaginationModel.md)
- [Park](docs/Park.md)
- [Pause](docs/Pause.md)
- [PerclCommand](docs/PerclCommand.md)
- [PerclScript](docs/PerclScript.md)
- [Play](docs/Play.md)
- [PlayBeep](docs/PlayBeep.md)
- [PlayEarlyMedia](docs/PlayEarlyMedia.md)
- [QueueList](docs/QueueList.md)
- [QueueMember](docs/QueueMember.md)
- [QueueMemberList](docs/QueueMemberList.md)
- [QueueRequest](docs/QueueRequest.md)
- [QueueResult](docs/QueueResult.md)
- [QueueResultStatus](docs/QueueResultStatus.md)
- [QueueWaitWebhook](docs/QueueWaitWebhook.md)
- [RecordUtterance](docs/RecordUtterance.md)
- [RecordUtteranceTermReason](docs/RecordUtteranceTermReason.md)
- [RecordWebhook](docs/RecordWebhook.md)
- [RecordingList](docs/RecordingList.md)
- [RecordingResult](docs/RecordingResult.md)
- [Redirect](docs/Redirect.md)
- [RedirectWebhook](docs/RedirectWebhook.md)
- [Reject](docs/Reject.md)
- [RemoveFromConference](docs/RemoveFromConference.md)
- [RemoveFromQueueNotificationWebhook](docs/RemoveFromQueueNotificationWebhook.md)
- [RequestType](docs/RequestType.md)
- [SMSTenDLCBrand](docs/SMSTenDLCBrand.md)
- [SMSTenDLCBrandAltBusinessIdType](docs/SMSTenDLCBrandAltBusinessIdType.md)
- [SMSTenDLCBrandEntityType](docs/SMSTenDLCBrandEntityType.md)
- [SMSTenDLCBrandIdentityStatus](docs/SMSTenDLCBrandIdentityStatus.md)
- [SMSTenDLCBrandRelationship](docs/SMSTenDLCBrandRelationship.md)
- [SMSTenDLCBrandStockExchange](docs/SMSTenDLCBrandStockExchange.md)
- [SMSTenDLCBrandsListResult](docs/SMSTenDLCBrandsListResult.md)
- [SMSTenDLCCampaign](docs/SMSTenDLCCampaign.md)
- [SMSTenDLCCampaignStatus](docs/SMSTenDLCCampaignStatus.md)
- [SMSTenDLCCampaignsListResult](docs/SMSTenDLCCampaignsListResult.md)
- [SMSTenDLCPartnerCampaign](docs/SMSTenDLCPartnerCampaign.md)
- [SMSTenDLCPartnerCampaignBrand](docs/SMSTenDLCPartnerCampaignBrand.md)
- [SMSTenDLCPartnerCampaignStatus](docs/SMSTenDLCPartnerCampaignStatus.md)
- [SMSTenDLCPartnerCampaignsListResult](docs/SMSTenDLCPartnerCampaignsListResult.md)
- [SMSTollFreeCampaign](docs/SMSTollFreeCampaign.md)
- [SMSTollFreeCampaignRegistrationStatus](docs/SMSTollFreeCampaignRegistrationStatus.md)
- [SMSTollFreeCampaignsListResult](docs/SMSTollFreeCampaignsListResult.md)
- [Say](docs/Say.md)
- [SendDigits](docs/SendDigits.md)
- [SetDTMFPassThrough](docs/SetDTMFPassThrough.md)
- [SetListen](docs/SetListen.md)
- [SetTalk](docs/SetTalk.md)
- [Sms](docs/Sms.md)
- [StartRecordCall](docs/StartRecordCall.md)
- [TFN](docs/TFN.md)
- [TFNCampaign](docs/TFNCampaign.md)
- [TerminateConference](docs/TerminateConference.md)
- [TranscribeReason](docs/TranscribeReason.md)
- [TranscribeTermReason](docs/TranscribeTermReason.md)
- [TranscribeUtterance](docs/TranscribeUtterance.md)
- [TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
- [TranscribeWebhook](docs/TranscribeWebhook.md)
- [Unpark](docs/Unpark.md)
- [UpdateCallRequest](docs/UpdateCallRequest.md)
- [UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)
- [UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
- [UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
- [UpdateConferenceRequestStatus](docs/UpdateConferenceRequestStatus.md)
- [Webhook](docs/Webhook.md)
## 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
```java
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