C# 클래스 CallfireApiClient.Api.Account.MeApi

파일 보기 프로젝트 열기: CallFire/callfire-api-client-csharp

공개 메소드들

메소드 설명
CreateApiCredentials ( ApiCredentials credentials ) : ApiCredentials

Create API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic Authentication. At this time, the user can only supply the name for the credentials. The generated credentials can be used to access any endpoint on the CallFire API. ApiCredentials.name property required
DeleteApiCredentials ( long id ) : void

Delete API credentials by id
FindApiCredentials ( CommonFindRequest request ) : Page

Find API credentials associated with current account
GetAccount ( ) : UserAccount

Find account details for the user. Details include name, email, and basic account permissions. GET /me/account
GetApiCredentials ( long id, string fields = null ) : ApiCredentials

Get API credentials by id
GetBillingPlanUsage ( ) : BillingPlanUsage

Get Plan usage statistics
GetCallerIds ( ) : IList

Returns a list of verified caller ids. If the number is not shown in the list, then it is not verified, and will have to send for a verification code.
GetCreditUsage ( DateIntervalRequest request = null ) : CreditsUsage

Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time.
SendVerificationCode ( String callerid ) : void

Send generated verification code to callerid number. The verification code is delivered via a phone call. After receiving verification code on phone call POST /callerids/{callerid}/verification-code to verify number.
VerifyCallerId ( CallerIdVerificationRequest request ) : bool?

Verify callerId by providing calling number and verificationCode received on phone.

비공개 메소드들

메소드 설명
MeApi ( RestApiClient client ) : System

메소드 상세

CreateApiCredentials() 공개 메소드

Create API credentials for the CallFire API. This endpoint requires full CallFire account credentials to be used, authenticated using Basic Authentication. At this time, the user can only supply the name for the credentials. The generated credentials can be used to access any endpoint on the CallFire API. ApiCredentials.name property required
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 CreateApiCredentials ( ApiCredentials credentials ) : ApiCredentials
credentials CallfireApiClient.Api.Account.Model.ApiCredentials API credentials to create
리턴 CallfireApiClient.Api.Account.Model.ApiCredentials

DeleteApiCredentials() 공개 메소드

Delete API credentials 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 DeleteApiCredentials ( long id ) : void
id long id of credentials
리턴 void

FindApiCredentials() 공개 메소드

Find API credentials associated with current account
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 FindApiCredentials ( CommonFindRequest request ) : Page
request CommonFindRequest request with properties to filter
리턴 Page

GetAccount() 공개 메소드

Find account details for the user. Details include name, email, and basic account permissions. GET /me/account
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 GetAccount ( ) : UserAccount
리턴 CallfireApiClient.Api.Account.Model.UserAccount

GetApiCredentials() 공개 메소드

Get API credentials 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 GetApiCredentials ( long id, string fields = null ) : ApiCredentials
id long id of credentials
fields string limit fields returned. Example fields=id,name
리턴 CallfireApiClient.Api.Account.Model.ApiCredentials

GetBillingPlanUsage() 공개 메소드

Get Plan usage statistics
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 GetBillingPlanUsage ( ) : BillingPlanUsage
리턴 CallfireApiClient.Api.Account.Model.BillingPlanUsage

GetCallerIds() 공개 메소드

Returns a list of verified caller ids. If the number is not shown in the list, then it is not verified, and will have to send for a verification code.
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 GetCallerIds ( ) : IList
리턴 IList

GetCreditUsage() 공개 메소드

Find credit usage for the user. Returns credits usage for time period specified or if unspecified then total for all time.
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 GetCreditUsage ( DateIntervalRequest request = null ) : CreditsUsage
request CallfireApiClient.Api.Account.Model.Request.DateIntervalRequest request for date range filtering
리턴 CallfireApiClient.Api.Account.Model.CreditsUsage

SendVerificationCode() 공개 메소드

Send generated verification code to callerid number. The verification code is delivered via a phone call. After receiving verification code on phone call POST /callerids/{callerid}/verification-code to verify number.
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 SendVerificationCode ( String callerid ) : void
callerid String callerid number
리턴 void

VerifyCallerId() 공개 메소드

Verify callerId by providing calling number and verificationCode received on phone.
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 VerifyCallerId ( CallerIdVerificationRequest request ) : bool?
request CallfireApiClient.Api.Account.Model.Request.CallerIdVerificationRequest request object
리턴 bool?