MOR API device create

From Kolmisoft Wiki
Revision as of 14:13, 22 December 2011 by Admin (talk | contribs)
Jump to navigationJump to search

This functionality is available from MOR 11


MOR API Create device






  • Call: /api/device_create
  • Methods: POST, GET(if allowed, not recomended)
  • Params:
    • user_id - User ID in MOR database, for which user device should be created. Required.
    • u - username to login. Required.
    • p - password to login. Required.
    • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
    • description - string
    • pin - [number. ]. If pin param not send -> random_numbers . If blank -> pinless
    • type - Device type [SIP, IAX2, FAX, Virtual,H323, ZAP, Skype, ]. When is -> default device type. If default device type is empty -> 'SIP'
    • devicegroup_id - device group ID
  • Returns:
    • Success
      • <status>Device was created</status>
    • Errors:
      • <error>User was not found</error> - User was not found using user_id. Use correct user id.
      • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
      • <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
      • <error>Device_type_invalid</error> - Enter correct type.
      • <error>Device_group_invalid</error> - Device group with id not found. Enter group id.
      • <error>Pin_is_already_used</error> - Enter onother pin.
      • <error>Pin_must_be_numeric</error> - Enter correct pin.
      • <error>Device was not created</error>
        • <message>problem message</message>


Request

http://123.123.123.123/billing/api/device_create?u=admin&p=secret&user_id=4&hash=ceeaa7077d4c7a639933c9c8dffe99ed77082d11
  • admin - owner's username
  • secret - owner's password
  • user_id - for which user device should be created




  • Example:
    • We have user_id = 123, API Secret Key = 456789
    • Hash string to be converted: "123456789"
    • We send:
      • /api/device_create?u=admin&p=admin&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

* Note that username and password are not included in hash