Import lead

POST https://host:port/api/cacs/v1/import_lead

Headers

Name
Type
Description

Content-Type*

String

Application/json

access_token*

String

Cung cấp bởi CloudPBX (Provided by CloudPBX)

{
	“result”: “success”,
	“message”: “<number of success/total import> leads were imported”
}s

Example:

{
	“result”: “success”,
	“message”:1 leads were imported”
}

Body request

{
“campaign_key”:  “<campaign_key>”,   
“data”:[
{	
     		“phone_number”: “<phone_number>”,
		“name”:  “<name>”,
		“contact_name”:  “<contact_name>”,
      		“company”:  “<company>”,
      		“email”:  “<email>”,
       		“address”: “<address>”,
		“ref_id”: “<reference_id>”,
		“field01”: “<field01>”,
		“field02”: “<field02>”,
		“field03”: “<field03>”,
		“field04”: “<field04>”,
		“field05”: “<field05>”,
		“field06”: “<field06>”,  
		“field07”: “<field07>”,
		“field08”: “<field08>”,
		“field09”: “<field09>”,
		“field10”: “<field10>”,
},
{ …}
]
} 

Tham số (Parameters):

Tham số (Parameters)
Kiểu (Type)
Mô tả (Description)

access_token(*)

Chuỗi, tối đa 50 ký tự (String, max. 50 character)

  • Thông tin xác thực giữa CloudPBX và Khách hàng, cung cấp bởi CloudPbx (Authentication information between CloudPBX and Customer, provided by CloudPBX)

campaign_key(*)

Chuỗi, tối đa 32 ký tự (String, max. 32 character)

  • Mã chiến dịch, bắt buộc, cung cấp bởi Cloudpbx (Campaign key, required, provided by CloudPBX)

data(*)

Mảng (array)

  • Mảng chứa danh sách cần import ( An array containing the list to import)

phone_number(*)

Số, tối đa 25 ký tự

(Number, max. 25 character)

  • Số điện thoại của khách hàng, phải là số từ 0-9, bắt buộc (Phone number of customer, is number, required, [0-9] are accepted)

  • Định dạng (Format): 0xxxxxxxxx

Ví dụ (Ex): 0961234567

name

Chuỗi, tối đa 100 ký tự (String, max. 100 character)

  • Tên khách hàng, trường không bắt buộc (Lead name, value is not required)

contact_name

Chuỗi, tối đa 50 ký tự (String, max. 50 character)

  • Tên liên hệ, trường không bắt buộc (Contact name, value is not required)

company

Chuỗi, tối đa 100 ký tự (String, max. 100 character)

  • Tên công ty khách hàng, trường không bắt buộc (Company of lead, value is not required)

email

Chuỗi, tối đa 50 ký tự (String, max. 50 character)

  • Email của khách hàng, trường không bắt buộc (Email of lead, value is not required)

address

Chuỗi, tối đa 100 ký tự (String, max. 100 character)

  • Địa chỉ khách hàng, trường không bắt buộc (Address of lead, value is not required)

home_phone

Chuỗi, tối đa 25 ký tự (String, max. 25 character)

  • Số điện thoại bàn khách hàng, trường không bắt buộc (Desk phone number of lead, is number, value is not required)

  • Định dạng (Format): 028xxxxxxxxx

  • Ví dụ (Ex): 0287961234

ref_id

Chuỗi, tối đa 32 ký tự (String, max. 32 character)

  • Mã định danh khách hàng, trường không bắt buộc (Reference id, value is not required)

field01, field02, field03, field04, field05, field06, field07, field08, field09, field10

Chuỗi, tối đa 100 ký tự (String, max. 100 character)

  • Các tham số, trường không bắt buộc (Parametters, value is not required)

Errors list (danh sách lỗi)

Tham số (Parameter)
Không khai báo (Not declared)
Thông tin chưa chính xác (Incorect information)

access_token

“Missing header #access_token#. Please check it again”

campaign_key

“Missing parameter #campaign_key#. Please check it again”

“Parameter #campaign_key# does not match. Please check it again”

data

“Parameter #data# is wrong format. Please check it again”

phone_number

“Parameter #phone_number# is wrong format. Please check it again

Last updated