C# Класс CallfireApiClient.Api.CallsTexts.TextsApi

Показать файл Открыть проект

Открытые методы

Метод Описание
Find ( FindTextsRequest request ) : Page

Finds all texts sent or received by the user. Use "campaignId=0" parameter to query for all texts sent through the POST /texts API. If no limit is given then the last 100 texts will be returned.
Get ( long id, string fields = null ) : Text

Get text by id
Send ( List recipients, long campaignId = null, string fields = null ) : IList

Send texts to recipients through existing campaign, if null default campaign will be used Use the /texts API to quickly send individual texts.A verified Caller ID and sufficient credits are required to make a call.
Send ( SendTextsRequest request ) : IList

Send texts to recipients through existing campaign, if null default campaign will be used Use the /texts API to quickly send individual texts.A verified Caller ID and sufficient credits are required to make a call.

Приватные методы

Метод Описание
TextsApi ( RestApiClient client ) : System.Collections.Generic

Описание методов

Find() публичный Метод

Finds all texts sent or received by the user. Use "campaignId=0" parameter to query for all texts sent through the POST /texts API. If no limit is given then the last 100 texts will be returned.
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 ( FindTextsRequest request ) : Page
request CallfireApiClient.Api.CallsTexts.Model.Request.FindTextsRequest request object with different fields to filter
Результат Page

Get() публичный Метод

Get text 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 ) : Text
id long id of text
fields string limit fields returned. Example fields=id,name
Результат Text

Send() публичный Метод

Send texts to recipients through existing campaign, if null default campaign will be used Use the /texts API to quickly send individual texts.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 ( List recipients, long campaignId = null, string fields = null ) : IList
recipients List 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
Результат IList

Send() публичный Метод

Send texts to recipients through existing campaign, if null default campaign will be used Use the /texts API to quickly send individual texts.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 ( SendTextsRequest request ) : IList
request CallfireApiClient.Api.Common.Model.Request.SendTextsRequest request object with different fields to filter
Результат IList