C# Class CallfireApiClient.Api.Campaigns.TextBroadcastsApi

Datei anzeigen Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
AddBatch ( AddBatchRequest request ) : ResourceId

Add batch to text broadcast. The add batch API allows the user to add additional batches to an already created text broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. Because of this, use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers.
AddRecipients ( long id, IList recipients, String fields = null ) : IList

Use this API to add recipients to an already created text broadcast. Post a list of Recipient objects for them to be immediately added to the text broadcast campaign. These contacts do not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers.
Archive ( long id ) : void

Archives text broadcast
Create ( TextBroadcast broadcast, bool start = false ) : ResourceId

Create a text broadcast campaign using the Text Broadcast API. A campaign can be created with no contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign. If start set to true campaign starts immediately
Find ( FindBroadcastsRequest request ) : Page

Find all text broadcasts created by the user. Can query on label, name, and the current running status of the campaign.
Get ( long id, string fields = null ) : TextBroadcast

Get text broadcast by id
GetBatches ( GetByIdRequest request ) : Page

Get text broadcast batches. Retrieve batches associated with text campaign
GetStats ( long id, string fields = null, System.DateTime begin = null, System.DateTime end = null ) : TextBroadcastStats

Get statistics on text broadcast
GetTexts ( GetBroadcastCallsTextsRequest request ) : Page

Get texts associated with text broadcast ordered by date
Start ( long id ) : void

Starts text broadcast
Stop ( long id ) : void

Stops text broadcast
Update ( TextBroadcast broadcast ) : void

Update broadcast

Private Methods

Method Description
GetTexts ( GetByIdRequest request ) : Page
TextBroadcastsApi ( RestApiClient client ) : System

Method Details

AddBatch() public method

Add batch to text broadcast. The add batch API allows the user to add additional batches to an already created text broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. Because of this, use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers.
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 AddBatch ( AddBatchRequest request ) : ResourceId
request CallfireApiClient.Api.Campaigns.Model.Request.AddBatchRequest request with contacts
return CallfireApiClient.Api.Common.Model.ResourceId

AddRecipients() public method

Use this API to add recipients to an already created text broadcast. Post a list of Recipient objects for them to be immediately added to the text broadcast campaign. These contacts do not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers.
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 AddRecipients ( long id, IList recipients, String fields = null ) : IList
id long id of text broadcast
recipients IList recipients to add
fields String limit fields returned. E.g. fields=id,name or fields=items(id,name)
return IList

Archive() public method

Archives text broadcast
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 Archive ( long id ) : void
id long id of broadcast
return void

Create() public method

Create a text broadcast campaign using the Text Broadcast API. A campaign can be created with no contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign. If start set to true campaign starts immediately
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 Create ( TextBroadcast broadcast, bool start = false ) : ResourceId
broadcast CallfireApiClient.Api.Campaigns.Model.TextBroadcast text broadcast to create
start bool if set to true then broadcast will start immediately, by default it set to false
return CallfireApiClient.Api.Common.Model.ResourceId

Find() public method

Find all text broadcasts created by the user. Can query on label, name, and the current running status of the campaign.
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 ( FindBroadcastsRequest request ) : Page
request CallfireApiClient.Api.Campaigns.Model.Request.FindBroadcastsRequest request object with filtering options
return Page

Get() public method

Get text broadcast 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 ) : TextBroadcast
id long id of broadcast
fields string limit fields returned. Example fields=id,message
return CallfireApiClient.Api.Campaigns.Model.TextBroadcast

GetBatches() public method

Get text broadcast batches. Retrieve batches associated with text campaign
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 GetBatches ( GetByIdRequest request ) : Page
request GetByIdRequest get request
return Page

GetStats() public method

Get statistics on text broadcast
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 GetStats ( long id, string fields = null, System.DateTime begin = null, System.DateTime end = null ) : TextBroadcastStats
id long id of text broadcast
fields string limit fields returned. E.g. fields=id,name or fields=items(id,name)
begin System.DateTime begin date to filter
end System.DateTime end date to filter
return CallfireApiClient.Api.Campaigns.Model.TextBroadcastStats

GetTexts() public method

Get texts associated with text broadcast ordered by date
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 GetTexts ( GetBroadcastCallsTextsRequest request ) : Page
request CallfireApiClient.Api.Common.Model.Request.GetBroadcastCallsTextsRequest request with properties to filter
return Page

Start() public method

Starts text broadcast
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 Start ( long id ) : void
id long id of broadcast
return void

Stop() public method

Stops text broadcast
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 Stop ( long id ) : void
id long id of broadcast
return void

Update() public method

Update broadcast
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 Update ( TextBroadcast broadcast ) : void
broadcast CallfireApiClient.Api.Campaigns.Model.TextBroadcast broadcast to update
return void