SuperVoIP (1.0.0)

API Changelog

Authorization

Add a header in the following format to every request:

Name: Authorization

Value: Bearer <token>

Replace <token> with your API token.

Sample request:

curl -H \"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ...\" https://restapi.supervoip.pl/api/customers/me

Webhook signature

Webhhok requests send a signature in X-Signature-Sha256 header. Signature is generated by signing the entire payload with HMAC SHA256 with a personal key. The key is defined as webhookSecret in Customer structure. Webhooks require SuperVoIP API service.

How to verify: hash_hmac('sha256', webhookPayload, webhookSecret) === webhookXSignatureHeader

Rate limiting

Requests are limited to (0 means no limit):

Endpoint	Method	Number of requests/interval	Interval (s)
/api/asterisk/do_call	POST	1	1
/api/asterisk/do_call_remote	POST	5	1
/api/asterisk/reset_queue	POST	1	10
/api/asterisk/do_hangup_by_call_id	POST	1	1
/api/incoming_calls	GET	2	1
/api/incoming_calls/stats	GET	1	1
/api/outgoing_calls	GET	2	1
/api/outgoing_calls/stats	GET	1	1
/api/sms	GET	1	1
/api/records	GET	2	1
/api/records/download_zip	GET	1	1
/api/records/{id}	PUT	1	10
/api/records/{id}/download	GET	1	1
/api/transcriptions	GET	1	1
/api/transcriptions/{id}	GET	1	1
/api/conference_rooms	GET	1	1
/api/countries	GET	1	1
/api/regions	GET	1	1
/api/customers/me	GET	1	1
/api/customers/{id}	PUT	1	10
/api/media	POST	1	10
	GET	1	1
/api/media/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/media/{id}/download	GET	1	1
/api/sips	POST	1	10
	GET	1	1
/api/sips/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/sips/{id}/generate_password	PUT	1	10
/api/voicemail_files	GET	1	1
/api/voicemail_files/{id}	GET	1	1
/api/voicemail_files/{id}/download	GET	1	1
/api/voip_numbers	POST	1	10
	GET	1	1
/api/voip_numbers/download	GET	1	10
/api/voip_numbers/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/service_prices	GET	1	1
/api/internal_numbers	GET	1	1
	POST	1	10
/api/internal_numbers/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_scenarios	POST	1	10
	GET	1	1
/api/ivr_scenarios/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_scenarios/{id}/clone	POST	1	10
/api/ivr_tables	POST	1	10
	GET	1	1
/api/ivr_tables/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_table_rows	POST	1	10
/api/ivr_table_rows/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_auth_pins	POST	1	10
/api/ivr_auth_pins/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_auth_phones	POST	1	10
/api/ivr_auth_phones/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_ai_instances	POST	1	10
	GET	1	1
/api/ivr_ai_instances/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_ai_sources	POST	1	10
/api/ivr_ai_sources/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_action_call_recordings	POST	1	10
/api/ivr_action_call_recordings/{id}	DELETE	1	10
/api/ivr_action_chat_gpts	POST	1	10
/api/ivr_action_chat_gpts/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_connect_to_sips	POST	1	10
/api/ivr_action_connect_to_sips/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_enter_numbers	POST	1	10
/api/ivr_action_enter_numbers/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_go_tos	POST	1	10
/api/ivr_action_go_tos/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_menu_options	POST	1	10
/api/ivr_action_menu_options/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_menus	POST	1	10
/api/ivr_action_menus/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_open_hyperlinks	POST	1	10
/api/ivr_action_open_hyperlinks/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_play_messages	POST	1	10
/api/ivr_action_play_messages/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_queues	POST	1	10
/api/ivr_action_queues/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_read_texts	POST	1	10
/api/ivr_action_read_texts/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_redirects	POST	1	10
/api/ivr_action_redirects/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_send_emails	POST	1	10
/api/ivr_action_send_emails/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_send_sms	POST	1	10
/api/ivr_action_send_sms/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_set_statuses	POST	1	10
/api/ivr_action_set_statuses/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_signal_errors	POST	1	10
/api/ivr_action_signal_errors/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_signal_faxes	POST	1	10
/api/ivr_action_signal_faxes/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_signal_oks	POST	1	10
/api/ivr_action_signal_oks/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_voicemails	POST	1	10
/api/ivr_action_voicemails/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_action_welcome_messages	POST	1	10
/api/ivr_action_welcome_messages/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_auths	POST	1	10
/api/ivr_conditions_auths/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_check_incoming_numbers	POST	1	10
/api/ivr_conditions_check_incoming_numbers/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_check_tables	POST	1	10
/api/ivr_conditions_check_tables/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_check_variables	POST	1	10
/api/ivr_conditions_check_variables/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_statuses	POST	1	10
/api/ivr_conditions_statuses/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_conditions_times	POST	1	10
/api/ivr_conditions_times/{id}	PUT	1	10
	DELETE	1	10
/api/ivr_media	GET	1	1
/api/ivr_media/{id}	GET	1	1
	DELETE	1	10
/api/ivr_queues	GET	1	1
	POST	1	10
/api/ivr_queues/{id}	GET	1	1
/api/ivr_queue_agents	POST	1	1
	GET	1	1
/api/ivr_queue_agents/{id}	GET	1	1
	PUT	1	10
	DELETE	1	10
/api/ivr_queue_calls	GET	1	10
/api/numbers	GET	1	1
/api/numbers/{id}	GET	1	1
/api/live_call_stats	GET	1	1
/api/live_data/calls	GET	1	2
/api/live_data/queue_calls	GET	1
/api/sms_messages	POST	10	1
/api/sms_messages/{id}	GET	1	10
/api/sms_prices	GET	1	1
/api/sms_senders	GET	1	1