Difference between revisions of "M4 API number pool numbers create"
From Kolmisoft Wiki
Jump to navigationJump to search
m (Admin moved page M2 API number pool numbers create to M4 API number pool numbers create) |
|||
| Line 1: | Line 1: | ||
=Description= | =Description= | ||
API for creating number pool numbers. | |||
| Line 7: | Line 7: | ||
* From '''M4''' call: '''/api/number_pool_numbers_create''' | * From '''M4''' call: '''/api/number_pool_numbers_create''' | ||
* Methods: POST, GET(if allowed, not | * Methods: POST, GET(if allowed, not recommended) | ||
<br><br> | <br><br> | ||
===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'''. | ||
* numbers - Numbers to create, must be in following format "370,44%,#14,13" (Numbers separated by commas and allowed Number format is 0-9 a-z A-Z # %). | * numbers - Numbers to create, 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 Database will be converted to "_".<br> | '''note''': creating a Number which contains "#" character in Database will be converted to "_".<br> | ||
'''note''': if using the browser's URL bar, then you should encode symbols. Example: | '''note''': if using the browser's URL bar, then you should encode symbols. Example: | ||
| Line 39: | Line 39: | ||
</status> | </status> | ||
</page> | </page> | ||
<br><br> | |||
=See also= | |||
* [[M4 API]] | |||
Latest revision as of 11:24, 28 November 2022
Description
API for creating number pool numbers.
Usage
- From M4 call: /api/number_pool_numbers_create
- Methods: POST, GET(if allowed, not recommended)
Parametres
- u - username to log in. Required.
- number_pool_id - Selects Number Pool. Required.
- numbers - Numbers to create, 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 Database will be converted to "_".
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_create?u=admin&number_pool_id=3&numbers=44%25&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
Returns
Success
<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Number Pool's Numbers created</success>
</status>
</page>
