All URIs are relative to https://www.freeclimb.com/apiserver
| Method | HTTP request | Description |
|---|---|---|
| BuyAPhoneNumber | POST /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number |
| CreateAConference | POST /Accounts/{accountId}/Conferences | Create a Conference |
| CreateAQueue | POST /Accounts/{accountId}/Queues | Create a Queue |
| CreateAnApplication | POST /Accounts/{accountId}/Applications | Create an application |
| CreateKnowledgeBaseCompletion | POST /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
| DeleteARecording | DELETE /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
| DeleteAnApplication | DELETE /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
| DeleteAnIncomingNumber | DELETE /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
| DequeueAMember | POST /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member |
| DequeueHeadMember | POST /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member |
| DownloadARecordingFile | GET /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File |
| FilterLogs | POST /Accounts/{accountId}/Logs | Filter Logs |
| GetACall | GET /Accounts/{accountId}/Calls/{callId} | Get a Call |
| GetAConference | GET /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference |
| GetAMember | GET /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member |
| GetAParticipant | GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant |
| GetAQueue | GET /Accounts/{accountId}/Queues/{queueId} | Get a Queue |
| GetARecording | GET /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording |
| GetAnAccount | GET /Accounts/{accountId} | Get an Account |
| GetAnApplication | GET /Accounts/{accountId}/Applications/{applicationId} | Get an Application |
| GetAnIncomingNumber | GET /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number |
| GetAnSmsMessage | GET /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message |
| GetHeadMember | GET /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member |
| GetTenDLCSmsBrand | GET /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand |
| GetTenDLCSmsBrands | GET /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands |
| GetTenDLCSmsCampaign | GET /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign |
| GetTenDLCSmsCampaigns | GET /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns |
| GetTenDLCSmsPartnerCampaign | GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign |
| GetTenDLCSmsPartnerCampaigns | GET /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns |
| GetTollFreeSmsCampaign | GET /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign |
| GetTollFreeSmsCampaigns | GET /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns |
| ListActiveQueues | GET /Accounts/{accountId}/Queues | List Active Queues |
| ListAllAccountLogs | GET /Accounts/{accountId}/Logs | List All Account Logs |
| ListApplications | GET /Accounts/{accountId}/Applications | List applications |
| ListAvailableNumbers | GET /AvailablePhoneNumbers | List available numbers |
| ListCallLogs | GET /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs |
| ListCallRecordings | GET /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings |
| ListCalls | GET /Accounts/{accountId}/Calls | List Calls |
| ListConferenceRecordings | GET /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings |
| ListConferences | GET /Accounts/{accountId}/Conferences | List Conferences |
| ListIncomingNumbers | GET /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
| ListMembers | GET /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
| ListParticipants | GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants |
| ListRecordings | GET /Accounts/{accountId}/Recordings | List Recordings |
| ListSmsMessages | GET /Accounts/{accountId}/Messages | List SMS Messages |
| MakeACall | POST /Accounts/{accountId}/Calls | Make a Call |
| MakeAWebrtcJwt | POST /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling |
| RemoveAParticipant | DELETE /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant |
| SendAnSmsMessage | POST /Accounts/{accountId}/Messages | Send an SMS Message |
| StreamARecordingFile | GET /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File |
| UpdateAConference | POST /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference |
| UpdateALiveCall | POST /Accounts/{accountId}/Calls/{callId} | Update a Live Call |
| UpdateAParticipant | POST /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant |
| UpdateAQueue | POST /Accounts/{accountId}/Queues/{queueId} | Update a Queue |
| UpdateAnAccount | POST /Accounts/{accountId} | Manage an account |
| UpdateAnApplication | POST /Accounts/{accountId}/Applications/{applicationId} | Update an application |
| UpdateAnIncomingNumber | POST /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number |
IncomingNumberResult BuyAPhoneNumber (BuyIncomingNumberRequest buyIncomingNumberRequest)
Buy a Phone Number
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class BuyAPhoneNumberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
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);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Buy a Phone Number
ApiResponse<IncomingNumberResult> response = apiInstance.BuyAPhoneNumberWithHttpInfo(buyIncomingNumberRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.BuyAPhoneNumberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| buyIncomingNumberRequest | BuyIncomingNumberRequest | Incoming Number transaction details | |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Incoming Number transaction | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceResult CreateAConference (CreateConferenceRequest? createConferenceRequest = null)
Create a Conference
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class CreateAConferenceExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var createConferenceRequest = new CreateConferenceRequest?(); // CreateConferenceRequest? | Conference to create (optional)
try
{
// Create a Conference
ConferenceResult result = apiInstance.CreateAConference(createConferenceRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAConference: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create a Conference
ApiResponse<ConferenceResult> response = apiInstance.CreateAConferenceWithHttpInfo(createConferenceRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAConferenceWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| createConferenceRequest | CreateConferenceRequest? | Conference to create | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Details of created conference | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResult CreateAQueue (QueueRequest? queueRequest = null)
Create a Queue
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class CreateAQueueExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueRequest = new QueueRequest?(); // QueueRequest? | Queue details used to create a queue (optional)
try
{
// Create a Queue
QueueResult result = apiInstance.CreateAQueue(queueRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAQueue: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create a Queue
ApiResponse<QueueResult> response = apiInstance.CreateAQueueWithHttpInfo(queueRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAQueueWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueRequest | QueueRequest? | Queue details used to create a queue | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfuly created queue | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApplicationResult CreateAnApplication (ApplicationRequest? applicationRequest = null)
Create an application
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class CreateAnApplicationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var applicationRequest = new ApplicationRequest?(); // ApplicationRequest? | Application Details (optional)
try
{
// Create an application
ApplicationResult result = apiInstance.CreateAnApplication(applicationRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAnApplication: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create an application
ApiResponse<ApplicationResult> response = apiInstance.CreateAnApplicationWithHttpInfo(applicationRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateAnApplicationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| applicationRequest | ApplicationRequest? | Application Details | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Application successfuly created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CompletionResult CreateKnowledgeBaseCompletion (string knowledgeBaseId, CompletionRequest? completionRequest = null)
Query the knowledge base
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class CreateKnowledgeBaseCompletionExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var knowledgeBaseId = "knowledgeBaseId_example"; // string | A string that uniquely identifies the KnowledgeBase resource.
var completionRequest = new CompletionRequest?(); // CompletionRequest? | Completion request details (optional)
try
{
// Query the knowledge base
CompletionResult result = apiInstance.CreateKnowledgeBaseCompletion(knowledgeBaseId, completionRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateKnowledgeBaseCompletion: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Query the knowledge base
ApiResponse<CompletionResult> response = apiInstance.CreateKnowledgeBaseCompletionWithHttpInfo(knowledgeBaseId, completionRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.CreateKnowledgeBaseCompletionWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| knowledgeBaseId | string | A string that uniquely identifies the KnowledgeBase resource. | |
| completionRequest | CompletionRequest? | Completion request details | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | KnowledgeaBase completion response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void DeleteARecording (string recordingId)
Delete a Recording
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DeleteARecordingExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var recordingId = "recordingId_example"; // string | String that uniquely identifies this recording resource.
try
{
// Delete a Recording
apiInstance.DeleteARecording(recordingId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteARecording: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete a Recording
apiInstance.DeleteARecordingWithHttpInfo(recordingId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteARecordingWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| recordingId | string | String that uniquely identifies this recording resource. | |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Recording Deleted | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void DeleteAnApplication (string applicationId)
Delete an application
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DeleteAnApplicationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var applicationId = "applicationId_example"; // string | String that uniquely identifies this application resource.
try
{
// Delete an application
apiInstance.DeleteAnApplication(applicationId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteAnApplication: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete an application
apiInstance.DeleteAnApplicationWithHttpInfo(applicationId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteAnApplicationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| applicationId | string | String that uniquely identifies this application resource. | |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful application deletion | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void DeleteAnIncomingNumber (string phoneNumberId)
Delete an Incoming Number
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DeleteAnIncomingNumberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var phoneNumberId = "phoneNumberId_example"; // string | String that uniquely identifies this phone number resource.
try
{
// Delete an Incoming Number
apiInstance.DeleteAnIncomingNumber(phoneNumberId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteAnIncomingNumber: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete an Incoming Number
apiInstance.DeleteAnIncomingNumberWithHttpInfo(phoneNumberId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DeleteAnIncomingNumberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| phoneNumberId | string | String that uniquely identifies this phone number resource. | |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful Incoming Number deletion. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueMember DequeueAMember (string queueId, string callId)
Dequeue a Member
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DequeueAMemberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | String that uniquely identifies the Queue that the Member belongs to.
var callId = "callId_example"; // string | ID if the Call that the Member belongs to
try
{
// Dequeue a Member
QueueMember result = apiInstance.DequeueAMember(queueId, callId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DequeueAMember: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Dequeue a Member
ApiResponse<QueueMember> response = apiInstance.DequeueAMemberWithHttpInfo(queueId, callId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DequeueAMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | String that uniquely identifies the Queue that the Member belongs to. | |
| callId | string | ID if the Call that the Member belongs to | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 202 | Accepted dequeue request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueMember DequeueHeadMember (string queueId)
Dequeue Head Member
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DequeueHeadMemberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | String that uniquely identifies this queue resource.
try
{
// Dequeue Head Member
QueueMember result = apiInstance.DequeueHeadMember(queueId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DequeueHeadMember: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Dequeue Head Member
ApiResponse<QueueMember> response = apiInstance.DequeueHeadMemberWithHttpInfo(queueId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DequeueHeadMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | String that uniquely identifies this queue resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 202 | Accepted dequeue request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
System.IO.Stream DownloadARecordingFile (string recordingId)
Download a Recording File
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class DownloadARecordingFileExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var recordingId = "recordingId_example"; // string | String that uniquely identifies this recording resource.
try
{
// Download a Recording File
System.IO.Stream result = apiInstance.DownloadARecordingFile(recordingId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DownloadARecordingFile: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Download a Recording File
ApiResponse<System.IO.Stream> response = apiInstance.DownloadARecordingFileWithHttpInfo(recordingId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.DownloadARecordingFileWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| recordingId | string | String that uniquely identifies this recording resource. | |
System.IO.Stream
- Content-Type: Not defined
- Accept: audio/x-wav
| Status code | Description | Response headers |
|---|---|---|
| 200 | Download a Recording file represented with audio/x-wav mime-type | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LogList FilterLogs (FilterLogsRequest filterLogsRequest)
Filter Logs
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class FilterLogsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var filterLogsRequest = new FilterLogsRequest(); // FilterLogsRequest | Filter logs request paramters
try
{
// Filter Logs
LogList result = apiInstance.FilterLogs(filterLogsRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.FilterLogs: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Filter Logs
ApiResponse<LogList> response = apiInstance.FilterLogsWithHttpInfo(filterLogsRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.FilterLogsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| filterLogsRequest | FilterLogsRequest | Filter logs request paramters | |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved log list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CallResult GetACall (string callId)
Get a Call
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetACallExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var callId = "callId_example"; // string | String that uniquely identifies this call resource.
try
{
// Get a Call
CallResult result = apiInstance.GetACall(callId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetACall: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Call
ApiResponse<CallResult> response = apiInstance.GetACallWithHttpInfo(callId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetACallWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| callId | string | String that uniquely identifies this call resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Call Resource | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceResult GetAConference (string conferenceId)
Get a Conference
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAConferenceExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | A string that uniquely identifies this conference resource.
try
{
// Get a Conference
ConferenceResult result = apiInstance.GetAConference(conferenceId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAConference: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Conference
ApiResponse<ConferenceResult> response = apiInstance.GetAConferenceWithHttpInfo(conferenceId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAConferenceWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | A string that uniquely identifies this conference resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved conference | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueMember GetAMember (string queueId, string callId)
Get a Member
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAMemberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | String that uniquely identifies the Queue that the Member belongs to.
var callId = "callId_example"; // string | ID of the Call that the Member belongs to
try
{
// Get a Member
QueueMember result = apiInstance.GetAMember(queueId, callId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAMember: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Member
ApiResponse<QueueMember> response = apiInstance.GetAMemberWithHttpInfo(queueId, callId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | String that uniquely identifies the Queue that the Member belongs to. | |
| callId | string | ID of the Call that the Member belongs to | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved a queue member | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceParticipantResult GetAParticipant (string conferenceId, string callId)
Get a Participant
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAParticipantExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | ID of the conference this participant is in.
var callId = "callId_example"; // string | ID of the Call associated with this participant.
try
{
// Get a Participant
ConferenceParticipantResult result = apiInstance.GetAParticipant(conferenceId, callId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAParticipant: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Participant
ApiResponse<ConferenceParticipantResult> response = apiInstance.GetAParticipantWithHttpInfo(conferenceId, callId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAParticipantWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | ID of the conference this participant is in. | |
| callId | string | ID of the Call associated with this participant. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved conference participant | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResult GetAQueue (string queueId)
Get a Queue
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAQueueExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | A string that uniquely identifies this queue resource.
try
{
// Get a Queue
QueueResult result = apiInstance.GetAQueue(queueId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAQueue: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Queue
ApiResponse<QueueResult> response = apiInstance.GetAQueueWithHttpInfo(queueId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAQueueWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | A string that uniquely identifies this queue resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved queue | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecordingResult GetARecording (string recordingId)
Get a Recording
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetARecordingExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var recordingId = "recordingId_example"; // string | String that uniquely identifies this recording resource.
try
{
// Get a Recording
RecordingResult result = apiInstance.GetARecording(recordingId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetARecording: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a Recording
ApiResponse<RecordingResult> response = apiInstance.GetARecordingWithHttpInfo(recordingId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetARecordingWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| recordingId | string | String that uniquely identifies this recording resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccountResult GetAnAccount ()
Get an Account
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAnAccountExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
try
{
// Get an Account
AccountResult result = apiInstance.GetAnAccount();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnAccount: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get an Account
ApiResponse<AccountResult> response = apiInstance.GetAnAccountWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnAccountWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Account Details | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApplicationResult GetAnApplication (string applicationId)
Get an Application
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAnApplicationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var applicationId = "applicationId_example"; // string | A string that uniquely identifies this application resource.
try
{
// Get an Application
ApplicationResult result = apiInstance.GetAnApplication(applicationId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnApplication: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get an Application
ApiResponse<ApplicationResult> response = apiInstance.GetAnApplicationWithHttpInfo(applicationId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnApplicationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| applicationId | string | A string that uniquely identifies this application resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Application Details | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IncomingNumberResult GetAnIncomingNumber (string phoneNumberId)
Get an Incoming Number
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAnIncomingNumberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var phoneNumberId = "phoneNumberId_example"; // string | String that uniquely identifies this phone number resource.
try
{
// Get an Incoming Number
IncomingNumberResult result = apiInstance.GetAnIncomingNumber(phoneNumberId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnIncomingNumber: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get an Incoming Number
ApiResponse<IncomingNumberResult> response = apiInstance.GetAnIncomingNumberWithHttpInfo(phoneNumberId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnIncomingNumberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| phoneNumberId | string | String that uniquely identifies this phone number resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Incoming Phone Number result. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MessageResult GetAnSmsMessage (string messageId)
Get an SMS Message
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetAnSmsMessageExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var messageId = "messageId_example"; // string | String that uniquely identifies this Message resource.
try
{
// Get an SMS Message
MessageResult result = apiInstance.GetAnSmsMessage(messageId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnSmsMessage: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get an SMS Message
ApiResponse<MessageResult> response = apiInstance.GetAnSmsMessageWithHttpInfo(messageId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetAnSmsMessageWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| messageId | string | String that uniquely identifies this Message resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The specific SMS message that’s been processed by FreeClimb | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueMember GetHeadMember (string queueId)
Get Head Member
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetHeadMemberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | String that uniquely identifies the Queue that the Member belongs to.
try
{
// Get Head Member
QueueMember result = apiInstance.GetHeadMember(queueId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetHeadMember: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get Head Member
ApiResponse<QueueMember> response = apiInstance.GetHeadMemberWithHttpInfo(queueId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetHeadMemberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | String that uniquely identifies the Queue that the Member belongs to. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved queue member | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCBrand GetTenDLCSmsBrand (string brandId)
Get a 10DLC SMS Brand
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsBrandExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var brandId = "brandId_example"; // string | String that uniquely identifies this brand resource.
try
{
// Get a 10DLC SMS Brand
SMSTenDLCBrand result = apiInstance.GetTenDLCSmsBrand(brandId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsBrand: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a 10DLC SMS Brand
ApiResponse<SMSTenDLCBrand> response = apiInstance.GetTenDLCSmsBrandWithHttpInfo(brandId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsBrandWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| brandId | string | String that uniquely identifies this brand resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The specific SMS 10DLC Brand that’s been processed by FreeClimb | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCBrandsListResult GetTenDLCSmsBrands ()
Get list of SMS 10DLC Brands
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsBrandsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
try
{
// Get list of SMS 10DLC Brands
SMSTenDLCBrandsListResult result = apiInstance.GetTenDLCSmsBrands();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsBrands: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get list of SMS 10DLC Brands
ApiResponse<SMSTenDLCBrandsListResult> response = apiInstance.GetTenDLCSmsBrandsWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsBrandsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list SMS 10DLC brands | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCCampaign GetTenDLCSmsCampaign (string campaignId)
Get a 10DLC SMS Campaign
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsCampaignExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var campaignId = "campaignId_example"; // string | String that uniquely identifies this campaign resource.
try
{
// Get a 10DLC SMS Campaign
SMSTenDLCCampaign result = apiInstance.GetTenDLCSmsCampaign(campaignId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsCampaign: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a 10DLC SMS Campaign
ApiResponse<SMSTenDLCCampaign> response = apiInstance.GetTenDLCSmsCampaignWithHttpInfo(campaignId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsCampaignWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| campaignId | string | String that uniquely identifies this campaign resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The specific SMS 10DLC Campaign that’s been processed by FreeClimb | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCCampaignsListResult GetTenDLCSmsCampaigns (string? brandId = null)
Get list of SMS 10DLC Campaigns
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsCampaignsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var brandId = "brandId_example"; // string? | The unique identifier for a brand (optional)
try
{
// Get list of SMS 10DLC Campaigns
SMSTenDLCCampaignsListResult result = apiInstance.GetTenDLCSmsCampaigns(brandId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsCampaigns: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get list of SMS 10DLC Campaigns
ApiResponse<SMSTenDLCCampaignsListResult> response = apiInstance.GetTenDLCSmsCampaignsWithHttpInfo(brandId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsCampaignsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| brandId | string? | The unique identifier for a brand | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list SMS 10DLC campaigns | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCPartnerCampaign GetTenDLCSmsPartnerCampaign (string campaignId)
Get a 10DLC SMS Partner Campaign
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsPartnerCampaignExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var campaignId = "campaignId_example"; // string | String that uniquely identifies this campaign resource.
try
{
// Get a 10DLC SMS Partner Campaign
SMSTenDLCPartnerCampaign result = apiInstance.GetTenDLCSmsPartnerCampaign(campaignId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsPartnerCampaign: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a 10DLC SMS Partner Campaign
ApiResponse<SMSTenDLCPartnerCampaign> response = apiInstance.GetTenDLCSmsPartnerCampaignWithHttpInfo(campaignId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsPartnerCampaignWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| campaignId | string | String that uniquely identifies this campaign resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The specific SMS 10DLC Partner Campaign that’s been processed by FreeClimb | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTenDLCPartnerCampaignsListResult GetTenDLCSmsPartnerCampaigns (string? brandId = null)
Get list of SMS 10DLC Partner Campaigns
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTenDLCSmsPartnerCampaignsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var brandId = "brandId_example"; // string? | The unique identifier for a brand (optional)
try
{
// Get list of SMS 10DLC Partner Campaigns
SMSTenDLCPartnerCampaignsListResult result = apiInstance.GetTenDLCSmsPartnerCampaigns(brandId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsPartnerCampaigns: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get list of SMS 10DLC Partner Campaigns
ApiResponse<SMSTenDLCPartnerCampaignsListResult> response = apiInstance.GetTenDLCSmsPartnerCampaignsWithHttpInfo(brandId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTenDLCSmsPartnerCampaignsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| brandId | string? | The unique identifier for a brand | [optional] |
SMSTenDLCPartnerCampaignsListResult
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list SMS 10DLC partner campaigns | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTollFreeCampaign GetTollFreeSmsCampaign (string campaignId)
Get a TollFree SMS Campaign
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTollFreeSmsCampaignExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var campaignId = "campaignId_example"; // string | String that uniquely identifies this TollFree Campaign resource.
try
{
// Get a TollFree SMS Campaign
SMSTollFreeCampaign result = apiInstance.GetTollFreeSmsCampaign(campaignId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTollFreeSmsCampaign: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a TollFree SMS Campaign
ApiResponse<SMSTollFreeCampaign> response = apiInstance.GetTollFreeSmsCampaignWithHttpInfo(campaignId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTollFreeSmsCampaignWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| campaignId | string | String that uniquely identifies this TollFree Campaign resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The specific SMS TollFree Campaign that’s been processed by FreeClimb | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SMSTollFreeCampaignsListResult GetTollFreeSmsCampaigns ()
Get list of TollFree Campaigns
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class GetTollFreeSmsCampaignsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
try
{
// Get list of TollFree Campaigns
SMSTollFreeCampaignsListResult result = apiInstance.GetTollFreeSmsCampaigns();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTollFreeSmsCampaigns: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get list of TollFree Campaigns
ApiResponse<SMSTollFreeCampaignsListResult> response = apiInstance.GetTollFreeSmsCampaignsWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetTollFreeSmsCampaignsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}SMSTollFreeCampaignsListResult
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list toll-free campaigns | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueList ListActiveQueues (string? alias = null)
List Active Queues
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListActiveQueuesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var alias = "alias_example"; // string? | Return only the Queue resources with aliases that exactly match this name. (optional)
try
{
// List Active Queues
QueueList result = apiInstance.ListActiveQueues(alias);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListActiveQueues: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Active Queues
ApiResponse<QueueList> response = apiInstance.ListActiveQueuesWithHttpInfo(alias);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListActiveQueuesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| alias | string? | Return only the Queue resources with aliases that exactly match this name. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfuly retrieved queue list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LogList ListAllAccountLogs ()
List All Account Logs
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListAllAccountLogsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
try
{
// List All Account Logs
LogList result = apiInstance.ListAllAccountLogs();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListAllAccountLogs: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List All Account Logs
ApiResponse<LogList> response = apiInstance.ListAllAccountLogsWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListAllAccountLogsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved log list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApplicationList ListApplications (string? alias = null)
List applications
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListApplicationsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var alias = "alias_example"; // string? | Return only applications with aliases that exactly match this value. (optional)
try
{
// List applications
ApplicationList result = apiInstance.ListApplications(alias);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListApplications: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List applications
ApiResponse<ApplicationList> response = apiInstance.ListApplicationsWithHttpInfo(alias);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListApplicationsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| alias | string? | Return only applications with aliases that exactly match this value. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of Applications | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AvailableNumberList ListAvailableNumbers (string? phoneNumber = null, string? region = null, string? country = null, bool? voiceEnabled = null, bool? smsEnabled = null, bool? capabilitiesVoice = null, bool? capabilitiesSms = null, bool? capabilitiesTollFree = null, bool? capabilitiesTenDLC = null, bool? capabilitiesShortCode = null)
List available numbers
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListAvailableNumbersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var phoneNumber = "phoneNumber_example"; // string? | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. (optional)
var region = "region_example"; // string? | State or province of this phone number. (optional)
var country = "country_example"; // string? | Country of this phone number. (optional)
var voiceEnabled = true; // bool? | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (optional) (default to true)
var smsEnabled = true; // bool? | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (optional) (default to true)
var capabilitiesVoice = true; // bool? | (optional)
var capabilitiesSms = true; // bool? | (optional)
var capabilitiesTollFree = true; // bool? | (optional)
var capabilitiesTenDLC = true; // bool? | (optional)
var capabilitiesShortCode = true; // bool? | (optional)
try
{
// List available numbers
AvailableNumberList result = apiInstance.ListAvailableNumbers(phoneNumber, region, country, voiceEnabled, smsEnabled, capabilitiesVoice, capabilitiesSms, capabilitiesTollFree, capabilitiesTenDLC, capabilitiesShortCode);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListAvailableNumbers: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List available numbers
ApiResponse<AvailableNumberList> response = apiInstance.ListAvailableNumbersWithHttpInfo(phoneNumber, region, country, voiceEnabled, smsEnabled, capabilitiesVoice, capabilitiesSms, capabilitiesTollFree, capabilitiesTenDLC, capabilitiesShortCode);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListAvailableNumbersWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| phoneNumber | string? | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. | [optional] |
| region | string? | State or province of this phone number. | [optional] |
| country | string? | Country of this phone number. | [optional] |
| voiceEnabled | bool? | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true] |
| smsEnabled | bool? | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true] |
| capabilitiesVoice | bool? | | [optional] |
| capabilitiesSms | bool? | | [optional] |
| capabilitiesTollFree | bool? | | [optional] |
| capabilitiesTenDLC | bool? | | [optional] |
| capabilitiesShortCode | bool? | | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Available Numbers List | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LogList ListCallLogs (string callId)
List Call Logs
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListCallLogsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var callId = "callId_example"; // string | String that uniquely identifies this call resource.
try
{
// List Call Logs
LogList result = apiInstance.ListCallLogs(callId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCallLogs: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Call Logs
ApiResponse<LogList> response = apiInstance.ListCallLogsWithHttpInfo(callId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCallLogsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| callId | string | String that uniquely identifies this call resource. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Logs for this call | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecordingList ListCallRecordings (string callId, string? dateCreated = null)
List Call Recordings
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListCallRecordingsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var callId = "callId_example"; // string | String that uniquely identifies this call resource.
var dateCreated = "dateCreated_example"; // string? | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. (optional)
try
{
// List Call Recordings
RecordingList result = apiInstance.ListCallRecordings(callId, dateCreated);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCallRecordings: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Call Recordings
ApiResponse<RecordingList> response = apiInstance.ListCallRecordingsWithHttpInfo(callId, dateCreated);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCallRecordingsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| callId | string | String that uniquely identifies this call resource. | |
| dateCreated | string? | Only show recordings created on the specified date, in the form YYYY-MM-DD. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of recordings for a call | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CallList ListCalls (bool? active = null, string? to = null, string? from = null, CallStatus? status = null, string? startTime = null, string? endTime = null, string? parentCallId = null, List? applicationId = null)
List Calls
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListCallsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var active = false; // bool? | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. (optional) (default to false)
var to = "to_example"; // string? | Only show Calls to this phone number. (optional)
var from = "from_example"; // string? | Only show Calls from this phone number. (optional)
var status = new CallStatus?(); // CallStatus? | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. (optional)
var startTime = "startTime_example"; // string? | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
var endTime = "endTime_example"; // string? | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. (optional)
var parentCallId = "parentCallId_example"; // string? | Only show Calls spawned by the call with this ID. (optional)
var applicationId = new List<string>?(); // List<string>? | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. (optional)
try
{
// List Calls
CallList result = apiInstance.ListCalls(active, to, from, status, startTime, endTime, parentCallId, applicationId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCalls: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Calls
ApiResponse<CallList> response = apiInstance.ListCallsWithHttpInfo(active, to, from, status, startTime, endTime, parentCallId, applicationId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListCallsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| active | bool? | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional] [default to false] |
| to | string? | Only show Calls to this phone number. | [optional] |
| from | string? | Only show Calls from this phone number. | [optional] |
| status | CallStatus? | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional] |
| startTime | string? | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
| endTime | string? | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] |
| parentCallId | string? | Only show Calls spawned by the call with this ID. | [optional] |
| applicationId | List<string>? | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful retrieved call list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecordingList ListConferenceRecordings (string conferenceId, string? callId = null, string? dateCreated = null)
List Conference Recordings
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListConferenceRecordingsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | Show only Recordings made during the conference with this ID.
var callId = "callId_example"; // string? | Show only Recordings made during the Call with this ID. (optional)
var dateCreated = "dateCreated_example"; // string? | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
try
{
// List Conference Recordings
RecordingList result = apiInstance.ListConferenceRecordings(conferenceId, callId, dateCreated);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListConferenceRecordings: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Conference Recordings
ApiResponse<RecordingList> response = apiInstance.ListConferenceRecordingsWithHttpInfo(conferenceId, callId, dateCreated);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListConferenceRecordingsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | Show only Recordings made during the conference with this ID. | |
| callId | string? | Show only Recordings made during the Call with this ID. | [optional] |
| dateCreated | string? | Only show Recordings created on this date, formatted as YYYY-MM-DD. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of Recordings | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceList ListConferences (string? status = null, string? alias = null, string? dateCreated = null, string? dateUpdated = null)
List Conferences
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListConferencesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var status = "status_example"; // string? | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. (optional)
var alias = "alias_example"; // string? | List Conferences whose alias exactly matches this string. (optional)
var dateCreated = "dateCreated_example"; // string? | Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. (optional)
var dateUpdated = "dateUpdated_example"; // string? | Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. (optional)
try
{
// List Conferences
ConferenceList result = apiInstance.ListConferences(status, alias, dateCreated, dateUpdated);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListConferences: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Conferences
ApiResponse<ConferenceList> response = apiInstance.ListConferencesWithHttpInfo(status, alias, dateCreated, dateUpdated);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListConferencesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| status | string? | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. | [optional] |
| alias | string? | List Conferences whose alias exactly matches this string. | [optional] |
| dateCreated | string? | Only show Conferences that were created on the specified date, in the form YYYY-MM-DD. | [optional] |
| dateUpdated | string? | Only show Conferences that were last updated on the specified date, in the form YYYY-MM-DD. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of Conferences | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IncomingNumberList ListIncomingNumbers (string? phoneNumber = null, string? alias = null, string? region = null, string? country = null, string? applicationId = null, bool? hasApplication = null, bool? voiceEnabled = null, bool? smsEnabled = null, bool? hasCampaign = null, bool? capabilitiesVoice = null, bool? capabilitiesSms = null, bool? capabilitiesTollFree = null, bool? capabilitiesTenDLC = null, bool? capabilitiesShortCode = null, string? tfnCampaignId = null, bool? offnet = null)
List Incoming Numbers
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListIncomingNumbersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var phoneNumber = "phoneNumber_example"; // string? | Only show incoming phone number resources that match this PCRE-compatible regular expression. (optional)
var alias = "alias_example"; // string? | Only show incoming phone numbers with aliases that exactly match this value. (optional)
var region = "region_example"; // string? | State or province of this phone number. (optional)
var country = "country_example"; // string? | Country of this phone number. (optional)
var applicationId = "applicationId_example"; // string? | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. (optional)
var hasApplication = false; // bool? | Indication of whether the phone number has an application linked to it. (optional) (default to false)
var voiceEnabled = true; // bool? | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (optional) (default to true)
var smsEnabled = true; // bool? | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (optional) (default to true)
var hasCampaign = true; // bool? | Indication of whether the phone number has a campaign associated with it (optional)
var capabilitiesVoice = true; // bool? | (optional)
var capabilitiesSms = true; // bool? | (optional)
var capabilitiesTollFree = true; // bool? | (optional)
var capabilitiesTenDLC = true; // bool? | (optional)
var capabilitiesShortCode = true; // bool? | (optional)
var tfnCampaignId = "tfnCampaignId_example"; // string? | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. (optional)
var offnet = true; // bool? | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. (optional)
try
{
// List Incoming Numbers
IncomingNumberList result = apiInstance.ListIncomingNumbers(phoneNumber, alias, region, country, applicationId, hasApplication, voiceEnabled, smsEnabled, hasCampaign, capabilitiesVoice, capabilitiesSms, capabilitiesTollFree, capabilitiesTenDLC, capabilitiesShortCode, tfnCampaignId, offnet);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListIncomingNumbers: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Incoming Numbers
ApiResponse<IncomingNumberList> response = apiInstance.ListIncomingNumbersWithHttpInfo(phoneNumber, alias, region, country, applicationId, hasApplication, voiceEnabled, smsEnabled, hasCampaign, capabilitiesVoice, capabilitiesSms, capabilitiesTollFree, capabilitiesTenDLC, capabilitiesShortCode, tfnCampaignId, offnet);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListIncomingNumbersWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| phoneNumber | string? | Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional] |
| alias | string? | Only show incoming phone numbers with aliases that exactly match this value. | [optional] |
| region | string? | State or province of this phone number. | [optional] |
| country | string? | Country of this phone number. | [optional] |
| applicationId | string? | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] |
| hasApplication | bool? | Indication of whether the phone number has an application linked to it. | [optional] [default to false] |
| voiceEnabled | bool? | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true] |
| smsEnabled | bool? | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true] |
| hasCampaign | bool? | Indication of whether the phone number has a campaign associated with it | [optional] |
| capabilitiesVoice | bool? | | [optional] |
| capabilitiesSms | bool? | | [optional] |
| capabilitiesTollFree | bool? | | [optional] |
| capabilitiesTenDLC | bool? | | [optional] |
| capabilitiesShortCode | bool? | | [optional] |
| tfnCampaignId | string? | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. | [optional] |
| offnet | bool? | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of Incoming Phone Numbers | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueMemberList ListMembers (string queueId)
List Members
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListMembersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | String that uniquely identifies the Queue that the Member belongs to.
try
{
// List Members
QueueMemberList result = apiInstance.ListMembers(queueId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListMembers: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Members
ApiResponse<QueueMemberList> response = apiInstance.ListMembersWithHttpInfo(queueId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListMembersWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | String that uniquely identifies the Queue that the Member belongs to. | |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved queue member list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceParticipantList ListParticipants (string conferenceId, bool? talk = null, bool? listen = null, bool? dtmfPassThrough = null)
List Participants
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListParticipantsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | ID of the conference this participant is in.
var talk = true; // bool? | Only show Participants with the talk privilege. (optional)
var listen = true; // bool? | Only show Participants with the listen privilege. (optional)
var dtmfPassThrough = true; // bool? | Only show Participants with the dtmfPassThrough privilege. (optional)
try
{
// List Participants
ConferenceParticipantList result = apiInstance.ListParticipants(conferenceId, talk, listen, dtmfPassThrough);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListParticipants: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Participants
ApiResponse<ConferenceParticipantList> response = apiInstance.ListParticipantsWithHttpInfo(conferenceId, talk, listen, dtmfPassThrough);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListParticipantsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | ID of the conference this participant is in. | |
| talk | bool? | Only show Participants with the talk privilege. | [optional] |
| listen | bool? | Only show Participants with the listen privilege. | [optional] |
| dtmfPassThrough | bool? | Only show Participants with the dtmfPassThrough privilege. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved conference participant list | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecordingList ListRecordings (string? callId = null, string? conferenceId = null, string? dateCreated = null)
List Recordings
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListRecordingsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var callId = "callId_example"; // string? | Show only Recordings made during the Call with this ID. (optional)
var conferenceId = "conferenceId_example"; // string? | Show only Recordings made during the conference with this ID. (optional)
var dateCreated = "dateCreated_example"; // string? | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
try
{
// List Recordings
RecordingList result = apiInstance.ListRecordings(callId, conferenceId, dateCreated);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListRecordings: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List Recordings
ApiResponse<RecordingList> response = apiInstance.ListRecordingsWithHttpInfo(callId, conferenceId, dateCreated);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListRecordingsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| callId | string? | Show only Recordings made during the Call with this ID. | [optional] |
| conferenceId | string? | Show only Recordings made during the conference with this ID. | [optional] |
| dateCreated | string? | Only show Recordings created on this date, formatted as YYYY-MM-DD. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of Recordings | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MessagesList ListSmsMessages (string? to = null, string? from = null, string? beginTime = null, string? endTime = null, MessageDirection? direction = null, string? campaignId = null, string? brandId = null, bool? is10DLC = null)
List SMS Messages
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class ListSmsMessagesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var to = "to_example"; // string? | Only show Messages to this phone number. (optional)
var from = "from_example"; // string? | Only show Messages from this phone number. (optional)
var beginTime = "beginTime_example"; // string? | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. (optional)
var endTime = "endTime_example"; // string? | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. (optional)
var direction = new MessageDirection?(); // MessageDirection? | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. (optional)
var campaignId = "campaignId_example"; // string? | Only show messages associated with this campaign ID. (optional)
var brandId = "brandId_example"; // string? | Only show messages associated with this brand ID (optional)
var is10DLC = true; // bool? | Only show messages that were sent as part of a 10DLC campaign. (optional)
try
{
// List SMS Messages
MessagesList result = apiInstance.ListSmsMessages(to, from, beginTime, endTime, direction, campaignId, brandId, is10DLC);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListSmsMessages: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// List SMS Messages
ApiResponse<MessagesList> response = apiInstance.ListSmsMessagesWithHttpInfo(to, from, beginTime, endTime, direction, campaignId, brandId, is10DLC);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ListSmsMessagesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| to | string? | Only show Messages to this phone number. | [optional] |
| from | string? | Only show Messages from this phone number. | [optional] |
| beginTime | string? | Only show Messages sent at or after this time (GMT), given as YYYY-MM-DD hh:mm:ss. | [optional] |
| endTime | string? | Only show messages sent at or before this time (GMT), given as YYYY-MM-DD hh:mm.. | [optional] |
| direction | MessageDirection? | Either `inbound` or `outbound`. Only show Messages that were either sent from or received by FreeClimb. | [optional] |
| campaignId | string? | Only show messages associated with this campaign ID. | [optional] |
| brandId | string? | Only show messages associated with this brand ID | [optional] |
| is10DLC | bool? | Only show messages that were sent as part of a 10DLC campaign. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | List of messages | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CallResult MakeACall (MakeCallRequest? makeCallRequest = null)
Make a Call
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class MakeACallExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var makeCallRequest = new MakeCallRequest?(); // MakeCallRequest? | Call details for making a call (optional)
try
{
// Make a Call
CallResult result = apiInstance.MakeACall(makeCallRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.MakeACall: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Make a Call
ApiResponse<CallResult> response = apiInstance.MakeACallWithHttpInfo(makeCallRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.MakeACallWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| makeCallRequest | MakeCallRequest? | Call details for making a call | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Call that was created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string MakeAWebrtcJwt (CreateWebRTCToken createWebRTCToken)
Make a JWT for WebRTC calling
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class MakeAWebrtcJwtExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var createWebRTCToken = new CreateWebRTCToken(); // CreateWebRTCToken | Information needed to craft a JWT compatible with the platforms WebRTC APIs
try
{
// Make a JWT for WebRTC calling
string result = apiInstance.MakeAWebrtcJwt(createWebRTCToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.MakeAWebrtcJwt: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Make a JWT for WebRTC calling
ApiResponse<string> response = apiInstance.MakeAWebrtcJwtWithHttpInfo(createWebRTCToken);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.MakeAWebrtcJwtWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| createWebRTCToken | CreateWebRTCToken | Information needed to craft a JWT compatible with the platforms WebRTC APIs | |
string
- Content-Type: application/json
- Accept: text/plain
| Status code | Description | Response headers |
|---|---|---|
| 200 | The created JWT | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void RemoveAParticipant (string conferenceId, string callId)
Remove a Participant
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class RemoveAParticipantExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | ID of the conference this participant is in.
var callId = "callId_example"; // string | ID of the Call associated with this participant.
try
{
// Remove a Participant
apiInstance.RemoveAParticipant(conferenceId, callId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.RemoveAParticipant: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Remove a Participant
apiInstance.RemoveAParticipantWithHttpInfo(conferenceId, callId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.RemoveAParticipantWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | ID of the conference this participant is in. | |
| callId | string | ID of the Call associated with this participant. | |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successfully deleted conference participant | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MessageResult SendAnSmsMessage (MessageRequest messageRequest)
Send an SMS Message
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class SendAnSmsMessageExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var messageRequest = new MessageRequest(); // MessageRequest | Details to create a message
try
{
// Send an SMS Message
MessageResult result = apiInstance.SendAnSmsMessage(messageRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.SendAnSmsMessage: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Send an SMS Message
ApiResponse<MessageResult> response = apiInstance.SendAnSmsMessageWithHttpInfo(messageRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.SendAnSmsMessageWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| messageRequest | MessageRequest | Details to create a message | |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 202 | The message has been accepted. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
System.IO.Stream StreamARecordingFile (string recordingId)
Stream a Recording File
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class StreamARecordingFileExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var recordingId = "recordingId_example"; // string | String that uniquely identifies this recording resource.
try
{
// Stream a Recording File
System.IO.Stream result = apiInstance.StreamARecordingFile(recordingId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.StreamARecordingFile: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Stream a Recording File
ApiResponse<System.IO.Stream> response = apiInstance.StreamARecordingFileWithHttpInfo(recordingId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.StreamARecordingFileWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| recordingId | string | String that uniquely identifies this recording resource. | |
System.IO.Stream
- Content-Type: Not defined
- Accept: audio/x-wav
| Status code | Description | Response headers |
|---|---|---|
| 200 | Streaming a Recording represented with audio/x-wav mime-type | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void UpdateAConference (string conferenceId, UpdateConferenceRequest? updateConferenceRequest = null)
Update a Conference
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAConferenceExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | String that uniquely identifies this conference resource.
var updateConferenceRequest = new UpdateConferenceRequest?(); // UpdateConferenceRequest? | Conference Details to update (optional)
try
{
// Update a Conference
apiInstance.UpdateAConference(conferenceId, updateConferenceRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAConference: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update a Conference
apiInstance.UpdateAConferenceWithHttpInfo(conferenceId, updateConferenceRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAConferenceWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | String that uniquely identifies this conference resource. | |
| updateConferenceRequest | UpdateConferenceRequest? | Conference Details to update | [optional] |
void (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful conference details update | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void UpdateALiveCall (string callId, UpdateCallRequest updateCallRequest)
Update a Live Call
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateALiveCallExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var callId = "callId_example"; // string | String that uniquely identifies this call resource.
var updateCallRequest = new UpdateCallRequest(); // UpdateCallRequest | Call details to update
try
{
// Update a Live Call
apiInstance.UpdateALiveCall(callId, updateCallRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateALiveCall: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update a Live Call
apiInstance.UpdateALiveCallWithHttpInfo(callId, updateCallRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateALiveCallWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| callId | string | String that uniquely identifies this call resource. | |
| updateCallRequest | UpdateCallRequest | Call details to update | |
void (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 202 | Successfully queued call | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConferenceParticipantResult UpdateAParticipant (string conferenceId, string callId, UpdateConferenceParticipantRequest? updateConferenceParticipantRequest = null)
Update a Participant
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAParticipantExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var conferenceId = "conferenceId_example"; // string | ID of the conference this participant is in.
var callId = "callId_example"; // string | ID of the Call associated with this participant.
var updateConferenceParticipantRequest = new UpdateConferenceParticipantRequest?(); // UpdateConferenceParticipantRequest? | Conference participant details to update (optional)
try
{
// Update a Participant
ConferenceParticipantResult result = apiInstance.UpdateAParticipant(conferenceId, callId, updateConferenceParticipantRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAParticipant: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update a Participant
ApiResponse<ConferenceParticipantResult> response = apiInstance.UpdateAParticipantWithHttpInfo(conferenceId, callId, updateConferenceParticipantRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAParticipantWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| conferenceId | string | ID of the conference this participant is in. | |
| callId | string | ID of the Call associated with this participant. | |
| updateConferenceParticipantRequest | UpdateConferenceParticipantRequest? | Conference participant details to update | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully retrieved conference participant | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResult UpdateAQueue (string queueId, QueueRequest? queueRequest = null)
Update a Queue
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAQueueExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var queueId = "queueId_example"; // string | A string that uniquely identifies this Queue resource.
var queueRequest = new QueueRequest?(); // QueueRequest? | Queue Details to update (optional)
try
{
// Update a Queue
QueueResult result = apiInstance.UpdateAQueue(queueId, queueRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAQueue: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update a Queue
ApiResponse<QueueResult> response = apiInstance.UpdateAQueueWithHttpInfo(queueId, queueRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAQueueWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| queueId | string | A string that uniquely identifies this Queue resource. | |
| queueRequest | QueueRequest? | Queue Details to update | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successfully updated queue | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void UpdateAnAccount (AccountRequest? accountRequest = null)
Manage an account
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAnAccountExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var accountRequest = new AccountRequest?(); // AccountRequest? | Account details to update (optional)
try
{
// Manage an account
apiInstance.UpdateAnAccount(accountRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnAccount: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Manage an account
apiInstance.UpdateAnAccountWithHttpInfo(accountRequest);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnAccountWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| accountRequest | AccountRequest? | Account details to update | [optional] |
void (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful Account update | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ApplicationResult UpdateAnApplication (string applicationId, ApplicationRequest? applicationRequest = null)
Update an application
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAnApplicationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var applicationId = "applicationId_example"; // string | A string that uniquely identifies this application resource.
var applicationRequest = new ApplicationRequest?(); // ApplicationRequest? | Application details to update. (optional)
try
{
// Update an application
ApplicationResult result = apiInstance.UpdateAnApplication(applicationId, applicationRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnApplication: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update an application
ApiResponse<ApplicationResult> response = apiInstance.UpdateAnApplicationWithHttpInfo(applicationId, applicationRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnApplicationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| applicationId | string | A string that uniquely identifies this application resource. | |
| applicationRequest | ApplicationRequest? | Application details to update. | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Update Application | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IncomingNumberResult UpdateAnIncomingNumber (string phoneNumberId, IncomingNumberRequest? incomingNumberRequest = null)
Update an Incoming Number
using System.Collections.Generic;
using System.Diagnostics;
using freeclimb.Api;
using freeclimb.Client;
using freeclimb.Model;
namespace Example
{
public class UpdateAnIncomingNumberExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://www.freeclimb.com/apiserver";
// Configure HTTP basic authorization: fc
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
var apiInstance = new DefaultApi(config);
var phoneNumberId = "phoneNumberId_example"; // string | String that uniquely identifies this phone number resource.
var incomingNumberRequest = new IncomingNumberRequest?(); // IncomingNumberRequest? | Incoming Number details to update (optional)
try
{
// Update an Incoming Number
IncomingNumberResult result = apiInstance.UpdateAnIncomingNumber(phoneNumberId, incomingNumberRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnIncomingNumber: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update an Incoming Number
ApiResponse<IncomingNumberResult> response = apiInstance.UpdateAnIncomingNumberWithHttpInfo(phoneNumberId, incomingNumberRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.UpdateAnIncomingNumberWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|
| phoneNumberId | string | String that uniquely identifies this phone number resource. | |
| incomingNumberRequest | IncomingNumberRequest? | Incoming Number details to update | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Updated Incoming Phone Number | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]