Package com.bandwidth.sdk.api

Class TollFreeVerificationApi

java.lang.Object

com.bandwidth.sdk.api.TollFreeVerificationApi

public class TollFreeVerificationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TollFreeVerificationApi()
TollFreeVerificationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
WebhookSubscription	createWebhookSubscription(String accountId, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)	Create Webhook Subscription Create a new webhook subscription (this webhook will be called for every update on every submission).
okhttp3.Call	createWebhookSubscriptionAsync(String accountId, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema, ApiCallback<WebhookSubscription> _callback)	Create Webhook Subscription (asynchronously) Create a new webhook subscription (this webhook will be called for every update on every submission).
okhttp3.Call	createWebhookSubscriptionCall(String accountId, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema, ApiCallback _callback)	Build call for createWebhookSubscription
ApiResponse<WebhookSubscription>	createWebhookSubscriptionWithHttpInfo(String accountId, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)	Create Webhook Subscription Create a new webhook subscription (this webhook will be called for every update on every submission).
void	deleteWebhookSubscription(String accountId, String id)	Delete Webhook Subscription Delete a webhook subscription by ID.
okhttp3.Call	deleteWebhookSubscriptionAsync(String accountId, String id, ApiCallback<Void> _callback)	Delete Webhook Subscription (asynchronously) Delete a webhook subscription by ID.
okhttp3.Call	deleteWebhookSubscriptionCall(String accountId, String id, ApiCallback _callback)	Build call for deleteWebhookSubscription
ApiResponse<Void>	deleteWebhookSubscriptionWithHttpInfo(String accountId, String id)	Delete Webhook Subscription Delete a webhook subscription by ID.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
TfvStatus	getTollFreeVerificationStatus(String accountId, String phoneNumber)	Get Toll-Free Verification Status Gets the verification status for a phone number that is provisioned to your account.
okhttp3.Call	getTollFreeVerificationStatusAsync(String accountId, String phoneNumber, ApiCallback<TfvStatus> _callback)	Get Toll-Free Verification Status (asynchronously) Gets the verification status for a phone number that is provisioned to your account.
okhttp3.Call	getTollFreeVerificationStatusCall(String accountId, String phoneNumber, ApiCallback _callback)	Build call for getTollFreeVerificationStatus
ApiResponse<TfvStatus>	getTollFreeVerificationStatusWithHttpInfo(String accountId, String phoneNumber)	Get Toll-Free Verification Status Gets the verification status for a phone number that is provisioned to your account.
List<String>	listTollFreeUseCases()	List Toll-Free Use Cases Lists valid toll-free use cases.
okhttp3.Call	listTollFreeUseCasesAsync(ApiCallback<List<String>> _callback)	List Toll-Free Use Cases (asynchronously) Lists valid toll-free use cases.
okhttp3.Call	listTollFreeUseCasesCall(ApiCallback _callback)	Build call for listTollFreeUseCases
ApiResponse<List<String>>	listTollFreeUseCasesWithHttpInfo()	List Toll-Free Use Cases Lists valid toll-free use cases.
WebhookSubscriptionsListBody	listWebhookSubscriptions(String accountId)	List Webhook Subscriptions Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
okhttp3.Call	listWebhookSubscriptionsAsync(String accountId, ApiCallback<WebhookSubscriptionsListBody> _callback)	List Webhook Subscriptions (asynchronously) Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
okhttp3.Call	listWebhookSubscriptionsCall(String accountId, ApiCallback _callback)	Build call for listWebhookSubscriptions
ApiResponse<WebhookSubscriptionsListBody>	listWebhookSubscriptionsWithHttpInfo(String accountId)	List Webhook Subscriptions Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
void	requestTollFreeVerification(String accountId, VerificationRequest verificationRequest)	Request Toll-Free Verification Submit a request for verification of a toll-free phone number.
okhttp3.Call	requestTollFreeVerificationAsync(String accountId, VerificationRequest verificationRequest, ApiCallback<Void> _callback)	Request Toll-Free Verification (asynchronously) Submit a request for verification of a toll-free phone number.
okhttp3.Call	requestTollFreeVerificationCall(String accountId, VerificationRequest verificationRequest, ApiCallback _callback)	Build call for requestTollFreeVerification
ApiResponse<Void>	requestTollFreeVerificationWithHttpInfo(String accountId, VerificationRequest verificationRequest)	Request Toll-Free Verification Submit a request for verification of a toll-free phone number.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateTollFreeVerificationRequest(String accountId, String phoneNumber, TfvSubmissionWrapper tfvSubmissionWrapper)	Update Toll-Free Verification Request Updates a toll-free verification request.
okhttp3.Call	updateTollFreeVerificationRequestAsync(String accountId, String phoneNumber, TfvSubmissionWrapper tfvSubmissionWrapper, ApiCallback<Void> _callback)	Update Toll-Free Verification Request (asynchronously) Updates a toll-free verification request.
okhttp3.Call	updateTollFreeVerificationRequestCall(String accountId, String phoneNumber, TfvSubmissionWrapper tfvSubmissionWrapper, ApiCallback _callback)	Build call for updateTollFreeVerificationRequest
ApiResponse<Void>	updateTollFreeVerificationRequestWithHttpInfo(String accountId, String phoneNumber, TfvSubmissionWrapper tfvSubmissionWrapper)	Update Toll-Free Verification Request Updates a toll-free verification request.
WebhookSubscription	updateWebhookSubscription(String accountId, String id, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)	Update Webhook Subscription Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
okhttp3.Call	updateWebhookSubscriptionAsync(String accountId, String id, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema, ApiCallback<WebhookSubscription> _callback)	Update Webhook Subscription (asynchronously) Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
okhttp3.Call	updateWebhookSubscriptionCall(String accountId, String id, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema, ApiCallback _callback)	Build call for updateWebhookSubscription
ApiResponse<WebhookSubscription>	updateWebhookSubscriptionWithHttpInfo(String accountId, String id, WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)	Update Webhook Subscription Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TollFreeVerificationApi

