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

Parameter Name

Type

Description

  • orgidentity
  • usertype
  • user
  • pwdtype
  • password
  • modeltype
  • model_id
  • source
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • 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:
  1. 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 .
  2. http,use the .csv format file of via http .
  3. ftp,use the .csv format file of via ftp .
  • context
  • String
  • Refer to the parameter of Source:
  1. 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.
  2. When source is http,endue the http site of obtaining for .csv file,eg:http://192.168.1.88/xxx.csv .
  3. When source is ftp,endow the ftp site of obtaining for .csv file,eg:http://192.168.1.88/xxx.csv .
  • source_user
  • source_pwd
  • exetime
  • delrow,
  • phone_field
  • priority_field
  • dialtime_field
  • emptyagent
  • resetstatus
  • dupway
  • dupdiallist
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • String
  • 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:
  1. ignoreDuplicate,the data not allowed to imported into pre-dial lists.
  2. all,the data must be imported into pre-dial lists anyway.
  3. ignoreSuccess,ignore the duplication,the data will be imported only if the status isn't “Success Submit”.
  • changepackage
  • String
  • When the customer package of campaign use “Main Table” and the data which to be imported has existed in customer packages,there are three treatments when importing the data:
  1. skip(),doing nothing。
  2. unassignToCurrent(),assign the customer into current package if it belong no package.
  3. reassignToCurrent(),move the customer into current package if it has belong to other package.

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)

Return Values

Format of Return Value:|Retuen|code|Retuen|message

Type of Return Value:String

Return Value

Description

  • |Retuen|1|Retuen|message
  • |Retuen|2|Retuen|message
  • |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
en/custom_development_guide/how_to_import_the_customers_information_via_api.txt · Last modified: 2016/01/30 12:39 by liuxl
Recent changes RSS feed Debian Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki