Skip Navigation Links.
展开 最小化

SpreadWebServcie.UploadContactListFile Method

上传联系人数据文件.

参数

参数

类型

描述

loginEmail

String

Spread账号的登录邮箱.

loginPassword

String

Spread账号的登录密码或者API Key.

fileType

String

上传数据文件类型包括".xls", ".csv", ".xlsx".

myFileStream

base64Binary

上传数据文件流(小于100M). 上传文件模板

ContactListName

String

联系人名单的名称.

返回结果

String or Exception. 如果上传成功,返回String:Spread has received your data and will send you an email after upload complete. (RequestID:AAAABBBB-CCCC-DDDD-EEEE-FFFFGGGGHHHH).

状态/场景

返回类型

HTTP状态码

返回信息

成功上传联系人文件,且进行处理。

String

200

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

请求API时使用错误的账号或者API Key;
请求API时使用一个不存在的联系人名单名称。
Exception 500

返回异常含错误信息'Contact List "SubscriptionName" does not exist!'.

上传错误类型的文件,比如 *.jpg, *.doc 或者其它类型的文件。 Exception 500

返回异常含错误信息'File extensions is not allowed. (Extensions Allowed: .csv|.xls|.xlsx)'.

其他错误情况。 Exception 500

返回异常含错误信息 'Upload failed. ' 和其它关于错误的内容。

例子

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>