Difference between revisions of "MOR API Subscription Flat Rate Number Status Get"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 2: Line 2:
=Description=
=Description=


[[MOR API]] method for check prefix covering flat-rate subscriptions.
[[MOR API]] method for check prefix covering flat-rate subscriptions. API returns the result if that number (prefix covering this number) is included or excluded from the flat-rate subscriptions of that user.


Can be used by:
Can be used by:
Line 14: Line 14:
'''Partner'''  
'''Partner'''  
<br><br>
<br><br>
=Usage=
=Usage=



Revision as of 11:28, 1 March 2021

Description

MOR API method for check prefix covering flat-rate subscriptions. API returns the result if that number (prefix covering this number) is included or excluded from the flat-rate subscriptions of that user.

Can be used by:

Admin

Accountant with permissions Manage Services - write, Manage Subscriptions - read, Manage Users - read

Reseller

Partner

Usage

  • From MOR X16 call: /api/user_subscriptions_check_number_status
  • Methods: POST, GET(if allowed, not recomended)



Parameters

Parameters which are included into hash

  • user_id - required
  • number - required



Request

If API Secret Key = secret

You send:

HTML POST: http://<SERVER_IP>/billing/api/user_subscriptions_check_number_status?user_id=45&number=370666888666&hash=c420ef706a02e6449994b7575b25ef5f74cc722b



Returns

<page>
<status>
<number>37065</number>
<status>included</status>
</status>
</page>
<page>
<status>
<number>37065</number>
<status>excluded</status>
</status>
</page>


Errors:

  • <error>user_id must be non negative integer</error>
  • <error>user_id must be provided</error>
  • <error>Number must be provided</error>
  • <error>User was not found</error>
  • <error>User does not have any Flat-Rate subscriptions</error>


Example:

<page>
<status>
<error>User was not found</error>
</status>
</page>



See also