public TollFreeVerificationApi()

TollFreeVerificationApi

public TollFreeVerificationApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createWebhookSubscriptionCall

public okhttp3.Call createWebhookSubscriptionCall(String accountId,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema,
 ApiCallback _callback)
                                           throws ApiException

Build call for createWebhookSubscription

Parameters:

accountId - Your Bandwidth Account ID. (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

createWebhookSubscription

public WebhookSubscription createWebhookSubscription(String accountId,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)
                                              throws ApiException

Create Webhook Subscription Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.

Parameters:

accountId - Your Bandwidth Account ID. (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

Returns:

WebhookSubscription

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

createWebhookSubscriptionWithHttpInfo

public ApiResponse<WebhookSubscription> createWebhookSubscriptionWithHttpInfo(String accountId,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)
                                                                       throws ApiException

Create Webhook Subscription Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.

Parameters:

accountId - Your Bandwidth Account ID. (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

Returns:

ApiResponse<WebhookSubscription>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

createWebhookSubscriptionAsync

public okhttp3.Call createWebhookSubscriptionAsync(String accountId,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema,
 ApiCallback<WebhookSubscription> _callback)
                                            throws ApiException

Create Webhook Subscription (asynchronously) Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.

Parameters:

accountId - Your Bandwidth Account ID. (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

deleteWebhookSubscriptionCall

public okhttp3.Call deleteWebhookSubscriptionCall(String accountId,
 String id,
 ApiCallback _callback)
                                           throws ApiException

Build call for deleteWebhookSubscription

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

deleteWebhookSubscription

public void deleteWebhookSubscription(String accountId,
 String id)
                               throws ApiException

Delete Webhook Subscription Delete a webhook subscription by ID.

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

deleteWebhookSubscriptionWithHttpInfo

public ApiResponse<Void> deleteWebhookSubscriptionWithHttpInfo(String accountId,
 String id)
                                                        throws ApiException

Delete Webhook Subscription Delete a webhook subscription by ID.

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

deleteWebhookSubscriptionAsync

public okhttp3.Call deleteWebhookSubscriptionAsync(String accountId,
 String id,
 ApiCallback<Void> _callback)
                                            throws ApiException

Delete Webhook Subscription (asynchronously) Delete a webhook subscription by ID.

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

getTollFreeVerificationStatusCall

public okhttp3.Call getTollFreeVerificationStatusCall(String accountId,
 String phoneNumber,
 ApiCallback _callback)
                                               throws ApiException

Build call for getTollFreeVerificationStatus

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

getTollFreeVerificationStatus

public TfvStatus getTollFreeVerificationStatus(String accountId,
 String phoneNumber)
                                        throws ApiException

Get Toll-Free Verification Status Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

Returns:

TfvStatus

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

getTollFreeVerificationStatusWithHttpInfo

public ApiResponse<TfvStatus> getTollFreeVerificationStatusWithHttpInfo(String accountId,
 String phoneNumber)
                                                                 throws ApiException

Get Toll-Free Verification Status Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

Returns:

ApiResponse<TfvStatus>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

getTollFreeVerificationStatusAsync

public okhttp3.Call getTollFreeVerificationStatusAsync(String accountId,
 String phoneNumber,
 ApiCallback<TfvStatus> _callback)
                                                throws ApiException

Get Toll-Free Verification Status (asynchronously) Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listTollFreeUseCasesCall

public okhttp3.Call listTollFreeUseCasesCall(ApiCallback _callback)
                                      throws ApiException

Build call for listTollFreeUseCases

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listTollFreeUseCases

public List<String> listTollFreeUseCases()
                                  throws ApiException

List Toll-Free Use Cases Lists valid toll-free use cases.

Returns:

List<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listTollFreeUseCasesWithHttpInfo

public ApiResponse<List<String>> listTollFreeUseCasesWithHttpInfo()
                                                           throws ApiException

List Toll-Free Use Cases Lists valid toll-free use cases.

Returns:

ApiResponse<List<String>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listTollFreeUseCasesAsync

public okhttp3.Call listTollFreeUseCasesAsync(ApiCallback<List<String>> _callback)
                                       throws ApiException

List Toll-Free Use Cases (asynchronously) Lists valid toll-free use cases.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listWebhookSubscriptionsCall

public okhttp3.Call listWebhookSubscriptionsCall(String accountId,
 ApiCallback _callback)
                                          throws ApiException

Build call for listWebhookSubscriptions

Parameters:

accountId - Your Bandwidth Account ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listWebhookSubscriptions

public WebhookSubscriptionsListBody listWebhookSubscriptions(String accountId)
                                                      throws ApiException

List Webhook Subscriptions Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).

Parameters:

accountId - Your Bandwidth Account ID. (required)

Returns:

WebhookSubscriptionsListBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listWebhookSubscriptionsWithHttpInfo

public ApiResponse<WebhookSubscriptionsListBody> listWebhookSubscriptionsWithHttpInfo(String accountId)
                                                                               throws ApiException

List Webhook Subscriptions Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).

Parameters:

accountId - Your Bandwidth Account ID. (required)

Returns:

ApiResponse<WebhookSubscriptionsListBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

listWebhookSubscriptionsAsync

public okhttp3.Call listWebhookSubscriptionsAsync(String accountId,
 ApiCallback<WebhookSubscriptionsListBody> _callback)
                                           throws ApiException

List Webhook Subscriptions (asynchronously) Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).

Parameters:

accountId - Your Bandwidth Account ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

requestTollFreeVerificationCall

public okhttp3.Call requestTollFreeVerificationCall(String accountId,
 VerificationRequest verificationRequest,
 ApiCallback _callback)
                                             throws ApiException

Build call for requestTollFreeVerification

Parameters:

accountId - Your Bandwidth Account ID. (required)

verificationRequest - Request for verification of a toll-free phone number. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

requestTollFreeVerification

public void requestTollFreeVerification(String accountId,
 VerificationRequest verificationRequest)
                                 throws ApiException

Request Toll-Free Verification Submit a request for verification of a toll-free phone number.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verificationRequest - Request for verification of a toll-free phone number. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

requestTollFreeVerificationWithHttpInfo

public ApiResponse<Void> requestTollFreeVerificationWithHttpInfo(String accountId,
 VerificationRequest verificationRequest)
                                                          throws ApiException

Request Toll-Free Verification Submit a request for verification of a toll-free phone number.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verificationRequest - Request for verification of a toll-free phone number. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

requestTollFreeVerificationAsync

public okhttp3.Call requestTollFreeVerificationAsync(String accountId,
 VerificationRequest verificationRequest,
 ApiCallback<Void> _callback)
                                              throws ApiException

Request Toll-Free Verification (asynchronously) Submit a request for verification of a toll-free phone number.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verificationRequest - Request for verification of a toll-free phone number. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateTollFreeVerificationRequestCall

public okhttp3.Call updateTollFreeVerificationRequestCall(String accountId,
 String phoneNumber,
 TfvSubmissionWrapper tfvSubmissionWrapper,
 ApiCallback _callback)
                                                   throws ApiException

Build call for updateTollFreeVerificationRequest

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

tfvSubmissionWrapper - Update a request for verification of a toll-free phone number. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateTollFreeVerificationRequest

public void updateTollFreeVerificationRequest(String accountId,
 String phoneNumber,
 TfvSubmissionWrapper tfvSubmissionWrapper)
                                       throws ApiException

Update Toll-Free Verification Request Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

tfvSubmissionWrapper - Update a request for verification of a toll-free phone number. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateTollFreeVerificationRequestWithHttpInfo

public ApiResponse<Void> updateTollFreeVerificationRequestWithHttpInfo(String accountId,
 String phoneNumber,
 TfvSubmissionWrapper tfvSubmissionWrapper)
                                                                throws ApiException

Update Toll-Free Verification Request Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

tfvSubmissionWrapper - Update a request for verification of a toll-free phone number. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateTollFreeVerificationRequestAsync

public okhttp3.Call updateTollFreeVerificationRequestAsync(String accountId,
 String phoneNumber,
 TfvSubmissionWrapper tfvSubmissionWrapper,
 ApiCallback<Void> _callback)
                                                    throws ApiException

Update Toll-Free Verification Request (asynchronously) Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).

