https://github.com/freeclimbapi/csharp-sdk
C# SDK for the FreeClimb API
https://github.com/freeclimbapi/csharp-sdk
library sdk
Last synced: 9 months ago
JSON representation
C# SDK for the FreeClimb API
- Host: GitHub
- URL: https://github.com/freeclimbapi/csharp-sdk
- Owner: FreeClimbAPI
- License: mit
- Created: 2019-10-30T14:53:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T20:27:20.000Z (11 months ago)
- Last Synced: 2025-03-30T02:33:32.192Z (10 months ago)
- Topics: library, sdk
- Language: C#
- Size: 11.7 MB
- Stars: 4
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# freeclimb - the C# library for the FreeClimb API
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 C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- SDK version: 5.1.1
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 112.0.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later
- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
```
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
```
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742).
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
## Installation
Run the following command to generate the DLL
- [Mac/Linux] `/bin/sh build.sh`
- [Windows] `build.bat`
Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:
```csharp
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
```
## Packaging
A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages.
This `.nuspec` uses placeholders from the `.csproj`, so build the `.csproj` directly:
```
nuget pack -Build -OutputDirectory out freeclimb.csproj
```
Then, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual.
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
```csharp
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
```
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_ACCOUNT_ID";
config.Password = "YOUR_API_KEY";
var apiInstance = new DefaultApi(config);
var buyIncomingNumberRequest = new BuyIncomingNumberRequest(); // BuyIncomingNumberRequest | Incoming Number transaction details
try
{
// Buy a Phone Number
IncomingNumberResult result = apiInstance.BuyAPhoneNumber(buyIncomingNumberRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.BuyAPhoneNumber: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
## 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
- [Model.AccountRequest](docs/AccountRequest.md)
- [Model.AccountResult](docs/AccountResult.md)
- [Model.AccountStatus](docs/AccountStatus.md)
- [Model.AccountType](docs/AccountType.md)
- [Model.AddToConference](docs/AddToConference.md)
- [Model.AddToConferenceNotificationWebhook](docs/AddToConferenceNotificationWebhook.md)
- [Model.AddToQueueNotificationWebhook](docs/AddToQueueNotificationWebhook.md)
- [Model.AnsweredBy](docs/AnsweredBy.md)
- [Model.ApplicationList](docs/ApplicationList.md)
- [Model.ApplicationRequest](docs/ApplicationRequest.md)
- [Model.ApplicationResult](docs/ApplicationResult.md)
- [Model.AvailableNumber](docs/AvailableNumber.md)
- [Model.AvailableNumberList](docs/AvailableNumberList.md)
- [Model.BargeInReason](docs/BargeInReason.md)
- [Model.BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)
- [Model.CallControlWebhook](docs/CallControlWebhook.md)
- [Model.CallDirection](docs/CallDirection.md)
- [Model.CallEndedReason](docs/CallEndedReason.md)
- [Model.CallList](docs/CallList.md)
- [Model.CallResult](docs/CallResult.md)
- [Model.CallStatus](docs/CallStatus.md)
- [Model.CallStatusWebhook](docs/CallStatusWebhook.md)
- [Model.Capabilities](docs/Capabilities.md)
- [Model.CompletionRequest](docs/CompletionRequest.md)
- [Model.CompletionResult](docs/CompletionResult.md)
- [Model.CompletionResultStatus](docs/CompletionResultStatus.md)
- [Model.ConferenceList](docs/ConferenceList.md)
- [Model.ConferenceParticipantList](docs/ConferenceParticipantList.md)
- [Model.ConferenceParticipantResult](docs/ConferenceParticipantResult.md)
- [Model.ConferenceRecordingStatusWebhook](docs/ConferenceRecordingStatusWebhook.md)
- [Model.ConferenceResult](docs/ConferenceResult.md)
- [Model.ConferenceStatus](docs/ConferenceStatus.md)
- [Model.ConferenceStatusWebhook](docs/ConferenceStatusWebhook.md)
- [Model.CreateConference](docs/CreateConference.md)
- [Model.CreateConferenceRequest](docs/CreateConferenceRequest.md)
- [Model.CreateConferenceWebhook](docs/CreateConferenceWebhook.md)
- [Model.CreateWebRTCToken](docs/CreateWebRTCToken.md)
- [Model.Dequeue](docs/Dequeue.md)
- [Model.DequeueWebhook](docs/DequeueWebhook.md)
- [Model.Enqueue](docs/Enqueue.md)
- [Model.FilterLogsRequest](docs/FilterLogsRequest.md)
- [Model.GetDigits](docs/GetDigits.md)
- [Model.GetDigitsReason](docs/GetDigitsReason.md)
- [Model.GetDigitsWebhook](docs/GetDigitsWebhook.md)
- [Model.GetSpeech](docs/GetSpeech.md)
- [Model.GetSpeechReason](docs/GetSpeechReason.md)
- [Model.GetSpeechWebhook](docs/GetSpeechWebhook.md)
- [Model.GrammarFileBuiltIn](docs/GrammarFileBuiltIn.md)
- [Model.GrammarType](docs/GrammarType.md)
- [Model.Hangup](docs/Hangup.md)
- [Model.IfMachine](docs/IfMachine.md)
- [Model.InboundCallWebhook](docs/InboundCallWebhook.md)
- [Model.IncomingNumberList](docs/IncomingNumberList.md)
- [Model.IncomingNumberRequest](docs/IncomingNumberRequest.md)
- [Model.IncomingNumberResult](docs/IncomingNumberResult.md)
- [Model.Language](docs/Language.md)
- [Model.LeaveConferenceWebhook](docs/LeaveConferenceWebhook.md)
- [Model.LogLevel](docs/LogLevel.md)
- [Model.LogList](docs/LogList.md)
- [Model.LogResult](docs/LogResult.md)
- [Model.MachineDetectedWebhook](docs/MachineDetectedWebhook.md)
- [Model.MachineType](docs/MachineType.md)
- [Model.MakeCallRequest](docs/MakeCallRequest.md)
- [Model.MessageDeliveryWebhook](docs/MessageDeliveryWebhook.md)
- [Model.MessageDirection](docs/MessageDirection.md)
- [Model.MessageRequest](docs/MessageRequest.md)
- [Model.MessageResult](docs/MessageResult.md)
- [Model.MessageStatus](docs/MessageStatus.md)
- [Model.MessageStatusWebhook](docs/MessageStatusWebhook.md)
- [Model.MessagesList](docs/MessagesList.md)
- [Model.MutableResourceModel](docs/MutableResourceModel.md)
- [Model.OutDial](docs/OutDial.md)
- [Model.OutDialApiConnectWebhook](docs/OutDialApiConnectWebhook.md)
- [Model.OutDialConnectWebhook](docs/OutDialConnectWebhook.md)
- [Model.OutDialStartWebhook](docs/OutDialStartWebhook.md)
- [Model.PaginationModel](docs/PaginationModel.md)
- [Model.Park](docs/Park.md)
- [Model.Pause](docs/Pause.md)
- [Model.PerclCommand](docs/PerclCommand.md)
- [Model.PerclScript](docs/PerclScript.md)
- [Model.Play](docs/Play.md)
- [Model.PlayBeep](docs/PlayBeep.md)
- [Model.PlayEarlyMedia](docs/PlayEarlyMedia.md)
- [Model.QueueList](docs/QueueList.md)
- [Model.QueueMember](docs/QueueMember.md)
- [Model.QueueMemberList](docs/QueueMemberList.md)
- [Model.QueueRequest](docs/QueueRequest.md)
- [Model.QueueResult](docs/QueueResult.md)
- [Model.QueueResultStatus](docs/QueueResultStatus.md)
- [Model.QueueWaitWebhook](docs/QueueWaitWebhook.md)
- [Model.RecordUtterance](docs/RecordUtterance.md)
- [Model.RecordUtteranceTermReason](docs/RecordUtteranceTermReason.md)
- [Model.RecordWebhook](docs/RecordWebhook.md)
- [Model.RecordingList](docs/RecordingList.md)
- [Model.RecordingResult](docs/RecordingResult.md)
- [Model.Redirect](docs/Redirect.md)
- [Model.RedirectWebhook](docs/RedirectWebhook.md)
- [Model.Reject](docs/Reject.md)
- [Model.RemoveFromConference](docs/RemoveFromConference.md)
- [Model.RemoveFromQueueNotificationWebhook](docs/RemoveFromQueueNotificationWebhook.md)
- [Model.RequestType](docs/RequestType.md)
- [Model.SMSTenDLCBrand](docs/SMSTenDLCBrand.md)
- [Model.SMSTenDLCBrandAltBusinessIdType](docs/SMSTenDLCBrandAltBusinessIdType.md)
- [Model.SMSTenDLCBrandEntityType](docs/SMSTenDLCBrandEntityType.md)
- [Model.SMSTenDLCBrandIdentityStatus](docs/SMSTenDLCBrandIdentityStatus.md)
- [Model.SMSTenDLCBrandRelationship](docs/SMSTenDLCBrandRelationship.md)
- [Model.SMSTenDLCBrandStockExchange](docs/SMSTenDLCBrandStockExchange.md)
- [Model.SMSTenDLCBrandsListResult](docs/SMSTenDLCBrandsListResult.md)
- [Model.SMSTenDLCCampaign](docs/SMSTenDLCCampaign.md)
- [Model.SMSTenDLCCampaignStatus](docs/SMSTenDLCCampaignStatus.md)
- [Model.SMSTenDLCCampaignsListResult](docs/SMSTenDLCCampaignsListResult.md)
- [Model.SMSTenDLCPartnerCampaign](docs/SMSTenDLCPartnerCampaign.md)
- [Model.SMSTenDLCPartnerCampaignBrand](docs/SMSTenDLCPartnerCampaignBrand.md)
- [Model.SMSTenDLCPartnerCampaignStatus](docs/SMSTenDLCPartnerCampaignStatus.md)
- [Model.SMSTenDLCPartnerCampaignsListResult](docs/SMSTenDLCPartnerCampaignsListResult.md)
- [Model.SMSTollFreeCampaign](docs/SMSTollFreeCampaign.md)
- [Model.SMSTollFreeCampaignRegistrationStatus](docs/SMSTollFreeCampaignRegistrationStatus.md)
- [Model.SMSTollFreeCampaignsListResult](docs/SMSTollFreeCampaignsListResult.md)
- [Model.Say](docs/Say.md)
- [Model.SendDigits](docs/SendDigits.md)
- [Model.SetDTMFPassThrough](docs/SetDTMFPassThrough.md)
- [Model.SetListen](docs/SetListen.md)
- [Model.SetTalk](docs/SetTalk.md)
- [Model.Sms](docs/Sms.md)
- [Model.StartRecordCall](docs/StartRecordCall.md)
- [Model.TFN](docs/TFN.md)
- [Model.TFNCampaign](docs/TFNCampaign.md)
- [Model.TerminateConference](docs/TerminateConference.md)
- [Model.TranscribeReason](docs/TranscribeReason.md)
- [Model.TranscribeTermReason](docs/TranscribeTermReason.md)
- [Model.TranscribeUtterance](docs/TranscribeUtterance.md)
- [Model.TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
- [Model.TranscribeWebhook](docs/TranscribeWebhook.md)
- [Model.Unpark](docs/Unpark.md)
- [Model.UpdateCallRequest](docs/UpdateCallRequest.md)
- [Model.UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)
- [Model.UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
- [Model.UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
- [Model.UpdateConferenceRequestStatus](docs/UpdateConferenceRequestStatus.md)
- [Model.Webhook](docs/Webhook.md)
## Documentation for Authorization
Authentication schemes defined for the API:
### fc
- **Type**: HTTP basic authentication
## Documentation for Serialization/Deserialization for Enums
### These methods are not required unless being used for debugging/logging purposes
- To deserialize (turn value into enum), every enum class has a {classname}ValueConverter class that allows for deserialization into the enum class.
For example
```csharp
using freeclimb.Enums;
namespace Example
{
public class DeserializeEnumExample
{
public static void Main()
{
AccountStatus accountStatus = AccountStatusValueConverter.FromString("active");
Assert.IsType(accountStatus);
}
}
}
```
- To serialize an enum to a value, simply use `nameof` with your enum instance
For example
```csharp
using freeclimb.Enums;
namespace Example
{
public class SerializeEnumExample
{
public static void Main()
{
AccountStatus accountStatus = AccountStatus.ACTIVE;
string statusValue = nameof(accountStatus);
Assert.Equal("active", statusValue);
}
}
}
```
## 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:
```csharp
using freeclimb.Model;
namespace Example
{
public class UsingPerclExample
{
public static void Main()
{
CreateConference create = new CreateConference("", false, PlayBeep.ALWAYS, false, "", "");
List commands = new List();
commands.Add(create);
PerclScript script = new PerclScript(commands);
string expectedJSONString = "[{\"CreateConference\":{\"actionUrl\":\"\",\"alias\":false,\"playBeep\":\"always\",\"record\":false,\"statusCallbackUrl\":\"\",\"waitUrl\":\"\"}}]";
Assert.Equal(expectedJSONString, script.ToJson());
}
}
}
```
## 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 int
Example code down below
```csharp
using freeclimb.Utils;
using System;
namespace Example
{
public class verifySignatureRequestExample
{
public static void Main()
{
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";
int tolerance = 5 * 60;
RequestVerifier.verifyRequestSignature(requestBody, requestHeader, signingSecret, tolerance)
}
}
}
```