Vodia PBX API (version 58.0 and above)

This page includes all the API parameters of the page Admin > Settings > General. It contains the API information for the 3 consecutive Admin level pages, namely System, Recording / CDR, Logging. The License page with it's API calls are discussed separately.

System, Recording / CDR, Loggin Pages

GET System, Recording / CDR, Loggin page's setting(s)

GET

1) (Info of all the 3 pages on Admin > Settings > General Level)

rest/system/config

Success (200 OK)

Example:

Request:

curl -u username:password GET -D - http://192.168.1.194:8080/rest/system/config
{ log_filename: " ", log_length: "500", log_keep: "3", log_sip_register: "false", log_sip_subnot: "false", log_sip_other: "false", log_sip_dialog: "true", log_sip_watchlist: "", log_sip_routing: "false", log_event_general: "0", log_event_sip: "9", log_event_media: "0", log_event_app: "0", log_event_email: "0", log_event_webserver: "0", log_event_register: "0", log_event_snmp: "0", log_event_ldap: "0", log_event_config: "0", log_event_trunk: "0", log_event_soap: "0", log_event_tftp: "9", log_event_webclient: "0", log_event_pstn: "5", log_event_tls: "0", log_event_lync: "0", log_event_dns: "0", log_event_billing: "0", reboot_event: "", reboot_action: "", dtmf_gain: "512", terminate_dtmf: "false", tone_gain: "256", tone_thres: "50", tone_repeat: "5", affinity_mask: "", mos_threshold: "30", email_cpu_limit: "false", email_trunk_change: "false", email_license_expire: "false", email_regstatus: "false", email_restart_system: "false", email_new_recording: "false", email_coline_allocation: "false", email_trunk_failover: "false", email_emergency_call: "false", email_rtp_timeout: "false", email_call_timeout: "false", email_address_change: "false", email_bye_no_media: "false", email_cpu_report: "false", email_blacklist_ip: "false", email_page_failure: "false", email_low_credit: "false", email_trunk_calls: "true", blacklist_expires: "3600", blacklist_attempts: "10", blacklist_period: "1000", ignore_wrong_domain: "false", blacklist_user_agent: "friendly-scanner sipcli", version: "5.1.0 y534", code_ipadr: "", code_restore: "", code_fabtest: "", code_version: "*#8377466#", sys_name: "", max_loop: "10", extended_status: "", trunk_reinvite: "false", ip_http_port: "8080", ip_https_port: "443", ip_sip_udp_port: "5060", ip_sip_tcp_port: "5060", ip_sip_tls_port: "5061", ip_snmp_port: "161", ip_snmp_community: "public", ip_tftp_port: "69", ip_ldap_port: "2345", ip_ldaps_port: "2346", ip_replacement_list: "", ip_routing_list: "", ip_public_ip_service_url: "", ip_public_ip_interval: "300", ip_dhcp_monitor: "67", tls_rc4: "false", tls_min_version: "tls10", tls_max_version: "tls12", dtls_min_version: "", dtls_max_version: "", siptrans: "", c2d_root: "", max_udp_invite: "10", tftp_write: "false", tftp_log: "true", port_begin: "49152", port_end: "64512", port_bind4: "", port_bind6: "", ip_manual_ip1: "", ip_manual_ip2: "", http_tls_web: "false", http_content: "system", http_rate: "50", http_threads: "500", sip_rate: "20", sip_threads: "500", pw_user: "admin", pw_trusted: "127.0.0.1 [::1]", random: "gVjIwkY6cGqfBxw5zmujTA==", password_policy: "none", password_history: "4", password_duration: "", recovery_duration: "3600", allow_empty_passwords: "true", rest_show_passwords: "false", session_timeout: "3600", timeout_connected: "120", timeout_hold: "3600", timeout_conference: "3600", allow_pass_through: "true", cookie_duration: "2592000", seize_timeout: "60", tcpcon_web: "10", tcpcon_sip: "256", soap_trusted_ip: "localhost", csta_trusted_ip: "", snmp_trusted_ip: "", cdr_keep: "7d", cdr_list_size: "30", max_cdr_num: "100000", button_speed_on_idle: "false", button_speed_on_busy: "false", conf_terminate: "*9", conf_list: "*0", conf_mute: "*1", conf_unmute: "*2", conf_muteall: "*7", conf_unmuteall: "*8", min_expires: "30", max_expires: "360", sub_expires: "3600", save_registration: "false", cdr_email_size: "1000", symmetrical_rtp: "true", ring180: "false", packet_size: "20", rtcp_loss_rle: "false", rtcp_dup_rle: "false", rtcp_rcpt_times: "false", rtcp_rcvr_rtt: "true", rtcp_stat_summary: "false", rtcp_voip_metrics: "true", always_send_ptime: "false", max_regs: "5", max_web_requests: "500", short_header: "false", support_update: "false", search_audio: "false", ext_field: "", codec_preference: "8 0 2 3 9 18", codec_lock: "true", mcast_addresses: "", mcast_ttl: "", max_calls: "250", max_tar: "1048576", nat_udp: "30", nat_tcp2: "60", web_timeout: "60", soap_cdr_adr: "webcdr://192.168.1.194/cdr-collector", soap_cdr_username: "sach", soap_mailbox_file: "", report_domains: "", language_audio: "en", language_tones: "en", language_web: "en", pnp_description: "pnp.xml", pnp_duration: "30", pnp_after: "5", pnp_open_on_creation: "true", ring_description: "ringtones.xml", dialplan_description: "dialplans.xml", multicast: "true", loop_detection: "true", offer_sdes: "true", mwi_notify: "false", max_call_duration: "14400", max_rec_duration: "14400", ani_dom_admin: "true", trunk_dom_admin: "true", dp_dom_admin: "true", ac_dom_admin: "true", perm_sip_pass: "true", multiple_hot_destking: "false", register_via_count: "true", send_recording: "true", cdr_type: "", cdr_file_name: "$c/$m/$d.csv", cdr_field_seperator: ",", pref_http_scheme: "http", pref_http_address: "", backup_program: "", record_location: "$r/$o/$d/$l/$x/$t-$i-$u-$n.wav", record_compress: "false", cdr_format: "$w$5e$12c$5d$12T$12t$12F$12f", last_digits: "0", languages_web: "en au cn de dk fr gr it nl pl pt ru sp uk", languages_tones: "it au uk en fr ca nl de", languages_audio: "dk it ru au uk en fr ca nl ar de", app_login_text: "", app_copyright: "Copyright {0} Vodia Networks Inc.", app_link: "https://vodia.com", app_doc: "", app_ua: "", app_product: "Vodia PBX", app_logo: "", app_banner_def: "http://www.vodia.com/img/welcomeheader.jpg", app_banner_fax: "http://www.vodia.com/img/new_fax.jpg", app_banner_vm: "http://www.vodia.com/img/new_mailbox.jpg", timezone: "GMT", ntp_host: "ntp.vodia.com", ip_ntp_port: "", tos_rtp: "ef", tos_sip: "cs5", diversion_style: "", code_record: "false", performance_limit: "60", email_list_performance: "sachin@yahoo.com", bandwidth: "", cellphone_timeout: "20", camp_enabled: "true", conf_expiry: "86400", provision_domain_name: "false", presence_auth_token: "", email_from: "sc", email_user: "sy@vodia.com", email_smtp: "smtp.gmail.com:465", smtp_starttls: "tls", email_global: "false", email_domain: "", email_certs: "false", cdr_url_global: "true", fresh_url: "", fresh_token: "", fresh_invoice_number: "yymmcccccc", fresh_use_json: "false", usr_change_watch: "true", usr_change_sippass: "false", usr_change_webpass: "false", usr_change_iac: "true", usr_change_cfnat: "true", usr_change_mbe: "true", usr_change_tumpu: "true", usr_change_mnom: "true", usr_change_mea: "true", usr_change_sammbe: "true", usr_change_asam: "true", usr_change_adrbook: "true", crm_server_adr: "", max_tcp_length: "16777216", sdp_savp: "true", web_client_delay: "60", max_ring_duration: "60", extension_status_url: "", aoc_policy: "flat", cdav_scope: "", cdav_clientid: "", cdav_clientsecret: "", cdav_redirect: "", cdr_call_quality_report: "false", hosted_email_address: "", override_thread_limit: "false", syslog_server_ip: "", thread_stack_size: "4", sip_log_collection: "true", delete_rec: "false", write_cobjs_to_fs: "false", write_legs_to_fs: "false", ldap_size_limit: "1000", out_of_dialog_options: "false", no_rport: "false", provuser: "", provuser2: "", provuser3: "", provuser4: "", provuser5: "VoiceSpring", provuser6: "", provredirect: "http://192.168.1.194:8080", plain_read_timeout: "10000", plain_connect_timeout: "10000", sms_adr: "", sms_method: "", sms_admin: "", sms_header: "", sms_body_voicemail: "", sms_body_other: "", thread_level: "", voicecloud_custid: "", voicecloud_apiurl: "", voicecloud_devkey: "", voicecloud_default: "true", relic_license_key: "", fill_chars: " .-()/" }
Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.

UPDATE System, Recording / CDR, Loggin page(s)

post
/rest/system/config

Example:

Request:

curl -u username:password -D - http://192.168.1.194:8080/rest/system/config -X POST -d "{ 'log_filename':'file.log', 'log_length':'500', 'log_event_general':'4', 'log_event_sip':'9', 'cdr_keep':'8d', 'cdr_list_size':'40', 'max_cdr_num':'100000', 'soap_cdr_adr':'webcdr://192.168.1.194/cdr-collector', 'nat_udp':'30', 'nat_tcp2':'60', 'language_audio':'it', 'language_tones':'uk', 'language_web':'en', 'max_call_duration':'43200', 'timezone':'GMT', 'max_ring_duration':'60', 'ani_dom_admin':'true', 'trunk_dom_admin':'true', 'dp_dom_admin':'true' }"

Response for all Create, Update or Delete requests:

Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated a Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.