Language

Italiano English Fran├žais

RavenWeb API - Reseller

Sending of SMS

The URL format which resellers must refer to for the sending procedures described above is shown below.

The sending specifications remain unaltered.

For the complete sending specifications please refer to RavenWeb API

Reference URL: http://virtualhost/raven/sms/send

Backoffice

Parameters common to every action

  • login

Login for reseller account

  • password

Password for reseller account

  • action

Action to be given to the backoffice

Add a new customer

Reference action (action parameter) : customer-add

Example:

http://virtualhost/raven/backoffice/manager?action=customer-add&login=LOGIN&password=PASSWORD

                    &cust_login=loginCustomer&cust_password=passCustomer

Parameters

  • cust_login

Login for the new customer

  • cust_password

Password for the new customer

  • timezone

Reference time zone for the new customer.

The default time zone is Europe/Rome

  • netblock

IP address for authentication, one or several IP addresses (or networks of addresses in the format 0.0.0.0/0) which are comma-separated.

  • currency

Reference currency for the customer.

Possible values: EUR, USD, GBP, CAD, AUD, CHF, HKD, JPY. The default value is EUR

  • reseller

If the reseller who is accessing the backoffice has permissions to create further resellers then this parameter can be given one of the following values:

  • 0

The account will not be a reseller account but a customer account

  • 1

The account will be able to create further sub-accounts but will not have permissions to create price lists. (Option not enabled in this version.)

  • 2

The account will be a Silver reseller account

  • 3

The account will be a Gold reseller account

Response

The gateway will respond by forwarding an XML structure of this type:

  • Success
 

        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

           <result>

            <backoffice>

               <object type="add-response">

                  <status>OK</status>

                  <user_id>1111</user_id>

               </object>

           </backoffice>

          </result>

         </xml>
  • Error
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Messaggio</message></error>

         </xml>

Add contacts for a new customer

Reference action (parametro action) : customer-add-contacts

Example:

http://virtualhost/raven/backoffice/manager?action=customer-add-contacts&login=LOGIN&password=PASSWORD

               &user_id=1111&name=NOME&surname=COGNOME&email_tech=EMAILT&email_admin=EMAILA

Parameters

  • user_id

Unique ID of the customer previously created

  • name

Name of the customer

  • surname

Surname of the customer

  • company

Company Name

  • email_tech

Technical contact for the customer

  • email_admin

Administrative contact for the customer

  • mobile

Mobile phone number for the customer

Response

  • Success
        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml><result>

           <backoffice>

               <object type="add-response">

                     <status>OK</status>

                    <user_id>1111</user_id>

               </object>

           </backoffice>

          </result></xml>
  • Error
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Messaggio</message></error>

         </xml>

Add credit

Reference action (parametro action) : customer-add-credit

Example:

http://virtualhost/raven/backoffice/manager?action=customer-add-credit&login=LOGIN

           &password=PASSWORD&user_id=1111&pl_id=20&credit=100000

Parameters

  • user_id

Unique ID for the customer.

  • pl_id

Unique ID for the SMS price list. The price list must previously have been manually created by the reseller through the management interface.

The price list will contain the cost of each single message for the destination country.

  • credit

Credit to be added. The value of credit must be expressed in ten-thousandths of Euros.

Example: 10.00 Euros must be converted into 100000.

Response

  • Success
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml><result>

   <backoffice>

        <object type="add-credit-response">

              <status>OK</status>

             <user_id>1111</user_id>

        </object>

   </backoffice>

   </result></xml>
  • Error
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml>

        <error><code>NN<\/code><message>Messaggio</message></error>

  </xml>

Modify user password

Reference action (parametro action) : password-mod

Example:

http://virtualhost/raven/backoffice/manager?action=mod-password&login=LOGIN

          &password=PASSWORD&user_id=1111&cust_password=NUOVAPASS

Parameters

  • user_id

Unique ID for the customer.

  • cust_password

New password to be assigned.

Note: the system will not perform any check on the content of the password.

  • random

Possible values: 0 (disabled) 1 (enabled). Enabling the random mode will cause the system to automatically generate a random password of 8 characters.

Response

  • Success
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml><result>

   <backoffice>

        <object type="password-mod-response">

              <status>OK</status>

             <user_id>1111</user_id>

             <password>NUOVAPASS</password>

        </object>

   </backoffice>

   </result></xml>
  • Error
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml>

        <error><code>NN<\/code><message>Messaggio</message></error>

  </xml>

Enable and disable an account

Reference action (parametro action) : customer-block

Example:

http://virtualhost/raven/backoffice/manager?action=customer-block&login=LOGIN&password=PASSWORD

                                &user_id=1111&enabled=0

Parameters

  • user_id

Unique ID for the customer.

  • enabled

Status of the account. Possible values: 0 (disabled) 1 (enabled)

Setting a 0 value will cause the account to be disabled. If 1 is assigned, the account will be enabled and have access to the platform.

Response

  • Success
        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml><result>

           <backoffice>

               <object type="customer-block-response">

                     <status>OK</status>

                    <user_id>1111</user_id>

               </object>

           </backoffice>

          </result></xml>
  • Error
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Messaggio</message></error>

         </xml>

List of Errors

ERR 42 Error wrong user_id [not your customer]

ERR 43 Error while adding customer contacts

ERR 43 Error while adding credit

ravenweb_api_rivenditore_en.txt · Last modified: 2012/02/14 16:40 (external edit)
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki