C# Class CallfireApiClient.Api.Numbers.NumbersApi

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

Public Methods

Method Description
FindNumberRegions ( FindNumberRegionsRequest request ) : Page

Find number region information. Use this API to obtain detailed region information that can then be used to query for more specific phone numbers than a general query.
FindNumbersLocal ( FindNumbersLocalRequest request ) : IList

Find number in local catalog by prefix, zipcode, etc...
FindNumbersTollfree ( CommonFindRequest request ) : IList

Find numbers in the CallFire tollfree numbers catalog that are available for purchase.

Private Methods

Method Description
NumbersApi ( RestApiClient client ) : System

Method Details

FindNumberRegions() public method

Find number region information. Use this API to obtain detailed region information that can then be used to query for more specific phone numbers than a general query.
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 FindNumberRegions ( FindNumberRegionsRequest request ) : Page
request CallfireApiClient.Api.Numbers.Model.Request.FindNumberRegionsRequest request object
return Page

FindNumbersLocal() public method

Find number in local catalog by prefix, zipcode, etc...
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 FindNumbersLocal ( FindNumbersLocalRequest request ) : IList
request CallfireApiClient.Api.Numbers.Model.Request.FindNumbersLocalRequest request object with different fields to filter
return IList

FindNumbersTollfree() public method

Find numbers in the CallFire tollfree numbers catalog that are available for purchase.
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 FindNumbersTollfree ( CommonFindRequest request ) : IList
request CommonFindRequest request object
return IList