SAAS saas_plat openapi customer_query

查询客户

查询客户

• URL：https://api.nxcloud.com/saas/cdp/openapi/customers/query
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名 查看公共约定

body参数：

参数名	类型	必选	示例值	说明
tenant_id	integer	是	123	租户id
app_key	string	是	46oKF=os	appkey
start_time	string	否	2024-05-07 00:00:00	开始时间
end_time	string	否	2024-05-08 00:00:00	结束时间
tags	List	否	[1,2,3]	标签id
source_type	Integer	否	1	来源 0: 未知, 1: 新增, 2: excel导入, 3: 客户主动发起, 4: 短信群发, 5: 语音群发, 6: 第三方API, 7: callbot, 8: 客户发起-呼叫中心, 9: 邮箱渠道, 10: 表单新增, 11: 客户主动发起, 12: 客户发起-Viber, 13: 客户发起-Messenger, 14: 客户发起-Instagram, 15: 客户发起-Line
name	string	否	test	first_name
tags_logic_type	string	否	and	tags列表逻辑类型。"and",且; "or",或; 不选择时传空串""
source_channel_key	string	否	xx	来源通道
sms_phone	string	否	8618593272678	手机号
whatsApp_phone	string	否	8618593272678	WhatsApp手机号码
email	string	否	[email protected]	email
viber_phone	string	否	8618593272678	viber
after	Long	否	693324	向后分页游标值
before	Long	否	693324	向前分页游标值
limit	Long	是	25	每页大小，范围1-50

消息类型

• customers参数：

参数名	类型	必选	示例值	说明
full_name	String	是	-	full Name最大长度为128字符
sms_phone	String	否	-	手机号码最大长度为30字符
whats_app_phone	String	否	-	WhatsApp最大长度为30字符
viber_phone	String	否	-	viber phone最大长度为30字符
messenger	String	否	-	messenger最大长度为30字符
instagram	String	否	-	instagram最大长度为30字符
line	String	否	-	line最大长度为50字符
country	String	否	-	国家 最大长度为50字符
email	String	否	-	邮箱最大长度为50字符
address	String	否	-	街道最大长度为100字符
birthday	String	否	-	生日 yyyy-MM-dd
tagStr	String	否	-	标签
remark	String	否	-	remark 最大长度100个字符
time_zone	String	否	-	时区
gender	integer	否	-	性别,1男, 0 女
customize_field	String	否	-	自定义字段数据
belong_seat_user	String	否	-	归属坐席最大长度为128字符

请求示例

批量发送请求示例

body（application/json） 参数：

{
    "tenant_id": 123,
    "limit": 5,
    "after": 1022100838976413697,
    "whatsApp_phone": "861360301975912",
    "app_key": "8eos"
}

响应参数

参数名	类型	说明
code	Integer	结果编码
data	JsonObject	请求结果
message	String	请求结果说明
traceId	String	链路追踪ID

响应示例

成功示例

{
	"code": 0,
	"message": "",
	"data": {
		"customerList": [{
			"id": 1021110718827683840,
			"userId": null,
			"userPhone": null,
			"firstName": "Simon",
			"lastName": null,
			"fullName": "Simon",
			"smsPhone": null,
			"whatsAppPhone": "861360301975222",
			"vberPhone": null,
			"line": null,
			"messenger": null,
			"instagram": null,
			"email": null,
			"seatUserId": null,
			"country": "CN",
			"birthday": null,
			"remark": null,
			"sourceType": 3,
			"sourceChannelKey": "18506002222",
			"timeZone": null,
			"gender": null,
			"createdAt": "2024-07-19T17:29:27",
			"status": 1,
			"updatedAt": "2024-07-30T17:56:39",
			"tags": [{
				"id": 27237,
				"userId": 195,
				"tenantId": 123,
				"groupId": 0,
				"groupName": null,
				"tagName": "test",
				"note": "",
				"createdAt": "2023-02-15T16:45:30",
				"updatedAt": "2023-02-15T16:45:30",
				"customerId": 1021110718827683840
			}],
			"hisTags": null,
			"whatAppSubscribe": "1",
			"smsSubscribe": "1",
			"customizeField": "{\"customize_4_52\": [\"1\"]}",
			"tenantId": 123,
			"weight": 5,
			"customerFieldMap": null
		}],
		"paging": {
			"after": 1021110718827683840,
			"before": 1021110718827683840,
			"previous": null,
			"next": null
		}
	},
	"traceId": "aaa28078f6924efa8716b408c8e9b12e.329.17243019918820021"
}