MOR API did rates update

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

MOR API Update DID rates

[edit] Usage

  • From MOR X12 call: /api/did_rates_update
  • Methods: POST, GET(if allowed, not recommended)

[edit] Parameters

Parameters which are included into hash:

  • did - DID number Required.

Parameters which are not included into hash:

  • u - username for authentication. Required.
  • s_id - did rate id.
  • s_rate_type - type of rate, allowed values are: provider, owner, incoming.

either s_id or s_rate_type must be provided, s_id can be found using MOR API did rates get.

  • rate - new rate value.
  • connection_fee - new connection fee value.
  • increment_s - new increment value.
  • min_time - new min time value.
  • s_start_time - start time of rate, format is hh:mm:ss.
  • s_end_time - end time of rate, format is hh:mm:ss.
  • s_daytype - day type of rate, allowed values are WD and FD.
  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.

[edit] Request

We have DID 370123456789, API Secret Key = secret

We send

HTML POST: http://<SERVER_IP>/billing/api/did_rates_update?did=370123456789&u=admin&s_rate_type=provider&rate=0.5&hash=a2ceb0323d6a76a9fc9b66a21d321ae618c40296

[edit] Returns

<?xml version="1.0" encoding="UTF-8"?>
  <updated_rates>1 </updated_rates>


<?xml version="1.0" encoding="UTF-8"?>
      <error>Error message</error>

Error messages:

  • Incorrect hash – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • Access Denied – Only Admin, Accountant or Reseller may use API.
  • DID was not found – DID number does not exist or incorrect.
  • Rates were not found - rates were not found using one of search parameters: s_id, s_rate_type, s_start_time, s_end_time, s_daytype.

[edit] See also

Personal tools


Try M2