MBS_Service_WS_Services

WSDL
/**
 * WEB service for MBS services admistration tasks
 *
 * @package MBS
 * @subpackage Service
 * @author Valdas Petrulis 
 * @author Šarūnas Davalga 
 *

History of changes:

  • 2010-05-07 WEB service prototype created
  • 2010-05-11 Functions and parameters presented
  • 2010-06-19 Functions presented - keywordCheck(), keywordCreate(), keywordSunscriptionCreate(), serviceGet(), serviceDelete()
  • 2010-07-02 Functions presented - numberList(), priceList(), categoryList()
  • 2010-07-10 Functions presented - wapCreate(), wapSubscriptionCreate()
  • 2010-07-27 Stable version released (can create SMS keyword, SMS subscription, WAP billing, WAP subscription)
  • 2010-10-26 Possibility to notify service actions (activate, reject, comment, archive, operator_enable, operator_disable events) to your system URL
  • 2011-04-19 Changed keywordCreate, keywordEdit method signature, implemented method keywordEdit, presented new method keywordGetServiceId

Common errors:

ERROR_UNKNOWN = 1 Unknown function error ERROR_NOT_IMPLEMENTED = 2 Accessing not implemented function ERROR_PERMISSION_DENIED = 3 Accessing denied function, service, other object

Function parameters errors:

ERROR_INVALID_PARAMS = 20 Wrong arguments given ERROR_INVALID_COUNTRY = 21 Invalid country given (LT, LV etc.) ERROR_INVALID_LANGUAGE = 22 Invalid language given (LT, LV ir tt.) ERROR_INVALID_OPERATOR = 23 Invalid operator given (bite_lt, tele2_lv, etc.) ERROR_INVALID_SHORT_NUMBER = 24 Invalid short number given (1679, 1656, 1654, etc.) ERROR_INVALID_PRICE = 25 Invalid price given, price should be in cents (0, 30, 100, 200, etc.)

Service parameters errors:

ERROR_INVALID_SERVICE = 100 Invalid service given (does not exist, deleted) ERROR_INVALID_SERVICE_PARAMETER = 101 Invalid, unknown service parameter ERROR_RESERVED_KEYWORD = 102 Given keyword is already reserved ERROR_INVALID_SERVICE_CATEGORY = 103 Invalid service category given (1, 2, 3 etc.)

Service administration notifications:

This feature can be turned on by giving parameter 'notify_admin_url' when creating new service Notification message example: http://mbs.vero.lt/simple/notify_sms.php?id=1&service_id=1&event=reject&comment=rejected&s1=7b8f8abdd0cb19e1e6792c1cc0aa3b0036bf0936&s2=OsHCn0ekLg8RBduOPxO4ibSPTgfhBH2V3sPgOIcLQU%2FyHI27JCRrWXsCQD2PfK41AzIPG02CTe1sOpss7QJg7Lf4tA%2BvhFkZf1NRwcqZGYm2XS2cVlfzLiiAmsdZ5fCJhnrVYdl62fJ9JsD288WHLPzVbeP6auy2r9dO0MCpI7c%3D Notification message parameters: id Unique message id service_id Service id event Service action (activate, reject, comment, archive, operator_enable, operator_disable) comment If present - administrator or operator event comment s1 Lower security signature s2 Highest security signature Possible service events: activate Manager activated your service reject Manager rejected your service comment Your service was commented by manager or operator archive Manager deleted your service operator_enable One or several operators turned on your service operator_disable One or several operators turned off your service Notification messages are signed with security keys. More information available by downloading MBS documentation - http://www.veromobile.eu/en/manuals-download?manualId=30 Annex A – Security */
keywordCheck(country, number, keyword)
Checks if given keyword is available
keywordGetServiceId(country, number, keyword)
Get your owned service id for keyword If service not found - ERROR_INVALID_SERVICE will be thrown If service does not belong to the caller - ERROR_PERMISSION_DENIED will be thrown
keywordCreate(country, number, keyword, price, url, category_id, service_params=NULL, service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Create SMS keyword service.
keywordEdit(service_id, price=NULL, url=NULL, category_id=NULL, service_params=NULL, service_langs=NULL, price_exceptions=NULL, price_additional=NULL, partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Edit SMS keyword service.
keywordSubscriptionCreate(country, number, keyword_register, keyword_unregister, price, period, url, category_id, service_params=NULL, service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Create SMS keyword subscription service.
keywordSubscriptionEdit(service_id, price, period, url, category_id, service_params=array ( ), service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Edit SMS keyword subscription service. !not implemented!
wapCreate(country, name, price, url, category_id, service_params=NULL, service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Create WAP service.
wapEdit(service_id, name, price, url, category_id, service_params=array ( ), service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Edit WAP service. !not implemented!
wapSubscriptionCreate(country, name, price, period, url, category_id, service_params=array ( ), service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Create WAP subscription service.
wapSubscriptionEdit(service_id, name, price, period, url, category_id, service_params=array ( ), service_langs=array ( ), price_exceptions=array ( ), price_additional=array ( ), partner_service_certificate=NULL, partner_service_certificate_date=NULL)
Edit WAP subscription service. !not implemented!
serviceGet(id)
Retrieves MBS service
serviceDelete(service_id)
Delete MBS service
numberList(country)
Retrieve short numbers in given country
priceList(country, type)
Retrieve available prices in given country
categoryList(language='EN')
Retrieve service categories