Difference between revisions of "MOR API did device assign"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with 'MOR API DID assign Device <br><br> ---- <br><br> * Call: /api/did_assign_device * Methods: POST, GET(if allowed, not recomended) * Params: ** did - DID number to be created '…')
 
Line 1: Line 1:
[[MOR API]]
=Descriptiom=
DID assign Device
[[MOR API]] DID assign Device
<br><br>
<br><br>
----
=Usage=
 
* Call: /api/did_device_assign
* For Backwards-compatibility old name 'did_assignt_device' is also usable. Call: /api/did_assign_device
* Methods: POST, GET(if allowed, not recomended)
<br><br>
<br><br>
* Call: /api/did_assign_device
===Parametres===
* Methods: POST, GET(if allowed, not recomended)
 
* Params:
* did - DID number where device have to be assigned. '''Required'''.
** did - DID number to be created '''Required'''.
* device_id - Device ID in MOR database, to be assigned for specified DID '''Required'''.
** device_id - Device ID in MOR database, to be assigned for specified DID '''Required'''.
* u - username for authentication. '''Required'''.
** u - username to login. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
** p - password to login. '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* Returns:
**Success
*** <status>Device assigned to DID</status>
** Errors:
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
*** <error>Don't be so smart</error> - Only Admin, Accountant or Reseller may use API.
*** <error>Device was not found</error> - Enter existing Device ID.
*** <error>Your are not authorized to use this Device</error> - Specified Device is not available to this user.
*** <error>You are not authorized to manage DIDs</error> - If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
*** <error>DID does not exist</error> - Enter existing DID number.
*** <error>Invalid DID specified</error> - Enter a valid (numeric) DID number.
*** <error>Your are not authorized to use this DID</error> - Specified DID is not available to this user.
*** <error>DID is terminated</error> - DID is terminated and cannot be used.
*** <error>DID is not free</error> - DID is being used in a Dial Plan or another Device is already assigned.
*** <error>Device was not assigned</error>
<br><br>
<br><br>
== Request ==
===Request===
 
We have device_id = 1, did=123456789, API Secret Key = secret
 
We send


http://123.123.123.123/billing/api/device_create/u=admin&p=password&did=123456789&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462
HTML POST: http://<SERVER_IP>/billing/api/did_device_assign?u=username&did=123456789&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462


*admin - owner's username
Now we can view these changes in GUI through DID edit.
*password - owner's password
 
*did - DID number
'''NOTE that username and password are not included in hash'''
*device_id - Device ID in MOR database, to be assigned for specified DID
<br><br>
<br><br>
----
===Returns===
*Example:
**We have device_id = 1, API Secret Key = secret
**Converted Hash string like "bc2f114099d16656d37e45fd9e8744cb9386d462"
*We send:
**http://123.123.123.123/billing/api/device_create/u=admin&p=password&did=123456789&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462
*We get:


            <page>
'''Success'''
                  <status>Device assigned to DID</status>
            </page>


*We send:
<?xml version="1.0" encoding="UTF-8"?>
**http://123.123.123.123/billing/api/device_create/u=admin&p=password&did=123456790&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462
<page>
*We get:
    <status>Device assigned to DID</status>
</page>
<br><br>
----


            <page>
'''Errors'''
                  <status>Device assigned to DID</status>
            </page>


*Now we can view these changes in GUI through DID edit.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Don't be so smart</error> - Only Admin, Accountant or Reseller may use API.
* <error>Device was not found</error> - Enter existing Device ID.
* <error>Your are not authorized to use this Device</error> - Specified Device is not available to this user.
* <error>You are not authorized to manage DIDs</error> - If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
* <error>DID does not exist</error> - Enter existing DID number.
* <error>Invalid DID specified</error> - Enter a valid (numeric) DID number.
* <error>Your are not authorized to use this DID</error> - Specified DID is not available to this user.
* <error>DID is terminated</error> - DID is terminated and cannot be used.
* <error>DID is not free</error> - DID is being used in a Dial Plan or another Device is already assigned.
* <error>Device was not assigned</error>
<br><br>
=See also=


'''* Note that username and password are not included in hash'''
* [[MOR API]]

Revision as of 09:59, 25 May 2013

Descriptiom

MOR API DID assign Device

Usage

  • Call: /api/did_device_assign
  • For Backwards-compatibility old name 'did_assignt_device' is also usable. Call: /api/did_assign_device
  • Methods: POST, GET(if allowed, not recomended)



Parametres

  • did - DID number where device have to be assigned. Required.
  • device_id - Device ID in MOR database, to be assigned for specified DID Required.
  • u - username for authentication. Required.
  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.



Request

We have device_id = 1, did=123456789, API Secret Key = secret

We send 

HTML POST: http://<SERVER_IP>/billing/api/did_device_assign?u=username&did=123456789&device_id=1&hash=bc2f114099d16656d37e45fd9e8744cb9386d462

Now we can view these changes in GUI through DID edit.

NOTE that username and password are not included in hash

Returns

Success 

<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>Device assigned to DID</status>
</page>



Errors

  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Don't be so smart</error> - Only Admin, Accountant or Reseller may use API.
  • <error>Device was not found</error> - Enter existing Device ID.
  • <error>Your are not authorized to use this Device</error> - Specified Device is not available to this user.
  • <error>You are not authorized to manage DIDs</error> - If Accountant or Reseller is using API, they should have all permissions to perform specified actions.
  • <error>DID does not exist</error> - Enter existing DID number.
  • <error>Invalid DID specified</error> - Enter a valid (numeric) DID number.
  • <error>Your are not authorized to use this DID</error> - Specified DID is not available to this user.
  • <error>DID is terminated</error> - DID is terminated and cannot be used.
  • <error>DID is not free</error> - DID is being used in a Dial Plan or another Device is already assigned.
  • <error>Device was not assigned</error>



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_did_device_assign&oldid=15668"