DefaultApi.md

# freeclimb.DefaultApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
[**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
[**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
[**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
[**create_blob**](DefaultApi.md#create_blob) | **POST** /Accounts/{accountId}/Blobs | Create a Blob
[**create_export**](DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export
[**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
[**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
[**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
[**delete_an_export**](DefaultApi.md#delete_an_export) | **DELETE** /Accounts/{accountId}/Exports/{exportId} | Delete an Export
[**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
[**delete_blob**](DefaultApi.md#delete_blob) | **DELETE** /Accounts/{accountId}/Blobs/{blobId} | Delete Blob
[**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
[**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
[**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
[**download_an_export**](DefaultApi.md#download_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId}/Download | Download an Export
[**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
[**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
[**get_a_conference**](DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
[**get_a_member**](DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member
[**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
[**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
[**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
[**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
[**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
[**get_an_export**](DefaultApi.md#get_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId} | Get an Export
[**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
[**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
[**get_blob**](DefaultApi.md#get_blob) | **GET** /Accounts/{accountId}/Blobs/{blobId} | Get Blob
[**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
[**get_ten_dlc_sms_brand**](DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand
[**get_ten_dlc_sms_brands**](DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands
[**get_ten_dlc_sms_campaign**](DefaultApi.md#get_ten_dlc_sms_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign
[**get_ten_dlc_sms_campaigns**](DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns
[**get_ten_dlc_sms_partner_campaign**](DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign
[**get_ten_dlc_sms_partner_campaigns**](DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns
[**get_toll_free_sms_campaign**](DefaultApi.md#get_toll_free_sms_campaign) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns/{campaignId} | Get a TollFree SMS Campaign
[**get_toll_free_sms_campaigns**](DefaultApi.md#get_toll_free_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/TollFree/Campaigns | Get list of TollFree Campaigns
[**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
[**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
[**list_applications**](DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications
[**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
[**list_blobs**](DefaultApi.md#list_blobs) | **GET** /Accounts/{accountId}/Blobs | List Blobs belonging to an account.
[**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
[**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
[**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
[**list_conference_recordings**](DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings
[**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
[**list_exports**](DefaultApi.md#list_exports) | **GET** /Accounts/{accountId}/Exports | List Exports
[**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
[**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
[**list_participants**](DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
[**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
[**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
[**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
[**make_a_webrtc_jwt**](DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling
[**modify_blob**](DefaultApi.md#modify_blob) | **PATCH** /Accounts/{accountId}/Blobs/{blobId} | Modify Blob
[**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
[**replace_blob**](DefaultApi.md#replace_blob) | **PUT** /Accounts/{accountId}/Blobs/{blobId} | Replace Blob
[**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
[**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
[**update_a_conference**](DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
[**update_a_live_call**](DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call
[**update_a_participant**](DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant
[**update_a_queue**](DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue
[**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
[**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
[**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number


# **buy_a_phone_number**
> IncomingNumberResult buy_a_phone_number(account_id, buy_incoming_number_request)

Buy a Phone Number

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.buy_incoming_number_request import BuyIncomingNumberRequest
from freeclimb.models.incoming_number_result import IncomingNumberResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    buy_incoming_number_request = freeclimb.BuyIncomingNumberRequest() # BuyIncomingNumberRequest | Incoming Number transaction details

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



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | 

### Return type

[**IncomingNumberResult**](IncomingNumberResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Incoming Number transaction |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_a_conference**
> ConferenceResult create_a_conference(account_id, create_conference_request=create_conference_request)

Create a Conference

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_result import ConferenceResult
from freeclimb.models.create_conference_request import CreateConferenceRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    create_conference_request = freeclimb.CreateConferenceRequest() # CreateConferenceRequest | Conference to create (optional)

    try:
        # Create a Conference
        api_response = api_instance.create_a_conference(account_id, create_conference_request=create_conference_request)
        print("The response of DefaultApi->create_a_conference:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_a_conference: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **create_conference_request** | [**CreateConferenceRequest**](CreateConferenceRequest.md)| Conference to create | [optional] 

### Return type

[**ConferenceResult**](ConferenceResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Details of created conference |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_a_queue**
> QueueResult create_a_queue(account_id, queue_request=queue_request)

Create a Queue

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_request import QueueRequest
from freeclimb.models.queue_result import QueueResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_request = freeclimb.QueueRequest() # QueueRequest | Queue details used to create a queue (optional)

    try:
        # Create a Queue
        api_response = api_instance.create_a_queue(account_id, queue_request=queue_request)
        print("The response of DefaultApi->create_a_queue:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_a_queue: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue details used to create a queue | [optional] 

### Return type

[**QueueResult**](QueueResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successfuly created queue |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_an_application**
> ApplicationResult create_an_application(account_id, application_request=application_request)

Create an application

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.application_request import ApplicationRequest
from freeclimb.models.application_result import ApplicationResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    application_request = freeclimb.ApplicationRequest() # ApplicationRequest | Application Details (optional)

    try:
        # Create an application
        api_response = api_instance.create_an_application(account_id, application_request=application_request)
        print("The response of DefaultApi->create_an_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_an_application: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application Details | [optional] 

### Return type

[**ApplicationResult**](ApplicationResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Application successfuly created |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_blob**
> BlobResult create_blob(account_id, create_blob_request)

Create a Blob

Create a new Blob belonging to the requesting account.

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_result import BlobResult
from freeclimb.models.create_blob_request import CreateBlobRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    create_blob_request = {"blob":{}} # CreateBlobRequest | An object defining a new blob. A request body must be provided but the blob may be empty.

    try:
        # Create a Blob
        api_response = api_instance.create_blob(account_id, create_blob_request)
        print("The response of DefaultApi->create_blob:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_blob: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **create_blob_request** | [**CreateBlobRequest**](CreateBlobRequest.md)| An object defining a new blob. A request body must be provided but the blob may be empty. | 

### Return type

[**BlobResult**](BlobResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful creation of a new blob. |  -  |
**400** | Generic platform bad request. |  -  |
**409** | A blob with the provided alias already exists oln the requesting account and so this new blob is rejected as there cannot be duplicate alises. |  -  |
**413** | The blob exceeded one of the size limits. Either it itself is too large or it would push the total sum of all blobs over the account's limit. |  -  |
**422** | Generic platform unprocessible entity response. |  -  |
**500** | Generic platform internal error. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_export**
> ExportResult create_export(account_id, export_request=export_request)

Create an Export

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.export_request import ExportRequest
from freeclimb.models.export_result import ExportResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    export_request = freeclimb.ExportRequest() # ExportRequest | A JSON object containing export creation parameters (optional)

    try:
        # Create an Export
        api_response = api_instance.create_export(account_id, export_request=export_request)
        print("The response of DefaultApi->create_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_export: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **export_request** | [**ExportRequest**](ExportRequest.md)| A JSON object containing export creation parameters | [optional] 

### Return type

[**ExportResult**](ExportResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Export successfully created |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_knowledge_base_completion**
> CompletionResult create_knowledge_base_completion(account_id, knowledge_base_id, completion_request=completion_request)

Query the knowledge base

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.completion_request import CompletionRequest
from freeclimb.models.completion_result import CompletionResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    knowledge_base_id = 'knowledge_base_id_example' # str | A string that uniquely identifies the KnowledgeBase resource.
    completion_request = freeclimb.CompletionRequest() # CompletionRequest | Completion request details (optional)

    try:
        # Query the knowledge base
        api_response = api_instance.create_knowledge_base_completion(account_id, knowledge_base_id, completion_request=completion_request)
        print("The response of DefaultApi->create_knowledge_base_completion:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_knowledge_base_completion: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **knowledge_base_id** | **str**| A string that uniquely identifies the KnowledgeBase resource. | 
 **completion_request** | [**CompletionRequest**](CompletionRequest.md)| Completion request details | [optional] 

### Return type

[**CompletionResult**](CompletionResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | KnowledgeaBase completion response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_a_recording**
> delete_a_recording(account_id, recording_id)

Delete a Recording

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    recording_id = 'recording_id_example' # str | String that uniquely identifies this recording resource.

    try:
        # Delete a Recording
        api_instance.delete_a_recording(account_id, recording_id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_a_recording: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **recording_id** | **str**| String that uniquely identifies this recording resource. | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Recording Deleted |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_an_application**
> delete_an_application(account_id, application_id)

Delete an application

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    application_id = 'application_id_example' # str | String that uniquely identifies this application resource.

    try:
        # Delete an application
        api_instance.delete_an_application(account_id, application_id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_an_application: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **application_id** | **str**| String that uniquely identifies this application resource. | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful application deletion |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_an_export**
> delete_an_export(account_id, export_id)

Delete an Export

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    export_id = 'export_id_example' # str | A string that uniquely identifies this export resource.

    try:
        # Delete an Export
        api_instance.delete_an_export(account_id, export_id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_an_export: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **export_id** | **str**| A string that uniquely identifies this export resource. | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Export deletion |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_an_incoming_number**
> delete_an_incoming_number(account_id, phone_number_id)

Delete an Incoming Number

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    phone_number_id = 'phone_number_id_example' # str | String that uniquely identifies this phone number resource.

    try:
        # Delete an Incoming Number
        api_instance.delete_an_incoming_number(account_id, phone_number_id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_an_incoming_number: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **phone_number_id** | **str**| String that uniquely identifies this phone number resource. | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Incoming Number deletion. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_blob**
> BlobResult delete_blob(account_id, blob_id)

Delete Blob

Deletes a blob or specific keys from a blob. If no keys are specified in the request body, the entire blob is deleted (returns 204). If specific keys are provided, only those keys are removed and the remaining blob is returned (returns 200).

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_result import BlobResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    blob_id = 'blob_id_example' # str | String that uniquely identifies this Blob resource.

    try:
        # Delete Blob
        api_response = api_instance.delete_blob(account_id, blob_id)
        print("The response of DefaultApi->delete_blob:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_blob: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **blob_id** | **str**| String that uniquely identifies this Blob resource. | 

### Return type

[**BlobResult**](BlobResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Blob keys deleted successfully, remaining blob returned. |  -  |
**204** | Successful operation |  -  |
**404** | Generic platform not found error. |  -  |
**422** | Generic platform unprocessible entity response. |  -  |
**500** | Generic platform internal error. |  -  |
**504** | gateway timeout error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **dequeue_a_member**
> QueueMember dequeue_a_member(account_id, queue_id, call_id)

Dequeue a Member

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_member import QueueMember
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | String that uniquely identifies the Queue that the Member belongs to.
    call_id = 'call_id_example' # str | ID if the Call that the Member belongs to

    try:
        # Dequeue a Member
        api_response = api_instance.dequeue_a_member(account_id, queue_id, call_id)
        print("The response of DefaultApi->dequeue_a_member:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->dequeue_a_member: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| String that uniquely identifies the Queue that the Member belongs to. | 
 **call_id** | **str**| ID if the Call that the Member belongs to | 

### Return type

[**QueueMember**](QueueMember.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Accepted dequeue request |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **dequeue_head_member**
> QueueMember dequeue_head_member(account_id, queue_id)

Dequeue Head Member

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_member import QueueMember
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | String that uniquely identifies this queue resource.

    try:
        # Dequeue Head Member
        api_response = api_instance.dequeue_head_member(account_id, queue_id)
        print("The response of DefaultApi->dequeue_head_member:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->dequeue_head_member: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| String that uniquely identifies this queue resource. | 

### Return type

[**QueueMember**](QueueMember.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Accepted dequeue request |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **download_a_recording_file**
> bytearray download_a_recording_file(account_id, recording_id)

Download a Recording File

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    recording_id = 'recording_id_example' # str | String that uniquely identifies this recording resource.

    try:
        # Download a Recording File
        api_response = api_instance.download_a_recording_file(account_id, recording_id)
        print("The response of DefaultApi->download_a_recording_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->download_a_recording_file: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **recording_id** | **str**| String that uniquely identifies this recording resource. | 

### Return type

**bytearray**

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: audio/wav

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Download a Recording file represented with audio/wav mime-type |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **download_an_export**
> str download_an_export(account_id, export_id)

Download an Export

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    export_id = 'export_id_example' # str | A string that uniquely identifies this export resource.

    try:
        # Download an Export
        api_response = api_instance.download_an_export(account_id, export_id)
        print("The response of DefaultApi->download_an_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->download_an_export: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **export_id** | **str**| A string that uniquely identifies this export resource. | 

### Return type

**str**

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/csv

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Export Details |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **filter_logs**
> LogList filter_logs(account_id, filter_logs_request)

Filter Logs

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.filter_logs_request import FilterLogsRequest
from freeclimb.models.log_list import LogList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    filter_logs_request = freeclimb.FilterLogsRequest() # FilterLogsRequest | Filter logs request paramters

    try:
        # Filter Logs
        api_response = api_instance.filter_logs(account_id, filter_logs_request)
        print("The response of DefaultApi->filter_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->filter_logs: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | 

### Return type

[**LogList**](LogList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved log list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_call**
> CallResult get_a_call(account_id, call_id)

Get a Call

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.call_result import CallResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    call_id = 'call_id_example' # str | String that uniquely identifies this call resource.

    try:
        # Get a Call
        api_response = api_instance.get_a_call(account_id, call_id)
        print("The response of DefaultApi->get_a_call:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_call: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **call_id** | **str**| String that uniquely identifies this call resource. | 

### Return type

[**CallResult**](CallResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Call Resource |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_conference**
> ConferenceResult get_a_conference(account_id, conference_id)

Get a Conference

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_result import ConferenceResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | A string that uniquely identifies this conference resource.

    try:
        # Get a Conference
        api_response = api_instance.get_a_conference(account_id, conference_id)
        print("The response of DefaultApi->get_a_conference:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_conference: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| A string that uniquely identifies this conference resource. | 

### Return type

[**ConferenceResult**](ConferenceResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved conference |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_member**
> QueueMember get_a_member(account_id, queue_id, call_id)

Get a Member

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_member import QueueMember
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | String that uniquely identifies the Queue that the Member belongs to.
    call_id = 'call_id_example' # str | ID of the Call that the Member belongs to

    try:
        # Get a Member
        api_response = api_instance.get_a_member(account_id, queue_id, call_id)
        print("The response of DefaultApi->get_a_member:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_member: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| String that uniquely identifies the Queue that the Member belongs to. | 
 **call_id** | **str**| ID of the Call that the Member belongs to | 

### Return type

[**QueueMember**](QueueMember.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved a queue member |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_participant**
> ConferenceParticipantResult get_a_participant(account_id, conference_id, call_id)

Get a Participant

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_participant_result import ConferenceParticipantResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | ID of the conference this participant is in.
    call_id = 'call_id_example' # str | ID of the Call associated with this participant.

    try:
        # Get a Participant
        api_response = api_instance.get_a_participant(account_id, conference_id, call_id)
        print("The response of DefaultApi->get_a_participant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_participant: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| ID of the conference this participant is in. | 
 **call_id** | **str**| ID of the Call associated with this participant. | 

### Return type

[**ConferenceParticipantResult**](ConferenceParticipantResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved conference participant |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_queue**
> QueueResult get_a_queue(account_id, queue_id)

Get a Queue

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_result import QueueResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | A string that uniquely identifies this queue resource.

    try:
        # Get a Queue
        api_response = api_instance.get_a_queue(account_id, queue_id)
        print("The response of DefaultApi->get_a_queue:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_queue: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| A string that uniquely identifies this queue resource. | 

### Return type

[**QueueResult**](QueueResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved queue |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_a_recording**
> RecordingResult get_a_recording(account_id, recording_id)

Get a Recording

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.recording_result import RecordingResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    recording_id = 'recording_id_example' # str | String that uniquely identifies this recording resource.

    try:
        # Get a Recording
        api_response = api_instance.get_a_recording(account_id, recording_id)
        print("The response of DefaultApi->get_a_recording:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_a_recording: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **recording_id** | **str**| String that uniquely identifies this recording resource. | 

### Return type

[**RecordingResult**](RecordingResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** |  |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_an_account**
> AccountResult get_an_account(account_id)

Get an Account

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.account_result import AccountResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account

    try:
        # Get an Account
        api_response = api_instance.get_an_account(account_id)
        print("The response of DefaultApi->get_an_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_an_account: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 

### Return type

[**AccountResult**](AccountResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Account Details |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_an_application**
> ApplicationResult get_an_application(account_id, application_id)

Get an Application

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.application_result import ApplicationResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    application_id = 'application_id_example' # str | A string that uniquely identifies this application resource.

    try:
        # Get an Application
        api_response = api_instance.get_an_application(account_id, application_id)
        print("The response of DefaultApi->get_an_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_an_application: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **application_id** | **str**| A string that uniquely identifies this application resource. | 

### Return type

[**ApplicationResult**](ApplicationResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Application Details |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_an_export**
> ExportResult get_an_export(account_id, export_id)

Get an Export

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.export_result import ExportResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    export_id = 'export_id_example' # str | A string that uniquely identifies this export resource.

    try:
        # Get an Export
        api_response = api_instance.get_an_export(account_id, export_id)
        print("The response of DefaultApi->get_an_export:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_an_export: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **export_id** | **str**| A string that uniquely identifies this export resource. | 

### Return type

[**ExportResult**](ExportResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Export Details |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_an_incoming_number**
> IncomingNumberResult get_an_incoming_number(account_id, phone_number_id)

Get an Incoming Number

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.incoming_number_result import IncomingNumberResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    phone_number_id = 'phone_number_id_example' # str | String that uniquely identifies this phone number resource.

    try:
        # Get an Incoming Number
        api_response = api_instance.get_an_incoming_number(account_id, phone_number_id)
        print("The response of DefaultApi->get_an_incoming_number:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_an_incoming_number: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **phone_number_id** | **str**| String that uniquely identifies this phone number resource. | 

### Return type

[**IncomingNumberResult**](IncomingNumberResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Incoming Phone Number result. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_an_sms_message**
> MessageResult get_an_sms_message(account_id, message_id)

Get an SMS Message

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.message_result import MessageResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    message_id = 'message_id_example' # str | String that uniquely identifies this Message resource.

    try:
        # Get an SMS Message
        api_response = api_instance.get_an_sms_message(account_id, message_id)
        print("The response of DefaultApi->get_an_sms_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_an_sms_message: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **message_id** | **str**| String that uniquely identifies this Message resource. | 

### Return type

[**MessageResult**](MessageResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The specific SMS message that’s been processed by FreeClimb |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_blob**
> BlobResult get_blob(account_id, blob_id)

Get Blob

Retrieves a specified blob

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_result import BlobResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    blob_id = 'blob_id_example' # str | String that uniquely identifies this Blob resource.

    try:
        # Get Blob
        api_response = api_instance.get_blob(account_id, blob_id)
        print("The response of DefaultApi->get_blob:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_blob: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **blob_id** | **str**| String that uniquely identifies this Blob resource. | 

### Return type

[**BlobResult**](BlobResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Retrieve a Blob. |  -  |
**404** | Generic platform not found error. |  -  |
**500** | Generic platform internal error. |  -  |
**504** | gateway timeout error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_head_member**
> QueueMember get_head_member(account_id, queue_id)

Get Head Member

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_member import QueueMember
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | String that uniquely identifies the Queue that the Member belongs to.

    try:
        # Get Head Member
        api_response = api_instance.get_head_member(account_id, queue_id)
        print("The response of DefaultApi->get_head_member:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_head_member: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| String that uniquely identifies the Queue that the Member belongs to. | 

### Return type

[**QueueMember**](QueueMember.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved queue member |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_brand**
> SMSTenDLCBrand get_ten_dlc_sms_brand(account_id, brand_id)

Get a 10DLC SMS Brand

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_brand import SMSTenDLCBrand
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    brand_id = 'brand_id_example' # str | String that uniquely identifies this brand resource.

    try:
        # Get a 10DLC SMS Brand
        api_response = api_instance.get_ten_dlc_sms_brand(account_id, brand_id)
        print("The response of DefaultApi->get_ten_dlc_sms_brand:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_brand: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **brand_id** | **str**| String that uniquely identifies this brand resource. | 

### Return type

[**SMSTenDLCBrand**](SMSTenDLCBrand.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The specific SMS 10DLC Brand that’s been processed by FreeClimb |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_brands**
> SMSTenDLCBrandsListResult get_ten_dlc_sms_brands(account_id)

Get list of SMS 10DLC Brands

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_brands_list_result import SMSTenDLCBrandsListResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account

    try:
        # Get list of SMS 10DLC Brands
        api_response = api_instance.get_ten_dlc_sms_brands(account_id)
        print("The response of DefaultApi->get_ten_dlc_sms_brands:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_brands: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 

### Return type

[**SMSTenDLCBrandsListResult**](SMSTenDLCBrandsListResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The list SMS 10DLC brands |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_campaign**
> SMSTenDLCCampaign get_ten_dlc_sms_campaign(account_id, campaign_id)

Get a 10DLC SMS Campaign

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_campaign import SMSTenDLCCampaign
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    campaign_id = 'campaign_id_example' # str | String that uniquely identifies this campaign resource.

    try:
        # Get a 10DLC SMS Campaign
        api_response = api_instance.get_ten_dlc_sms_campaign(account_id, campaign_id)
        print("The response of DefaultApi->get_ten_dlc_sms_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_campaign: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **campaign_id** | **str**| String that uniquely identifies this campaign resource. | 

### Return type

[**SMSTenDLCCampaign**](SMSTenDLCCampaign.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The specific SMS 10DLC Campaign that’s been processed by FreeClimb |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_campaigns**
> SMSTenDLCCampaignsListResult get_ten_dlc_sms_campaigns(account_id, brand_id=brand_id)

Get list of SMS 10DLC Campaigns

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_campaigns_list_result import SMSTenDLCCampaignsListResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    brand_id = 'brand_id_example' # str | The unique identifier for a brand (optional)

    try:
        # Get list of SMS 10DLC Campaigns
        api_response = api_instance.get_ten_dlc_sms_campaigns(account_id, brand_id=brand_id)
        print("The response of DefaultApi->get_ten_dlc_sms_campaigns:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_campaigns: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **brand_id** | **str**| The unique identifier for a brand | [optional] 

### Return type

[**SMSTenDLCCampaignsListResult**](SMSTenDLCCampaignsListResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The list SMS 10DLC campaigns |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_partner_campaign**
> SMSTenDLCPartnerCampaign get_ten_dlc_sms_partner_campaign(account_id, campaign_id)

Get a 10DLC SMS Partner Campaign

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_partner_campaign import SMSTenDLCPartnerCampaign
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    campaign_id = 'campaign_id_example' # str | String that uniquely identifies this campaign resource.

    try:
        # Get a 10DLC SMS Partner Campaign
        api_response = api_instance.get_ten_dlc_sms_partner_campaign(account_id, campaign_id)
        print("The response of DefaultApi->get_ten_dlc_sms_partner_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_partner_campaign: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **campaign_id** | **str**| String that uniquely identifies this campaign resource. | 

### Return type

[**SMSTenDLCPartnerCampaign**](SMSTenDLCPartnerCampaign.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_ten_dlc_sms_partner_campaigns**
> SMSTenDLCPartnerCampaignsListResult get_ten_dlc_sms_partner_campaigns(account_id, brand_id=brand_id)

Get list of SMS 10DLC Partner Campaigns

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_ten_dlc_partner_campaigns_list_result import SMSTenDLCPartnerCampaignsListResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    brand_id = 'brand_id_example' # str | The unique identifier for a brand (optional)

    try:
        # Get list of SMS 10DLC Partner Campaigns
        api_response = api_instance.get_ten_dlc_sms_partner_campaigns(account_id, brand_id=brand_id)
        print("The response of DefaultApi->get_ten_dlc_sms_partner_campaigns:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_ten_dlc_sms_partner_campaigns: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **brand_id** | **str**| The unique identifier for a brand | [optional] 

### Return type

[**SMSTenDLCPartnerCampaignsListResult**](SMSTenDLCPartnerCampaignsListResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The list SMS 10DLC partner campaigns |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_toll_free_sms_campaign**
> SMSTollFreeCampaign get_toll_free_sms_campaign(account_id, campaign_id)

Get a TollFree SMS Campaign

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_toll_free_campaign import SMSTollFreeCampaign
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    campaign_id = 'campaign_id_example' # str | String that uniquely identifies this TollFree Campaign resource.

    try:
        # Get a TollFree SMS Campaign
        api_response = api_instance.get_toll_free_sms_campaign(account_id, campaign_id)
        print("The response of DefaultApi->get_toll_free_sms_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_toll_free_sms_campaign: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **campaign_id** | **str**| String that uniquely identifies this TollFree Campaign resource. | 

### Return type

[**SMSTollFreeCampaign**](SMSTollFreeCampaign.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The specific SMS TollFree Campaign that’s been processed by FreeClimb |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_toll_free_sms_campaigns**
> SMSTollFreeCampaignsListResult get_toll_free_sms_campaigns(account_id)

Get list of TollFree Campaigns

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.sms_toll_free_campaigns_list_result import SMSTollFreeCampaignsListResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account

    try:
        # Get list of TollFree Campaigns
        api_response = api_instance.get_toll_free_sms_campaigns(account_id)
        print("The response of DefaultApi->get_toll_free_sms_campaigns:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_toll_free_sms_campaigns: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 

### Return type

[**SMSTollFreeCampaignsListResult**](SMSTollFreeCampaignsListResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The list toll-free campaigns |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_active_queues**
> QueueList list_active_queues(account_id, alias=alias)

List Active Queues

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_list import QueueList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    alias = 'alias_example' # str | Return only the Queue resources with aliases that exactly match this name. (optional)

    try:
        # List Active Queues
        api_response = api_instance.list_active_queues(account_id, alias=alias)
        print("The response of DefaultApi->list_active_queues:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_active_queues: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **alias** | **str**| Return only the Queue resources with aliases that exactly match this name. | [optional] 

### Return type

[**QueueList**](QueueList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfuly retrieved queue list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_all_account_logs**
> LogList list_all_account_logs(account_id)

List All Account Logs

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.log_list import LogList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account

    try:
        # List All Account Logs
        api_response = api_instance.list_all_account_logs(account_id)
        print("The response of DefaultApi->list_all_account_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_all_account_logs: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 

### Return type

[**LogList**](LogList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved log list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_applications**
> ApplicationList list_applications(account_id, alias=alias)

List applications

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.application_list import ApplicationList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    alias = 'alias_example' # str | Return only applications with aliases that exactly match this value. (optional)

    try:
        # List applications
        api_response = api_instance.list_applications(account_id, alias=alias)
        print("The response of DefaultApi->list_applications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_applications: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **alias** | **str**| Return only applications with aliases that exactly match this value. | [optional] 

### Return type

[**ApplicationList**](ApplicationList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of Applications |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_available_numbers**
> AvailableNumberList list_available_numbers(phone_number=phone_number, region=region, country=country, voice_enabled=voice_enabled, sms_enabled=sms_enabled, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code)

List available numbers

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.available_number_list import AvailableNumberList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    phone_number = 'phone_number_example' # str | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. (optional)
    region = 'region_example' # str | State or province of this phone number. (optional)
    country = 'country_example' # str | Country of this phone number. (optional)
    voice_enabled = True # bool | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (optional) (default to True)
    sms_enabled = 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)
    capabilities_voice = True # bool |  (optional)
    capabilities_sms = True # bool |  (optional)
    capabilities_toll_free = True # bool |  (optional)
    capabilities_ten_dlc = True # bool |  (optional)
    capabilities_short_code = True # bool |  (optional)

    try:
        # List available numbers
        api_response = api_instance.list_available_numbers(phone_number=phone_number, region=region, country=country, voice_enabled=voice_enabled, sms_enabled=sms_enabled, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code)
        print("The response of DefaultApi->list_available_numbers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_available_numbers: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **phone_number** | **str**| PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. | [optional] 
 **region** | **str**| State or province of this phone number. | [optional] 
 **country** | **str**| Country of this phone number. | [optional] 
 **voice_enabled** | **bool**| Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to True]
 **sms_enabled** | **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]
 **capabilities_voice** | **bool**|  | [optional] 
 **capabilities_sms** | **bool**|  | [optional] 
 **capabilities_toll_free** | **bool**|  | [optional] 
 **capabilities_ten_dlc** | **bool**|  | [optional] 
 **capabilities_short_code** | **bool**|  | [optional] 

### Return type

[**AvailableNumberList**](AvailableNumberList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Available Numbers List |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_blobs**
> BlobListResponse list_blobs(account_id)

List Blobs belonging to an account.

List Blobs belonging to an account. Results are returned in paginated lists mirroring other listing features in the API.

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_list_response import BlobListResponse
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account

    try:
        # List Blobs belonging to an account.
        api_response = api_instance.list_blobs(account_id)
        print("The response of DefaultApi->list_blobs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_blobs: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 

### Return type

[**BlobListResponse**](BlobListResponse.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Single page of blob list results. |  -  |
**400** | Generic platform bad request. |  -  |
**500** | Generic platform internal error. |  -  |
**504** | gateway timeout error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_call_logs**
> LogList list_call_logs(account_id, call_id)

List Call Logs

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.log_list import LogList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    call_id = 'call_id_example' # str | String that uniquely identifies this call resource.

    try:
        # List Call Logs
        api_response = api_instance.list_call_logs(account_id, call_id)
        print("The response of DefaultApi->list_call_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_call_logs: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **call_id** | **str**| String that uniquely identifies this call resource. | 

### Return type

[**LogList**](LogList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Logs for this call |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_call_recordings**
> RecordingList list_call_recordings(account_id, call_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Call Recordings

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.recording_list import RecordingList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    call_id = 'call_id_example' # str | String that uniquely identifies this call resource.
    date_created = 'date_created_example' # str | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. (optional)
    start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
    end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

    try:
        # List Call Recordings
        api_response = api_instance.list_call_recordings(account_id, call_id, date_created=date_created, start_time=start_time, end_time=end_time)
        print("The response of DefaultApi->list_call_recordings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_call_recordings: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **call_id** | **str**| String that uniquely identifies this call resource. | 
 **date_created** | **str**| Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional] 
 **start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 
 **end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 

### Return type

[**RecordingList**](RecordingList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of recordings for a call |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_calls**
> CallList list_calls(account_id, used_audio_stream=used_audio_stream, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max, web_rtc=web_rtc)

List Calls

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.call_list import CallList
from freeclimb.models.call_status import CallStatus
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    used_audio_stream = False # bool | If usedAudioStream is set to true then all calls that have a audioStreamDuration > 0 will be returned  (optional) (default to False)
    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)
    to = 'to_example' # str | Only show Calls to this phone number. (optional)
    var_from = 'var_from_example' # str | Only show Calls from this phone number. (optional)
    status = freeclimb.CallStatus() # CallStatus | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. (optional)
    start_time = 'start_time_example' # str | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
    end_time = 'end_time_example' # str | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. (optional)
    parent_call_id = 'parent_call_id_example' # str | Only show Calls spawned by the call with this ID. (optional)
    application_id = ['application_id_example'] # List[str] | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. (optional)
    risk_score_min = 56 # int | The minimum riskScore that should be included in the list. (optional)
    risk_score_max = 56 # int | The maximum riskScore that should be included in the list. (optional)
    web_rtc = False # bool | Only show Calls that were originated via WebRTC. (optional) (default to False)

    try:
        # List Calls
        api_response = api_instance.list_calls(account_id, used_audio_stream=used_audio_stream, active=active, to=to, var_from=var_from, status=status, start_time=start_time, end_time=end_time, parent_call_id=parent_call_id, application_id=application_id, risk_score_min=risk_score_min, risk_score_max=risk_score_max, web_rtc=web_rtc)
        print("The response of DefaultApi->list_calls:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_calls: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **used_audio_stream** | **bool**| If usedAudioStream is set to true then all calls that have a audioStreamDuration > 0 will be returned  | [optional] [default to False]
 **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** | **str**| Only show Calls to this phone number. | [optional] 
 **var_from** | **str**| Only show Calls from this phone number. | [optional] 
 **status** | [**CallStatus**](.md)| Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional] 
 **start_time** | **str**| Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 
 **end_time** | **str**| Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] 
 **parent_call_id** | **str**| Only show Calls spawned by the call with this ID. | [optional] 
 **application_id** | [**List[str]**](str.md)| Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional] 
 **risk_score_min** | **int**| The minimum riskScore that should be included in the list. | [optional] 
 **risk_score_max** | **int**| The maximum riskScore that should be included in the list. | [optional] 
 **web_rtc** | **bool**| Only show Calls that were originated via WebRTC. | [optional] [default to False]

### Return type

[**CallList**](CallList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful retrieved call list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_conference_recordings**
> RecordingList list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Conference Recordings

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.recording_list import RecordingList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | Show only Recordings made during the conference with this ID.
    call_id = 'call_id_example' # str | Show only Recordings made during the Call with this ID. (optional)
    date_created = 'date_created_example' # str | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
    start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
    end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

    try:
        # List Conference Recordings
        api_response = api_instance.list_conference_recordings(account_id, conference_id, call_id=call_id, date_created=date_created, start_time=start_time, end_time=end_time)
        print("The response of DefaultApi->list_conference_recordings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_conference_recordings: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| Show only Recordings made during the conference with this ID. | 
 **call_id** | **str**| Show only Recordings made during the Call with this ID. | [optional] 
 **date_created** | **str**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] 
 **start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 
 **end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 

### Return type

[**RecordingList**](RecordingList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of Recordings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_conferences**
> ConferenceList list_conferences(account_id, status=status, alias=alias, date_created=date_created, date_updated=date_updated)

List Conferences

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_list import ConferenceList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    status = 'status_example' # str | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. (optional)
    alias = 'alias_example' # str | List Conferences whose alias exactly matches this string. (optional)
    date_created = 'date_created_example' # str | Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. (optional)
    date_updated = 'date_updated_example' # str | Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. (optional)

    try:
        # List Conferences
        api_response = api_instance.list_conferences(account_id, status=status, alias=alias, date_created=date_created, date_updated=date_updated)
        print("The response of DefaultApi->list_conferences:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_conferences: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **status** | **str**| Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. | [optional] 
 **alias** | **str**| List Conferences whose alias exactly matches this string. | [optional] 
 **date_created** | **str**| Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. | [optional] 
 **date_updated** | **str**| Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. | [optional] 

### Return type

[**ConferenceList**](ConferenceList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of Conferences |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_exports**
> ExportList list_exports(account_id, status=status, cursor=cursor)

List Exports

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.export_list import ExportList
from freeclimb.models.export_status import ExportStatus
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    status = freeclimb.ExportStatus() # ExportStatus | Status of export (optional)
    cursor = 'cursor_example' # str | Used to reference pages of a list of exports (optional)

    try:
        # List Exports
        api_response = api_instance.list_exports(account_id, status=status, cursor=cursor)
        print("The response of DefaultApi->list_exports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_exports: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **status** | [**ExportStatus**](.md)| Status of export | [optional] 
 **cursor** | **str**| Used to reference pages of a list of exports | [optional] 

### Return type

[**ExportList**](ExportList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful retrieved export list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_incoming_numbers**
> IncomingNumberList list_incoming_numbers(account_id, phone_number=phone_number, alias=alias, region=region, country=country, application_id=application_id, has_application=has_application, has_campaign=has_campaign, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code, tfn_campaign_id=tfn_campaign_id, offnet=offnet)

List Incoming Numbers

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.incoming_number_list import IncomingNumberList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    phone_number = 'phone_number_example' # str | Only show incoming phone number resources that match this PCRE-compatible regular expression. (optional)
    alias = 'alias_example' # str | Only show incoming phone numbers with aliases that exactly match this value. (optional)
    region = 'region_example' # str | State or province of this phone number. (optional)
    country = 'country_example' # str | Country of this phone number. (optional)
    application_id = 'application_id_example' # str | 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)
    has_application = False # bool | Indication of whether the phone number has an application linked to it. (optional) (default to False)
    has_campaign = True # bool | Indication of whether the phone number has a campaign associated with it (optional)
    capabilities_voice = True # bool |  (optional)
    capabilities_sms = True # bool |  (optional)
    capabilities_toll_free = True # bool |  (optional)
    capabilities_ten_dlc = True # bool |  (optional)
    capabilities_short_code = True # bool |  (optional)
    tfn_campaign_id = 'tfn_campaign_id_example' # str | Only show incoming phone number resources that have been assigned to the provided TFNCampaign ID. (optional)
    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
        api_response = api_instance.list_incoming_numbers(account_id, phone_number=phone_number, alias=alias, region=region, country=country, application_id=application_id, has_application=has_application, has_campaign=has_campaign, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code, tfn_campaign_id=tfn_campaign_id, offnet=offnet)
        print("The response of DefaultApi->list_incoming_numbers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_incoming_numbers: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **phone_number** | **str**| Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional] 
 **alias** | **str**| Only show incoming phone numbers with aliases that exactly match this value. | [optional] 
 **region** | **str**| State or province of this phone number. | [optional] 
 **country** | **str**| Country of this phone number. | [optional] 
 **application_id** | **str**| 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] 
 **has_application** | **bool**| Indication of whether the phone number has an application linked to it. | [optional] [default to False]
 **has_campaign** | **bool**| Indication of whether the phone number has a campaign associated with it | [optional] 
 **capabilities_voice** | **bool**|  | [optional] 
 **capabilities_sms** | **bool**|  | [optional] 
 **capabilities_toll_free** | **bool**|  | [optional] 
 **capabilities_ten_dlc** | **bool**|  | [optional] 
 **capabilities_short_code** | **bool**|  | [optional] 
 **tfn_campaign_id** | **str**| 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] 

### Return type

[**IncomingNumberList**](IncomingNumberList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of Incoming Phone Numbers |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_members**
> QueueMemberList list_members(account_id, queue_id)

List Members

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_member_list import QueueMemberList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | String that uniquely identifies the Queue that the Member belongs to.

    try:
        # List Members
        api_response = api_instance.list_members(account_id, queue_id)
        print("The response of DefaultApi->list_members:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_members: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| String that uniquely identifies the Queue that the Member belongs to. | 

### Return type

[**QueueMemberList**](QueueMemberList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved queue member list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_participants**
> ConferenceParticipantList list_participants(account_id, conference_id, talk=talk, listen=listen, dtmf_pass_through=dtmf_pass_through)

List Participants

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_participant_list import ConferenceParticipantList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | ID of the conference this participant is in.
    talk = True # bool | Only show Participants with the talk privilege. (optional)
    listen = True # bool | Only show Participants with the listen privilege. (optional)
    dtmf_pass_through = True # bool | Only show Participants with the dtmfPassThrough privilege. (optional)

    try:
        # List Participants
        api_response = api_instance.list_participants(account_id, conference_id, talk=talk, listen=listen, dtmf_pass_through=dtmf_pass_through)
        print("The response of DefaultApi->list_participants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_participants: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| 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] 
 **dtmf_pass_through** | **bool**| Only show Participants with the dtmfPassThrough privilege. | [optional] 

### Return type

[**ConferenceParticipantList**](ConferenceParticipantList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved conference participant list |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_recordings**
> RecordingList list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created, start_time=start_time, end_time=end_time)

List Recordings

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.recording_list import RecordingList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    call_id = 'call_id_example' # str | Show only Recordings made during the Call with this ID. (optional)
    conference_id = 'conference_id_example' # str | Show only Recordings made during the conference with this ID. (optional)
    date_created = 'date_created_example' # str | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. (optional)
    start_time = 'start_time_example' # str | Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. (optional)
    end_time = 'end_time_example' # str | Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. (optional)

    try:
        # List Recordings
        api_response = api_instance.list_recordings(account_id, call_id=call_id, conference_id=conference_id, date_created=date_created, start_time=start_time, end_time=end_time)
        print("The response of DefaultApi->list_recordings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_recordings: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **call_id** | **str**| Show only Recordings made during the Call with this ID. | [optional] 
 **conference_id** | **str**| Show only Recordings made during the conference with this ID. | [optional] 
 **date_created** | **str**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] 
 **start_time** | **str**| Only show Recordings created at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 
 **end_time** | **str**| Only show Recordings created at or before this time, given as YYYY-MM-DD hh:mm:ss. | [optional] 

### Return type

[**RecordingList**](RecordingList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of Recordings |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_sms_messages**
> MessagesList list_sms_messages(account_id, to=to, var_from=var_from, begin_time=begin_time, end_time=end_time, direction=direction, campaign_id=campaign_id, brand_id=brand_id, is10_dlc=is10_dlc)

List SMS Messages

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.message_direction import MessageDirection
from freeclimb.models.messages_list import MessagesList
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    to = 'to_example' # str | Only show Messages to this phone number. (optional)
    var_from = 'var_from_example' # str | Only show Messages from this phone number. (optional)
    begin_time = 'begin_time_example' # str | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. (optional)
    end_time = 'end_time_example' # str | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. (optional)
    direction = freeclimb.MessageDirection() # MessageDirection | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. (optional)
    campaign_id = 'campaign_id_example' # str | Only show messages associated with this campaign ID. (optional)
    brand_id = 'brand_id_example' # str | Only show messages associated with this brand ID (optional)
    is10_dlc = True # bool | Only show messages that were sent as part of a 10DLC campaign. (optional)

    try:
        # List SMS Messages
        api_response = api_instance.list_sms_messages(account_id, to=to, var_from=var_from, begin_time=begin_time, end_time=end_time, direction=direction, campaign_id=campaign_id, brand_id=brand_id, is10_dlc=is10_dlc)
        print("The response of DefaultApi->list_sms_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_sms_messages: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **to** | **str**| Only show Messages to this phone number. | [optional] 
 **var_from** | **str**| Only show Messages from this phone number. | [optional] 
 **begin_time** | **str**| Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. | [optional] 
 **end_time** | **str**| Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional] 
 **direction** | [**MessageDirection**](.md)| Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional] 
 **campaign_id** | **str**| Only show messages associated with this campaign ID. | [optional] 
 **brand_id** | **str**| Only show messages associated with this brand ID | [optional] 
 **is10_dlc** | **bool**| Only show messages that were sent as part of a 10DLC campaign. | [optional] 

### Return type

[**MessagesList**](MessagesList.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of messages |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **make_a_call**
> CallResult make_a_call(account_id, make_call_request=make_call_request)

Make a Call

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.call_result import CallResult
from freeclimb.models.make_call_request import MakeCallRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    make_call_request = freeclimb.MakeCallRequest() # MakeCallRequest | Call details for making a call (optional)

    try:
        # Make a Call
        api_response = api_instance.make_a_call(account_id, make_call_request=make_call_request)
        print("The response of DefaultApi->make_a_call:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->make_a_call: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **make_call_request** | [**MakeCallRequest**](MakeCallRequest.md)| Call details for making a call | [optional] 

### Return type

[**CallResult**](CallResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Call that was created |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **make_a_webrtc_jwt**
> str make_a_webrtc_jwt(account_id, create_web_rtc_token)

Make a JWT for WebRTC calling

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.create_web_rtc_token import CreateWebRTCToken
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    create_web_rtc_token = freeclimb.CreateWebRTCToken() # CreateWebRTCToken | Information needed to craft a JWT compatible with the platforms WebRTC APIs

    try:
        # Make a JWT for WebRTC calling
        api_response = api_instance.make_a_webrtc_jwt(account_id, create_web_rtc_token)
        print("The response of DefaultApi->make_a_webrtc_jwt:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->make_a_webrtc_jwt: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **create_web_rtc_token** | [**CreateWebRTCToken**](CreateWebRTCToken.md)| Information needed to craft a JWT compatible with the platforms WebRTC APIs | 

### Return type

**str**

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: text/plain

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The created JWT |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **modify_blob**
> BlobResult modify_blob(account_id, blob_id, modify_blob_request)

Modify Blob

Modifys a pre existing blob by either adding new fields, or modifying existing fields

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_result import BlobResult
from freeclimb.models.modify_blob_request import ModifyBlobRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    blob_id = 'blob_id_example' # str | String that uniquely identifies this Blob resource.
    modify_blob_request = {"alias":"new_conversation_id","blob":{"field0":"value0_redux","field4":"value4"}} # ModifyBlobRequest | Request body to specify keys to modify. Or new keys to add onto the already existing blob

    try:
        # Modify Blob
        api_response = api_instance.modify_blob(account_id, blob_id, modify_blob_request)
        print("The response of DefaultApi->modify_blob:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->modify_blob: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **blob_id** | **str**| String that uniquely identifies this Blob resource. | 
 **modify_blob_request** | [**ModifyBlobRequest**](ModifyBlobRequest.md)| Request body to specify keys to modify. Or new keys to add onto the already existing blob | 

### Return type

[**BlobResult**](BlobResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Blob keys successfully modified, updated blob returned. |  -  |
**404** | Generic platform not found error. |  -  |
**409** | Generic platform status conflict error. |  -  |
**413** | Generic platform status request entity too large. |  -  |
**500** | Generic platform internal error. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **remove_a_participant**
> remove_a_participant(account_id, conference_id, call_id)

Remove a Participant

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | ID of the conference this participant is in.
    call_id = 'call_id_example' # str | ID of the Call associated with this participant.

    try:
        # Remove a Participant
        api_instance.remove_a_participant(account_id, conference_id, call_id)
    except Exception as e:
        print("Exception when calling DefaultApi->remove_a_participant: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| ID of the conference this participant is in. | 
 **call_id** | **str**| ID of the Call associated with this participant. | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successfully deleted conference participant |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **replace_blob**
> BlobResult replace_blob(account_id, blob_id, replace_blob_request)

Replace Blob

Replaces the blob content with the provided values.

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.blob_result import BlobResult
from freeclimb.models.replace_blob_request import ReplaceBlobRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    blob_id = 'blob_id_example' # str | String that uniquely identifies this Blob resource.
    replace_blob_request = {"blob":{"field0":"value0_redux","field4":"value4"}} # ReplaceBlobRequest | JSON object containing blob key the contents of which will be used to override the enitre blob contents.

    try:
        # Replace Blob
        api_response = api_instance.replace_blob(account_id, blob_id, replace_blob_request)
        print("The response of DefaultApi->replace_blob:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_blob: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **blob_id** | **str**| String that uniquely identifies this Blob resource. | 
 **replace_blob_request** | [**ReplaceBlobRequest**](ReplaceBlobRequest.md)| JSON object containing blob key the contents of which will be used to override the enitre blob contents. | 

### Return type

[**BlobResult**](BlobResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Replaces all keys in blob with those provided. |  -  |
**404** | Generic platform not found error. |  -  |
**409** | Generic platform status conflict error. |  -  |
**413** | Generic platform status request entity too large. |  -  |
**500** | Generic platform internal error. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **send_an_sms_message**
> MessageResult send_an_sms_message(account_id, message_request)

Send an SMS Message

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.message_request import MessageRequest
from freeclimb.models.message_result import MessageResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    message_request = freeclimb.MessageRequest() # MessageRequest | Details to create a message

    try:
        # Send an SMS Message
        api_response = api_instance.send_an_sms_message(account_id, message_request)
        print("The response of DefaultApi->send_an_sms_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_an_sms_message: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | 

### Return type

[**MessageResult**](MessageResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | The message has been accepted. |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **stream_a_recording_file**
> bytearray stream_a_recording_file(account_id, recording_id)

Stream a Recording File

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    recording_id = 'recording_id_example' # str | String that uniquely identifies this recording resource.

    try:
        # Stream a Recording File
        api_response = api_instance.stream_a_recording_file(account_id, recording_id)
        print("The response of DefaultApi->stream_a_recording_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->stream_a_recording_file: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **recording_id** | **str**| String that uniquely identifies this recording resource. | 

### Return type

**bytearray**

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: audio/wav

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Streaming a Recording represented with audio/wav mime-type |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_a_conference**
> update_a_conference(account_id, conference_id, update_conference_request=update_conference_request)

Update a Conference

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.update_conference_request import UpdateConferenceRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | String that uniquely identifies this conference resource.
    update_conference_request = freeclimb.UpdateConferenceRequest() # UpdateConferenceRequest | Conference Details to update (optional)

    try:
        # Update a Conference
        api_instance.update_a_conference(account_id, conference_id, update_conference_request=update_conference_request)
    except Exception as e:
        print("Exception when calling DefaultApi->update_a_conference: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| String that uniquely identifies this conference resource. | 
 **update_conference_request** | [**UpdateConferenceRequest**](UpdateConferenceRequest.md)| Conference Details to update | [optional] 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful conference details update |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_a_live_call**
> update_a_live_call(account_id, call_id, update_call_request)

Update a Live Call

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.update_call_request import UpdateCallRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    call_id = 'call_id_example' # str | String that uniquely identifies this call resource.
    update_call_request = freeclimb.UpdateCallRequest() # UpdateCallRequest | Call details to update

    try:
        # Update a Live Call
        api_instance.update_a_live_call(account_id, call_id, update_call_request)
    except Exception as e:
        print("Exception when calling DefaultApi->update_a_live_call: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **call_id** | **str**| String that uniquely identifies this call resource. | 
 **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Successfully queued call |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_a_participant**
> ConferenceParticipantResult update_a_participant(account_id, conference_id, call_id, update_conference_participant_request=update_conference_participant_request)

Update a Participant

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.conference_participant_result import ConferenceParticipantResult
from freeclimb.models.update_conference_participant_request import UpdateConferenceParticipantRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    conference_id = 'conference_id_example' # str | ID of the conference this participant is in.
    call_id = 'call_id_example' # str | ID of the Call associated with this participant.
    update_conference_participant_request = freeclimb.UpdateConferenceParticipantRequest() # UpdateConferenceParticipantRequest | Conference participant details to update (optional)

    try:
        # Update a Participant
        api_response = api_instance.update_a_participant(account_id, conference_id, call_id, update_conference_participant_request=update_conference_participant_request)
        print("The response of DefaultApi->update_a_participant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_a_participant: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **conference_id** | **str**| ID of the conference this participant is in. | 
 **call_id** | **str**| ID of the Call associated with this participant. | 
 **update_conference_participant_request** | [**UpdateConferenceParticipantRequest**](UpdateConferenceParticipantRequest.md)| Conference participant details to update | [optional] 

### Return type

[**ConferenceParticipantResult**](ConferenceParticipantResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully retrieved conference participant |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_a_queue**
> QueueResult update_a_queue(account_id, queue_id, queue_request=queue_request)

Update a Queue

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.queue_request import QueueRequest
from freeclimb.models.queue_result import QueueResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    queue_id = 'queue_id_example' # str | A string that uniquely identifies this Queue resource.
    queue_request = freeclimb.QueueRequest() # QueueRequest | Queue Details to update (optional)

    try:
        # Update a Queue
        api_response = api_instance.update_a_queue(account_id, queue_id, queue_request=queue_request)
        print("The response of DefaultApi->update_a_queue:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_a_queue: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **queue_id** | **str**| A string that uniquely identifies this Queue resource. | 
 **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue Details to update | [optional] 

### Return type

[**QueueResult**](QueueResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successfully updated queue |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_an_account**
> update_an_account(account_id, account_request=account_request)

Manage an account

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.account_request import AccountRequest
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    account_request = freeclimb.AccountRequest() # AccountRequest | Account details to update (optional)

    try:
        # Manage an account
        api_instance.update_an_account(account_id, account_request=account_request)
    except Exception as e:
        print("Exception when calling DefaultApi->update_an_account: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **account_request** | [**AccountRequest**](AccountRequest.md)| Account details to update | [optional] 

### Return type

void (empty response body)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Account update |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_an_application**
> ApplicationResult update_an_application(account_id, application_id, application_request=application_request)

Update an application

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.application_request import ApplicationRequest
from freeclimb.models.application_result import ApplicationResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    application_id = 'application_id_example' # str | A string that uniquely identifies this application resource.
    application_request = freeclimb.ApplicationRequest() # ApplicationRequest | Application details to update. (optional)

    try:
        # Update an application
        api_response = api_instance.update_an_application(account_id, application_id, application_request=application_request)
        print("The response of DefaultApi->update_an_application:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_an_application: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **application_id** | **str**| A string that uniquely identifies this application resource. | 
 **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application details to update. | [optional] 

### Return type

[**ApplicationResult**](ApplicationResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Update Application |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_an_incoming_number**
> IncomingNumberResult update_an_incoming_number(account_id, phone_number_id, incoming_number_request=incoming_number_request)

Update an Incoming Number

### Example

* Basic Authentication (fc):

```python
import freeclimb
from freeclimb.models.incoming_number_request import IncomingNumberRequest
from freeclimb.models.incoming_number_result import IncomingNumberResult
from freeclimb.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.freeclimb.com/apiserver
# See configuration.py for a list of all supported configuration parameters.
configuration = freeclimb.Configuration(
    host = "https://www.freeclimb.com/apiserver"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

# Enter a context with an instance of the API client
with freeclimb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = freeclimb.DefaultApi(api_client)
    account_id = 'AC170e4c66d358aa1755931da0452561933d1b8fd5' # str | ID of the account
    phone_number_id = 'phone_number_id_example' # str | String that uniquely identifies this phone number resource.
    incoming_number_request = freeclimb.IncomingNumberRequest() # IncomingNumberRequest | Incoming Number details to update (optional)

    try:
        # Update an Incoming Number
        api_response = api_instance.update_an_incoming_number(account_id, phone_number_id, incoming_number_request=incoming_number_request)
        print("The response of DefaultApi->update_an_incoming_number:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_an_incoming_number: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **account_id** | **str**| ID of the account | 
 **phone_number_id** | **str**| String that uniquely identifies this phone number resource. | 
 **incoming_number_request** | [**IncomingNumberRequest**](IncomingNumberRequest.md)| Incoming Number details to update | [optional] 

### Return type

[**IncomingNumberResult**](IncomingNumberResult.md)

### Authorization

[fc](../README.md#fc)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Updated Incoming Phone Number |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)