This is an old revision of the document!

====== How to Import the Customers' Information Via API ====== ===== Interface Prototype ===== importWS(orgidentity,usertype,user,pwdtype,password,modeltype,model_id,source,context,source_user,source_pwd,exetime,delrow,phone_field,priority_field,dialtime_field,emptyagent, resetstatus,dupway,dupdiallist,changepackage) ===== Function of ImportWS ===== Import the data of customers's information into Campaigns for Predictive-Dial. ===== Instructions of Parameters ===== <WRAP column 15%> **Parameter Name** </WRAP> <WRAP column 7%> **Type** </WRAP> <WRAP column 70%> **Description** </WRAP> <WRAP column 9%> * orgidentity * usertype * user * pwdtype * password * modeltype * model_id * source </WRAP> <WRAP column 7%> * String * String * String * String * String * String * String * String </WRAP> <WRAP column 79%> * Identity of the team * agent / account * Agent No. / User Name * Type of Password：plaintext / MD5 * password * Campaign * ID of Campaigns * The Sources of data which to be imported： - **data**,the instant data，it is one data at a time，format:field 1=value 1||field 2=value 2||…..||field N=value N， eg：Name=CustomerA||phone1=138xxxx88x8 . - **http**,use the .csv format file of via http . - **ftp**,use the .csv format file of via ftp . </WRAP> <WRAP column 9%> * context </WRAP> <WRAP column 7%> * String </WRAP> <WRAP column 79%> * Refer to the parameter of Source: - When source is **data**，you should put the contents of data which to be imported，eg：Name=CustomerA||phone1=138xxxx88x8，and || is separator，"Name" is "Display As" in locale,phone1 is field name of table in database. - When source is **http**，endue the http site of obtaining for .csv file，eg：http://192.168.1.88/xxx.csv . - When source is **ftp**，endow the ftp site of obtaining for .csv file，eg：http://192.168.1.88/xxx.csv . </WRAP> <WRAP column 9%> * source_user * source_pwd * exetime * delrow, * phone_field * priority_field * dialtime_field * emptyagent * resetstatus * dupway * dupdiallist </WRAP> <WRAP column 7%> * String * String * String * String * String * String * String * String * String * String * String </WRAP> <WRAP column 79%> * When source=http or ftp，you should set the name to it if there is a user's name when login the file's server，otherwise "source_user" is ‘’. * When source=http or ftp，you should set the password to it if the user's name have password，otherwise "source_pwd" is ‘’. * When source=http or ftp，you can set the execution time of importing task here. It means that excute the importing task immediately when it is equal to "NULL" or "0000-00-00 00:00:00". * Fill a number (N)，means import the data after deleting first N lines.Generally speaking，we usually delete the first line because of it is title not the customer data.It is worked only when "source" is http or ftp. * It should appoint the phone number field to "Pre dialing phone field" when you import the data into pre-dialer at the same time.eg：phone1 or Contact1 * The field name of "Dialer Priority". * The field name of "Dialer Schedule". * When customer data which to be imported has existed in customer packages，whether（yes / no) reset "Agent No." when importing into pre-dial lists. * When customer data which to be imported has existed in customer packages，whether（yes / no) reset "Customer Status" when importing customer data. * When customer data which to be imported has existed in customer packages，whether（update / skip) modify "Customer Details" with data in importing file. * If customer data which to be imported has existed in customer packages，there are three treatments of importing into pre-dial lists： - **ignoreDuplicate**，the data not allowed to imported into pre-dial lists. - **all**，the data must be imported into pre-dial lists anyway. - **ignoreSuccess**，ignore the duplication，the data will be imported only if the status isn't "Success Submit". </WRAP> <WRAP column 9%> * changepackage </WRAP> <WRAP column 7%> * String </WRAP> <WRAP column 79%> * 如果目标客户包使用的是总表客户，并且待导入数据已存在于数据表。 - **skip**()，不处理此类数据。 - **unassignToCurrent**()，如果此客户未分配至其它客户包，那么将此客户分配至当前客户包。 - **reassignToCurrent**()，如果客户已分配至其它客户包，系统会将此用户转移至当前客户包。 </WRAP> <note important> All parameters must not be omitted, when there is null value, use an empty argument to supplant.eg：If "phone_field，priority_field and dialtime_field" are null，we should set parameters as follows：importWS(orgidentity,usertype,user,pwdtype,password,modeltype, model_id,source,context,source_user,source_pwd,exetime,delrow,‘’,‘’,‘’,emptyagent,resetstatus,dupway,dupdiallist,changepackage) </note> ===== Return Values ===== Format of Return Value：|Retuen|code|Retuen|message Type of Return Value：String <WRAP column 20%> **Return Value** </WRAP> <WRAP column 75%> **Description** </WRAP> <WRAP column 20%> * |Retuen|1|Retuen|message * |Retuen|2|Retuen|message </WRAP> <WRAP column 75%> * |Retuen|Success|Retuen|import by http or ftp (when issource=http or ftp)，here is Import Jobs' ID. Otherwise it will return "Success" tip (when "source=data) * |Retuen|Failed|Retuen|Description </WRAP>