Difference between revisions of "MOR API number pool numbers create"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with "=Description= MOR API for creating number pools numbers. <br><br> =Usage= * From '''MOR X17''' call: '''/api/number_pool_numbers_create''' * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parametres=== * u - username to login. '''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 # %). '''n...") |
|||
| Line 11: | Line 11: | ||
===Parametres=== | ===Parametres=== | ||
Parameters that are included in hash: | |||
* u - username to login. '''Required'''. | * u - username to login. '''Required'''. | ||
* number_pool_id - Selects Number Pool. '''Required'''. | * number_pool_id - Selects Number Pool. '''Required'''. | ||
Parameters that are NOT included in hash: | |||
* 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 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> | ||
| Line 21: | Line 23: | ||
* [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | * [[MOR API hash construction | hash]] – SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. | ||
<br><br> | <br><br> | ||
===Request=== | ===Request=== | ||
If API Secret Key = secret | If API Secret Key = secret | ||
Latest revision as of 07:33, 16 December 2024
Description
MOR API for creating number pools numbers.
Usage
- From MOR X17 call: /api/number_pool_numbers_create
- Methods: POST, GET(if allowed, not recomended)
Parametres
Parameters that are included in hash:
- u - username to login. Required.
- number_pool_id - Selects Number Pool. Required.
Parameters that are NOT included in hash:
- 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 # %).
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>
