Difference between revisions of "M4 API number pool update"

From Kolmisoft Wiki
Jump to navigationJump to search
 
Line 1: Line 1:
=Description=
=Description=
[[M2 API]] for updating number pools.
API for updating number pools.




Line 7: Line 7:


* From '''M4''' call: '''/api/number_pool_update'''
* From '''M4''' call: '''/api/number_pool_update'''
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recommended)
<br><br>
<br><br>
===Parametres===
===Parametres===


* u - username to login. '''Required'''.
* u - username to log in. '''Required'''.
* number_pool_id - Selects Number Pool. '''Required'''.
* number_pool_id - Selects Number Pool. '''Required'''.
* name - Number Pool's name
* name - Number Pool's name
Line 35: Line 35:
   </status>
   </status>
  </page>
  </page>
<br><br>
=See also=
* [[M4 API]]

Latest revision as of 11:25, 28 November 2022

Description

API for updating number pools.




Usage

  • From M4 call: /api/number_pool_update
  • Methods: POST, GET(if allowed, not recommended)



Parametres

  • u - username to log in. Required.
  • number_pool_id - Selects Number Pool. Required.
  • name - Number Pool's name
  • comment - Number Pool's comment
  • hash – SHA1 hash constructed using API Secret Key ( More described in Constructing hash). Required.



Request

If API Secret Key = secret

You send:

HTML POST: http://<SERVER IP>/billing/api/number_pool_update?u=admin&number_pool_id=2&name=test_test2&comment=test_comment2&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4



Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
  <status>
    <success>Number Pool updated</success>
  </status>
</page>



See also