MOR API card by cli update

From Kolmisoft Wiki
Revision as of 09:22, 31 January 2012 by Admin (talk | contribs)
Jump to navigationJump to search

'This functionality is available from MOR 12


MOR API

Create and update calling cards, including adding and transferring funds, by being identified according the Caller_ID.






  • Call: /api/cc_by_cli
  • Methods: POST, GET(if allowed, not recomended)
  • Params:
    • calleridid - Caller ID in MOR database, whose credit notes we want to see. Required.
    • amount - amount to transfer to calling card.
    • pin - pin of calling card, if specified amount would be ignored.
    • cardgroup_id - cardgroup ID in MOR database.
    • u - username to login. Required.
    • p - password to login. Required.
    • hash - SHA1 hash constructed using user_id, pin, callerid, and API_Secret_Key ( More described in Constructing hash). Required.
  • Returns:
    • Success
      • <status>
      • ok
      • </status>
      • <card>
      • <id></id>
      • <cardgroup_id></cardgroup_id>
      • <balance></balance>
      • <callerid></callerid>
      • <pin></pin>
      • <number></number>
      • </card>

Note that user has to be owner of cardgroup that id is supplied.

    • Errors:
      • <error>Bad login</error> - User supplied bad login or password.
      • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
      • <error>Supplied Cardgroup_id is invalid</error> - user is not the owner of cardgroup or there is no cardgroup at all.
      • <error>Failed to make transaction</error> - Something went wrong and transaction could not be completed.
      • <error>Card was not found</error> - Card with specified callerid was not found
      • <error>Callerid belongs to provider</error> - callerid belongs to provider and you cannot change that using this api method.
      • <error>Device allready have such callerid, but you do not have permission to change user's balance</error> - if device with specified callerid was found but device's user A is owned by some user B, you cannot change A's balance.




  • Example:
      • /api/cc_by_cli?u=user&p=user1&callerid=123&cardgroup=3&amount=100&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
      • /api/cc_by_cli?u=user&p=user1&callerid=123&cardgroup=3&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
      • /api/cc_by_cli?u=user&p=user1&callerid=123&cardgroup=3&pin=321&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

* Note that username and password are not included in hash