Skip Navigation Links.
展开 最小化

SpreadWebServcie.UploadContactListFile Method

Upload contact list file

Parameters

Parameter

Type

Description

loginEmail

String

The login email of your Spread account.

loginPassword

String

The password of your Spread account or API Key which you can retrieve from your Spread account (My account=> Settings).

fileType

String

Type of upload data, include ".xls", ".csv", ".xlsx".

myFileStream

base64Binary

The upload file stream ( length<100MB ). Template File

ContactListName

String

The name of contact list.

Return Value

String or Exception. if Uploaded successfully,return String:Spread has received your data and will send you an email after upload complete. (RequestID:AAAABBBB-CCCC-DDDD-EEEE-FFFFGGGGHHHH)

Status/Situation

Retrun Type

HTTP status code

Retrun Message

Success

String

200

Spread has received your data and will send you an email after upload complete. (RequestID:AAAABBBB-CCCC-DDDD-EEEE-FFFFGGGGHHHH)

If you call API with error account or API Key.
If you call API with a not existed subscription.
Exception 500

Return a exception with message 'Contact List "SubscriptionName" does not exist!'.

If you upload a file with other type, e.g. *.jpg, *.doc or others. Exception 500

Return a exception with message 'File extensions is not allowed. (Extensions Allowed: .csv|.xls|.xlsx)'.

The other situations Exception 500

Return a exception with message 'Upload failed. ' and more information about error.

Example

string loginEmail = "Spread@reasonables.com";

string loginPassword = "TEST0000-TEST-0000-TEST-0000TEST0000";

System.IO.FileStream fileStream = new System.IO.FileStream(@"D:\content1.xlsx", System.IO.FileMode.Open);

byte[] arrayByte = new byte[fileStream.Length];

fileStream.Read(arrayByte, 0, Convert.ToInt32(fileStream.Length));

fileStream.Close();

SpreadAPI.SpreadWebService MySpread = new SpreadAPI.SpreadWebService();

string result = MySpread.UploadContactListFile(loginEmail, loginPassword, ".xlsx", arrayByte, "test 20130204");

Dim loginEmail As String = "Spread@reasonables.com"

Dim loginPassword As String = "TEST0000-TEST-0000-TEST-0000TEST0000"

Dim fileStream As New System.IO.FileStream("D:\content1.xlsx", IO.FileMode.Open)

Dim arrayByte = New Byte(fileStream.Length - 1) {}

fileStream.Read(arrayByte, 0, fileStream.Length)

fileStream.Close()

Dim MySpread As New SpreadAPI.SpreadWebService()

Dim result As String = MySpread.UploadContactListFile(loginEmail, loginPassword, ".xlsx", arrayByte, "test 20130204")

/**
* @name     uploadContactListFile
* @function add multi email receivers
* @param
*  optInType  'Off'
*  (fiel import)
*		$data = the absolute path of file
* @return
*	errorMsg	failed information
*  Msg			success information
*/

public function uploadContactListFile($loginEmail,$password,$listName,$data ){
	    $fileContent = file_get_contents( $data );
            $fileName = array_pop( explode( '/', $data ) );
            $fileExt = array_pop( explode( '.', $fileName ) );
	    $addInArr = array(
			    'loginEmail'	    => $loginEmail,
			    'loginPassword'	    => $password,
			    'fileType'	            => '.'.$fileExt,
			    'myFileStream'	    => $fileContent,
			    'ContactListName'       => $listName
			    );
	    $Client = new SoapClient("http://service.rspread.com/Service.asmx?WSDL");		
	    $Client -> soap_defencoding = 'utf-8';
	    $Client -> decode_utf8 = false;
	    $Client -> xml_encoding = 'utf-8';
            return $Client -> UploadContactListFile( $addInArr );
}
POST {{YOUR_API_URL}}/service.asmx 

Content-Type: application/soap+xml; charset=utf-8
Content-Length: {{length}}

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadContactListFile xmlns="http://service.reasonablespread.com/">
      <loginEmail>Spread@reasonables.com</loginEmail>
      <loginPassword>TEST0000-TEST-0000-TEST-0000TEST0000</loginPassword>
      <fileType>.csv</fileType>
      <myFileStream>base64Binary</myFileStream>
      <ContactListName>test 20130204</ContactListName>
    </UploadContactListFile>
  </soap12:Body>
</soap12:Envelope>