Difference between revisions of "M4 API number pool numbers delete"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with "=Description= M2 API for deleting number pool numbers. <br><br> =Usage= * From '''M4''' call: '''/api/number_pool_numbers_delete''' * Methods: POST, GET(if allowed, not recommended) <br><br> ===Parametres=== * u - username to login. '''Required'''. * number_pool_id - Selects Number Pool. '''Required'''. * delete_all - Deletes all Numbers, value must be "1". * number_ids - Selects Numbers to delete by their Number ID, must be in the following format "1,3,4" (IDs s...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Description= | =Description= | ||
API for deleting number pool numbers. | |||
| Line 11: | Line 11: | ||
===Parametres=== | ===Parametres=== | ||
* u - username to | * u - username to log in. '''Required'''. | ||
* number_pool_id - Selects Number Pool. '''Required'''. | * number_pool_id - Selects Number Pool. '''Required'''. | ||
* delete_all - Deletes all Numbers, value must be "1". | * delete_all - Deletes all Numbers, value must be "1". | ||
| Line 41: | Line 41: | ||
</status> | </status> | ||
</page> | </page> | ||
<br><br> | |||
=See also= | |||
* [[M4 API]] | |||
Latest revision as of 11:23, 28 November 2022
Description
API for deleting number pool numbers.
Usage
- From M4 call: /api/number_pool_numbers_delete
- Methods: POST, GET(if allowed, not recommended)
Parametres
- u - username to log in. Required.
- number_pool_id - Selects Number Pool. Required.
- delete_all - Deletes all Numbers, value must be "1".
- number_ids - Selects Numbers to delete by their Number ID, must be in the following format "1,3,4" (IDs separated by commas), and can be called with numbers parameter simultaneously.
- numbers - Numbers to delete, must be in the following format "370,44%,#14,13" (Numbers separated by commas and allowed Number format is 0-9 a-z A-Z # %).
note: creating a Number which contains "#" character in the Database will be converted to "_". Can be called with number_ids parameter simultaneously
note: if using the browser's URL bar, then you should encode symbols. Example:
- for % use %25. If you want to add 44%, use 44%25.
- for # use %23. If you want to add #44, use %2344.
- for + use %2B. If you want to add +44, use %2B44.
- 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_numbers_delete?u=admin&number_pool_id=3&numbers=%2344&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
Returns
Success
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Number Pool's selected Numbers deleted</success>
</status>
</page>
