Hoiio Open API logo Hoiio Open API

Definition

https://secure.hoiio.com/open/voice/hangup

Parameters

app_id* string
Application ID assigned to your application.
access_token* string
Access Token assigned to your application.
txn_ref string
The unique reference ID for the call you want to hangup.

Result Format

{"status":"success_ok"}

Documentation

This API will hangup a call that is currently in progress. You can call this API at any point in time when a call is in progress to hang up the call.

Response Parameters

status The result of your request. Refer to Result Status for details.

Result Status

success_ok The request has been processed successfully.
error_invalid_http_method Invalid HTTP method. Only GET or POST are allowed.
error_malformed_params HTTP POST request parameters contains non-readable bytes.
error_X_param_missing A required parameter is missing. X is the name of the parameter that is missing.
error_invalid_access_token Your Access Token is invalid, expired or has been revoked.
error_invalid_app_id Your Application ID is invalid or has been revoked.
error_rate_limit_exceeded You have exceeded your request limit for this API. Refer to API Limits for details.
error_internal_server_error There is an unexpected error. Please contact Hoiio support for assistance.

Notifications

None.

API Limits

60 request per minute per application

Charges

None.