MOR API providers get
From Kolmisoft Wiki
Revision as of 08:29, 18 July 2022 by Dmitrij (talk | contribs) (Created page with "=Description= MOR API for getting the list of providers. <br><br> =Usage= * From '''MOR X17''' call: '''/api/providers_get''' * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parametres=== * u - username to login. '''Required'''. * hash – SHA1 hash constructed using '''API Secret Key''' ( More described in Constructing hash). '''Required'''. *provider_id - Retrieve specific Provider by ID...")
Description
MOR API for getting the list of providers.
Usage
- From MOR X17 call: /api/providers_get
- Methods: POST, GET(if allowed, not recomended)
Parametres
- u - username to login. Required.
- hash – SHA1 hash constructed using API Secret Key ( More described in Constructing hash). Required.
- provider_id - Retrieve specific Provider by ID, if this parameter is not used, all Providers are retrieved based on the owner (from u param)
Request
If API Secret Key = secret
You send:
HTML POST: http://<SERVER IP>/billing/api/providers_get?u=admin&provider_id=2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
* Note that username (u) is not included in the hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<providers>
<provider>
<id>2</id>
<name>BALTICTELCO.EU PLATINUM</name>
<tech>SIP</tech>
<channel></channel>
<login></login>
<password></password>
<server_ip>78.46.61.254</server_ip>
<port>5060</port>
<priority>1</priority>
<quality>1</quality>
<tariff_id>1</tariff_id>
<cut_a>0</cut_a>
<cut_b>0</cut_b>
<add_a></add_a>
<add_b></add_b>
<device_id>4</device_id>
<ani>0</ani>
<timeout>60</timeout>
<call_limit>0</call_limit>
<interpret_noanswer_as_failed>0</interpret_noanswer_as_failed>
<interpret_busy_as_failed>0</interpret_busy_as_failed>
<register>0</register>
<reg_extension></reg_extension>
<terminator_id>1</terminator_id>
<reg_line></reg_line>
<hidden>0</hidden>
<use_p_asserted_identity>0</use_p_asserted_identity>
<user_id>0</user_id>
<common_use>0</common_use>
<balance>0.0</balance>
<balance_limit></balance_limit>
<cps_call_limit>0</cps_call_limit>
<cps_period>0</cps_period>
<alive>1</alive>
<periodic_check>0</periodic_check>
<active>1</active>
<contact_info_id>0</contact_info_id>
<contact_info_partners_id>0</contact_info_partners_id>
<contact_info_noc_id>0</contact_info_noc_id>
<contact_info_rates_provisioning_id>0</contact_info_rates_provisioning_id>
<contact_info_billing_provisioning_id>0</contact_info_billing_provisioning_id>
<tech_details_info></tech_details_info>
<privacy_from_domain></privacy_from_domain>
<privacy_callerid></privacy_callerid>
<playback_before_dial>0</playback_before_dial>
<playback_before_dial_mode></playback_before_dial_mode>
<prov_enable_static_source_list>no</prov_enable_static_source_list>
<prov_static_source_list_id></prov_static_source_list_id>
<enable_mnp_tags>0</enable_mnp_tags>
<responsible_accountant_id>-1</responsible_accountant_id>
<sip_request_uri></sip_request_uri>
<sip_to_uri></sip_to_uri>
<prov_enable_static_destination_list>no</prov_enable_static_destination_list>
<prov_static_destination_list_id></prov_static_destination_list_id>
<use_tariffs_by_clis>0</use_tariffs_by_clis>
<use_default_tariff_if_by_cli_not_found>0</use_default_tariff_if_by_cli_not_found>
</provider>
</providers>
</status>
</page>