StingRay Firmware » Firmware 3.0.2

ID #1113

How to send a file as a hyperlink using StingRay SDK

As of 3.0.2, you can now use the StingRay SDK to send hyperlink jobs via a Quicksend module - something only previously possible through the Mac StingRay Client. You can use this feature to send files on an automated basis.

Note: The Quicksend module of the SDK requires a license before it can be used which can be obtained through Pro2col Sales.

Prerequisites for automating the Quicksend module are as follows:

  • A local user with internal dataserver access granted
  • wget or an alternative installed to "pull" files to your local machine
  • A command-line utility for parsing XML
  • ftp to push files to the StingRay

 

First, log in with the username and password of an internal user with "internal dataserver access" granted to open the connection to the StingRay:

  • http://stingray.internal.ip/stingray_sdk.jsp?sdk_type=login&action=login&username=USERNAME&password=PASSWORD

Next, using the below link you will request the SDK prepares for data upload. Issuing this command will pull an XML file from the StingRay. This XML file will hold a Job ID and will be required when completing the script:

  • http://stingray.internal.ip/stingray_sdk.jsp?sdk_type=jobs&action=create_init_quicksend&receiver_email_address=EMAIL ADDRESS TO SEND JOB TO&set_user_home=1&origin=1&subject=SUBJECT OF EMAIL

You need to note the job ID which is passed back. Using a parsing command you can obtain the job ID from the XML file based on the tag <newjobid>.

When you have the Job ID, login via FTP with the same username and password you used with the first command. You are automatically logged into the directory required to upload the file to, meaning no more addressess/address name/outgoing/.. etc!

After this, send a command requesting the SDK finishes and sends the job. In this command, you must manually specify how many files/folders were uploaded via FTP, the size in bytes of the finished upload and the Job ID you obtained from parsing the XML file:

  • http://stingray.internal.ip/stingray_sdk.jsp?sdk_type=jobs&action=create_finish&expand=0&size=123&files=1&folders=0&job_id=JOB_ID PARSED

Finally, you must log off to allow the StingRay to process the job:

  • http://stingray.internal.ip/stingray_sdk.jsp?sdk_type=login&action=logoff

 

If you require assistance, please contact support.

Tags: qs, quicksend, sdk

Related entries:

Last update: 2011-07-29 13:36
Author: Jason Bayton
Revision: 1.0

Digg it! Share on Facebook Print this record Send FAQ to a friend Show this as PDF file
Propose a translation for Propose a translation for
Please rate this FAQ:

Average rating: 0 (0 Votes)

completely useless 1 2 3 4 5 most valuable

You cannot comment on this entry