voxbone v0.2.0 Voxbone.Api.CDRs
API calls for all endpoints tagged CDRs
.
Link to this section Summary
Functions
Downloads the requested cdrs archive file with the given name using Mtom
The listExistingFile method allows you to list all the files that are available for download. You should use that method to get the name of the file before you can use the downloadFile method which requires the file name as an input parameter
Sends a request to generate a report with all the cdrs for the given month and year. Note that it is only possible to request the generation of a report for a month set in the past
Sends a request to generate a report with all the cdrs for the given month and year. Note that it is only possible to request the generation of a report for a month set in the past
Link to this section Functions
download_file(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Downloads the requested cdrs archive file with the given name using Mtom.
Parameters
- connection (Voxbone.Connection): Connection to server
- file_name (String.t): This is one of the fileNames returned by the listExistingFiles method.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
list_existing_files(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.ListExistingFilesResponse.t()} | {:error, Tesla.Env.t()}
The listExistingFile method allows you to list all the files that are available for download. You should use that method to get the name of the file before you can use the downloadFile method which requires the file name as an input parameter.
Parameters
- connection (Voxbone.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListExistingFilesResponse{}} on success {:error, info} on failure
request_file_creation(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.RequestFileCreationResponse.t()} | {:error, Tesla.Env.t()}
Sends a request to generate a report with all the cdrs for the given month and year. Note that it is only possible to request the generation of a report for a month set in the past.
Parameters
- connection (Voxbone.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :body (RequestFileCreationRequest):
Returns
{:ok, %Voxbone.Model.RequestFileCreationResponse{}} on success {:error, info} on failure
request_file_creation_0(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, Voxbone.Model.RequestFileCreationResponse.t()} | {:error, Tesla.Env.t()}
Sends a request to generate a report with all the cdrs for the given month and year. Note that it is only possible to request the generation of a report for a month set in the past.
Parameters
- connection (Voxbone.Connection): Connection to server
- month (String.t): The desired month for the report generation.
- year (String.t): The desired year for the report generation.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.RequestFileCreationResponse{}} on success {:error, info} on failure