Parameters:

accountId - Your Bandwidth Account ID. (required)

phoneNumber - Valid Toll-Free telephone number in E.164 format. (required)

tfvSubmissionWrapper - Update a request for verification of a toll-free phone number. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateWebhookSubscriptionCall

public okhttp3.Call updateWebhookSubscriptionCall(String accountId,
 String id,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema,
 ApiCallback _callback)
                                           throws ApiException

Build call for updateWebhookSubscription

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateWebhookSubscription

public WebhookSubscription updateWebhookSubscription(String accountId,
 String id,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)
                                              throws ApiException

Update Webhook Subscription Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

Returns:

WebhookSubscription

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateWebhookSubscriptionWithHttpInfo

public ApiResponse<WebhookSubscription> updateWebhookSubscriptionWithHttpInfo(String accountId,
 String id,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema)
                                                                       throws ApiException

Update Webhook Subscription Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

Returns:

ApiResponse<WebhookSubscription>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

updateWebhookSubscriptionAsync

public okhttp3.Call updateWebhookSubscriptionAsync(String accountId,
 String id,
 WebhookSubscriptionRequestSchema webhookSubscriptionRequestSchema,
 ApiCallback<WebhookSubscription> _callback)
                                            throws ApiException

Update Webhook Subscription (asynchronously) Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).

Parameters:

accountId - Your Bandwidth Account ID. (required)

id - Webhook subscription ID (required)

webhookSubscriptionRequestSchema - Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Cannot find the requested resource.	-
405	Method Not Allowed	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-