API Reference

exception nexmo.AuthenticationError[source]
class nexmo.Client(**kwargs)[source]
auth(params=None, **kwargs)[source]
buy_number(params=None, **kwargs)[source]
cancel_number(params=None, **kwargs)[source]
cancel_verification(request_id)[source]
check_signature(params)[source]
check_verification(request_id, params=None, **kwargs)[source]
check_verification_request(params=None, **kwargs)[source]
control_verification_request(params=None, **kwargs)[source]
create_application(params=None, **kwargs)[source]
create_call(params=None, **kwargs)[source]
delete(host, request_uri)[source]
delete_application(application_id)[source]
get(host, request_uri, params={})[source]
get_account_numbers(params=None, **kwargs)[source]
get_application(application_id)[source]
get_applications(params=None, **kwargs)[source]
get_available_numbers(country_code, params=None, **kwargs)[source]
get_balance()[source]
get_basic_number_insight(params=None, **kwargs)[source]
get_call(uuid)[source]
get_calls(params=None, **kwargs)[source]
get_country_pricing(country_code)[source]
get_event_alert_numbers()[source]
get_message(message_id)[source]
get_message_rejections(params=None, **kwargs)[source]
get_number_insight(params=None, **kwargs)[source]
get_prefix_pricing(prefix)[source]
get_sms_pricing(number)[source]
get_verification(request_id)[source]
get_verification_request(request_id)[source]
get_voice_pricing(number)[source]
initiate_call(params=None, **kwargs)[source]
initiate_tts_call(params=None, **kwargs)[source]
initiate_tts_prompt_call(params=None, **kwargs)[source]
parse(host, response)[source]
post(host, request_uri, params)[source]
put(host, request_uri, params)[source]
request_number_insight(params=None, **kwargs)[source]
resubscribe_event_alert_number(params=None, **kwargs)[source]
search_messages(params=None, **kwargs)[source]
send_2fa_message(params=None, **kwargs)[source]
send_event_alert_message(params=None, **kwargs)[source]
send_marketing_message(params=None, **kwargs)[source]
send_message(params)[source]
send_ussd_prompt_message(params=None, **kwargs)[source]
send_ussd_push_message(params=None, **kwargs)[source]
send_verification_request(params=None, **kwargs)[source]
signature(params)[source]
start_verification(params=None, **kwargs)[source]
topup(params=None, **kwargs)[source]
trigger_next_verification_event(request_id)[source]
update_application(application_id, params=None, **kwargs)[source]
update_call(uuid, params=None, **kwargs)[source]
update_number(params=None, **kwargs)[source]
update_settings(params=None, **kwargs)[source]
exception nexmo.ClientError[source]
exception nexmo.Error[source]
exception nexmo.ServerError[source]