-
Notifications
You must be signed in to change notification settings - Fork 6
SAAS saas_plat openapi customer_query
zjc1750514326 edited this page Oct 29, 2024
·
6 revisions
查询客户
- URL:
https://api.nxcloud.com/saas/cdp/openapi/customers/query
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
accessKey | String | 是 | fme2na3kdi3ki | 用户身份标识 |
ts | String | 是 | 1655710885431 | 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType | String | 是 | 2 | WhatsApp业务类型,取固定值“2” |
action | String | 是 | mt | WhatsApp业务操作,取固定值“mt” |
sign | String | 是 | 6e9506557d1f289501d333ee2c365826 | API入参参数签名 查看公共约定 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
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 | array[data JsonObject] | 否 | 标签id | |
his_tags | array[data JsonObject] | 否 | 历史标签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手机号码 |
string | 否 | [email protected] | ||
viber_phone | string | 否 | 8618593272678 | viber |
after | Long | 否 | 693324 | 向后分页游标值 |
before | Long | 否 | 693324 | 向前分页游标值 |
limit | Long | 是 | 25 | 每页大小,范围1-50 |
- data 参数:
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
id | Long | 是 | - | 标签id |
tag_name | String | 是 | - | 标签名称 |
- paging参数:
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
after | Long | 是 | - | 这是指向已返回的数据页面末尾的游标。 |
before | Long | 是 | - | 这是指向已返回的数据页面开头的游标。 |
previous | Long | 否 | - | 上一页数据的开始游标。如果为null,则显示的是第一页数据 |
next | Long | 否 | - | 下一页数据的开始游标。如果为null,则显示的是最后一页数据 |
- customers参数:
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
id | Long | 是 | 1021110718827683840 | 客户id,游标值 |
first_name | String | 否 | simon | 姓 |
last_name | String | 否 | kang | 名 |
full_name | String | 否 | simon kang | 姓名 |
sms_phone | String | 否 | 8618593271111 | 短信手机号 |
whatsApp_phone | String | 否 | 8618593271111 | whatsApp_phone手机号 |
viber_phone | String | 否 | 8618593271111 | viber_phone手机号 |
line | String | 否 | xxx | line号 |
messenger | String | 否 | xxx | messenger号 |
String | 否 | xxx | instagram号 | |
String | 否 | xxx | 邮箱 | |
country | String | 否 | CN | 国家 |
birthday | String | 否 | 2024-08-01 | 生日 |
remark | String | 否 | xxx | 备注 |
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 |
source_channel_key | string | 否 | xx | 来源通道 |
gender | Integer | 否 | 0 | 0 女 1 男 |
created_at | String | 是 | 2024-07-19T17:29:27 | 创建时间 |
updated_at | String | 是 | 2024-07-19T17:29:27 | 更新时间 |
status | Integer | 否 | 1 | 状态(0禁用、1启用) |
whatApp_subscribe | String | 否 | 1 | 是否订阅whatsApp |
sms_subscribe | String | 否 | 1 | 是否订阅sms |
customize_field | String | 否 | 1 | 自定义字段 |
tenant_id | Long | 是 | 1 | 所属租户 |
weight | Long | 否 | 1 | 客户等级 |
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": null,
"traceId": "44988d9de672422b920182d6960de0a0",
"data": {
"paging": {
"after": 1021110718827683840,
"before": 1021110718827683840,
"previous": null,
"next": null
},
"customer_list": [
{
"id": 1021110718827683840,
"first_name": "Simon",
"last_name": null,
"full_name": "Simon",
"sms_phone": null,
"whatsApp_phone": "861360301975912",
"viber_phone": null,
"line": null,
"messenger": null,
"instagram": null,
"email": null,
"country": "CN",
"birthday": null,
"remark": null,
"source_type": 3,
"source_channel_key": "18506008399",
"gender": null,
"created_at": "2024-07-19T17:29:27",
"status": 1,
"updated_at": "2024-07-30T17:56:39",
"tags": [
{
"id": 27237,
"user_id": 195,
"tenant_id": 123,
"group_id": 0,
"group_name": null,
"tag_name": "test",
"note": "",
"created_at": "2023-02-15T16:45:30",
"updated_at": "2023-02-15T16:45:30",
"customer_id": 1021110718827683840
}
],
"whatApp_subscribe": "1",
"sms_subscribe": "1",
"customize_field": "{\"customize_4_52\": [\"1\"]}",
"tenant_id": 123,
"weight": 5
}
]
}
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent(对外api)