C# Class CallfireApiClient.Api.CallsTexts.CallsApi

Show file Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
Find ( FindCallsRequest request ) : Page

Finds all calls sent or received by the user, filtered by different properties, broadcast id, toNumber, fromNumber, label, state, etc.Use "campaignId=0" parameter to query for all calls sent through the POST /calls API {@link CallsApi#send(List)}.
Get ( long id, string fields = null ) : Call

Get call by id
GetCallRecording ( long id, string fields = null ) : CallRecording

Returns call recording by id
GetCallRecordingByName ( long callId, string recordingName, string fields = null ) : CallRecording

Returns call recording by name
GetCallRecordingMp3 ( long id ) : Stream

Download call mp3 recording by id
GetCallRecordingMp3ByName ( long callId, string recordingName ) : Stream

Download call mp3 recording by name
GetCallRecordings ( long id, string fields = null ) : IList

Returns call recordings for a call
Send ( IList recipients, long campaignId = null, string fields = null ) : IList

Send calls to recipients through default campaign. Use the API to quickly send individual calls. A verified Caller ID and sufficient credits are required to make a call.
Send ( SendCallsRequest request ) : IList

Send calls to recipients through default campaign. Use the API to quickly send individual calls. A verified Caller ID and sufficient credits are required to make a call.

Private Methods

Method Description
CallsApi ( RestApiClient client ) : System.Collections.Generic

Method Details

Find() public method

Finds all calls sent or received by the user, filtered by different properties, broadcast id, toNumber, fromNumber, label, state, etc.Use "campaignId=0" parameter to query for all calls sent through the POST /calls API {@link CallsApi#send(List)}.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Find ( FindCallsRequest request ) : Page
request CallfireApiClient.Api.CallsTexts.Model.Request.FindCallsRequest request object with different fields to filter
return Page

Get() public method

Get call by id
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Get ( long id, string fields = null ) : Call
id long id of call
fields string limit fields returned. Example fields=id,name
return Call

GetCallRecording() public method

Returns call recording by id
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public GetCallRecording ( long id, string fields = null ) : CallRecording
id long id of call recording
fields string limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Campaigns.Model.CallRecording

GetCallRecordingByName() public method

Returns call recording by name
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public GetCallRecordingByName ( long callId, string recordingName, string fields = null ) : CallRecording
callId long id of call
recordingName string name of call recording
fields string limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Campaigns.Model.CallRecording

GetCallRecordingMp3() public method

Download call mp3 recording by id
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public GetCallRecordingMp3 ( long id ) : Stream
id long id of call
return System.IO.Stream

GetCallRecordingMp3ByName() public method

Download call mp3 recording by name
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public GetCallRecordingMp3ByName ( long callId, string recordingName ) : Stream
callId long id of call
recordingName string name of call recording
return System.IO.Stream

GetCallRecordings() public method

Returns call recordings for a call
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public GetCallRecordings ( long id, string fields = null ) : IList
id long id of call
fields string Limit text fields returned. Example fields=limit,offset,items(id,message)
return IList

Send() public method

Send calls to recipients through default campaign. Use the API to quickly send individual calls. A verified Caller ID and sufficient credits are required to make a call.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Send ( IList recipients, long campaignId = null, string fields = null ) : IList
recipients IList call recipients
campaignId long specify a campaignId to send calls quickly on a previously created campaign
fields string limit fields returned. Example fields=id,name
return IList

Send() public method

Send calls to recipients through default campaign. Use the API to quickly send individual calls. A verified Caller ID and sufficient credits are required to make a call.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Send ( SendCallsRequest request ) : IList
request CallfireApiClient.Api.Common.Model.Request.SendCallsRequest request object with different fields to filter
return IList