Difference between revisions of "M4 API number pools get"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 14: Line 14:
* number_pool_id - Retrieve specific Number Pool by ID, if this parameter is not used, all Number Pools are retrieved based on the owner (from u param).
* number_pool_id - Retrieve specific Number Pool by ID, if this parameter is not used, all Number Pools are retrieved based on the owner (from u param).
* show_numbers - Show all Number Pool's Numbers, value must be "1"
* show_numbers - Show all Number Pool's Numbers, value must be "1"
** Settings used when show_numbers=1:
*** number_limit_row_count - specifies how many numbers to include
*** number_limit_offset - specifies how many numbers to skip (not from the first, but to skip n entries)
* number_limit_row_count - must be integer value higher than 0
* number_limit_row_count - must be integer value higher than 0
* number_limit_offset - must be integer value higher than or equal to 0
* number_limit_offset - must be integer value higher than or equal to 0

Revision as of 13:32, 20 October 2022

Description

M2 API for getting the list of number pools.




Usage

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



Parametres

  • u - username to login. Required.
  • number_pool_id - Retrieve specific Number Pool by ID, if this parameter is not used, all Number Pools are retrieved based on the owner (from u param).
  • show_numbers - Show all Number Pool's Numbers, value must be "1"
    • Settings used when show_numbers=1:
      • number_limit_row_count - specifies how many numbers to include
      • number_limit_offset - specifies how many numbers to skip (not from the first, but to skip n entries)
  • number_limit_row_count - must be integer value higher than 0
  • number_limit_offset - must be integer value higher than or equal to 0
  • 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_pools_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4



Returns

Success 

<?xml version="1.0" encoding="UTF-8"?>
 <page>
   <status>
     <number_pools>
       <number_pool>
         <id>1</id>
         <name>Test</name>
         <comment></comment>
         <owner_id>0</owner_id>
       </number_pool>
     </number_pools>
   </status>
 </page>
Retrieved from "https://wiki.kolmisoft.com/index.php?title=M4_API_number_pools_get&oldid=27706"