-
Notifications
You must be signed in to change notification settings - Fork 6
SAAS saas_plat openapi customer_fields
zjc1750514326 edited this page May 6, 2023
·
9 revisions
查询客户字段接口
- URL：
https://api.nxcloud.com/saas/cdp/openapi/customers/fields - Method：
get - 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 | 是 | Lfap8mE | appkey |
| is_preset | boolean | 否 | - | 非必须，true：系统预置，false：非系统预置，不传展示全部 |
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 结果编码 |
| data | array | 请求结果 |
| message | String | 请求结果说明 |
| traceId | String | 链路追踪ID |
- data array参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | Integer | id |
| tenantId | Integer | 租户id |
| name | String | 字段名称 |
| display_name | String | 显示名称 |
| display_en_name | String | 显示英文名称 |
| is_display | Boolean | 是否显示 |
| field_type | Integer | 字段类型 |
| required | Boolean | 是否必填 |
| sequence | String | 字段顺序 |
| remark | String | 备注 |
| field_type_info | String | 字段类型定义信息 |
| is_preset | Boolean | 是否系统预置 true：系统预置，false：非系统预置 |
{
"code": 0,
"message": "",
"data": [
{
"id": 4071,
"tenantId": 144,
"name": "first_name",
"required": false,
"sequence": 1,
"remark": null,
"display_name": "First Name",
"display_en_name": "First Name",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4072,
"tenantId": 144,
"name": "last_name",
"required": false,
"sequence": 2,
"remark": null,
"display_name": "Last Name",
"display_en_name": "Last Name",
"is_display": false,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4073,
"tenantId": 144,
"name": "sms_phone",
"required": false,
"sequence": 3,
"remark": null,
"display_name": "手机号码",
"display_en_name": "Phone Number",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4074,
"tenantId": 144,
"name": "whats_app_phone",
"required": false,
"sequence": 4,
"remark": null,
"display_name": "WhatsApp",
"display_en_name": "WhatsApp",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4075,
"tenantId": 144,
"name": "email",
"required": false,
"sequence": 5,
"remark": null,
"display_name": "邮箱",
"display_en_name": "Email",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4076,
"tenantId": 144,
"name": "tags",
"required": false,
"sequence": 6,
"remark": null,
"display_name": "标签",
"display_en_name": "Tag",
"is_display": true,
"field_type": 7,
"field_type_info": null,
"is_preset": true
},
{
"id": 4077,
"tenantId": 144,
"name": "created_at",
"required": false,
"sequence": 7,
"remark": null,
"display_name": "创建时间",
"display_en_name": "Updated at",
"is_display": true,
"field_type": 6,
"field_type_info": "{\"formatter\": \"yyyy-MM-dd HH:mm:ss\"}",
"is_preset": true
},
{
"id": 4078,
"tenantId": 144,
"name": "updated_at",
"required": false,
"sequence": 8,
"remark": null,
"display_name": "更新时间",
"display_en_name": "Created at",
"is_display": true,
"field_type": 6,
"field_type_info": "{\"formatter\": \"yyyy-MM-dd HH:mm:ss\"}",
"is_preset": true
},
{
"id": 4079,
"tenantId": 144,
"name": "country",
"required": false,
"sequence": 9,
"remark": null,
"display_name": "国家",
"display_en_name": "Country",
"is_display": false,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4080,
"tenantId": 144,
"name": "time_zone",
"required": false,
"sequence": 10,
"remark": null,
"display_name": "时区",
"display_en_name": "Time Zone",
"is_display": false,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4081,
"tenantId": 144,
"name": "age",
"required": false,
"sequence": 11,
"remark": null,
"display_name": "年龄",
"display_en_name": "Age",
"is_display": false,
"field_type": 1,
"field_type_info": null,
"is_preset": true
},
{
"id": 4082,
"tenantId": 144,
"name": "birthday",
"required": false,
"sequence": 12,
"remark": null,
"display_name": "出生日期",
"display_en_name": "The date of birth",
"is_display": false,
"field_type": 5,
"field_type_info": "{\"formatter\": \"yyyy-MM-dd\"}",
"is_preset": true
},
{
"id": 4083,
"tenantId": 144,
"name": "gender",
"required": false,
"sequence": 13,
"remark": null,
"display_name": "性别",
"display_en_name": "Gender",
"is_display": false,
"field_type": 3,
"field_type_info": "[{\"id\": \"1\", \"name\": \"男\", \"i18nCode\": \"saas.plat.api.11156\"}, {\"id\": \"0\", \"name\": \"女\", \"i18nCode\": \"saas.plat.api.11188\"}]",
"is_preset": true
},
{
"id": 4136,
"tenantId": 144,
"name": "customize_1_13",
"required": false,
"sequence": 14,
"remark": null,
"display_name": "文本",
"display_en_name": "文本",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": false
},
{
"id": 4137,
"tenantId": 144,
"name": "customize_1_14",
"required": false,
"sequence": 15,
"remark": null,
"display_name": "自定义字段2",
"display_en_name": "自定义字段2",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": false
},
{
"id": 4138,
"tenantId": 144,
"name": "customize_1_15",
"required": false,
"sequence": 16,
"remark": null,
"display_name": "自定义字段 3",
"display_en_name": "自定义字段 3",
"is_display": true,
"field_type": 1,
"field_type_info": null,
"is_preset": false
},
{
"id": 4139,
"tenantId": 144,
"name": "customize_2_16",
"required": false,
"sequence": 17,
"remark": null,
"display_name": "数字",
"display_en_name": "数字",
"is_display": true,
"field_type": 2,
"field_type_info": null,
"is_preset": false
},
{
"id": 4140,
"tenantId": 144,
"name": "customize_3_17",
"required": false,
"sequence": 18,
"remark": null,
"display_name": "单选",
"display_en_name": "单选",
"is_display": true,
"field_type": 3,
"field_type_info": "[{\"id\": \"1\", \"name\": \"A\"}, {\"id\": \"2\", \"name\": \"B\"}, {\"id\": \"1682407283267\", \"name\": \"C\"}]",
"is_preset": false
},
{
"id": 4141,
"tenantId": 144,
"name": "customize_4_18",
"required": false,
"sequence": 19,
"remark": null,
"display_name": "多选",
"display_en_name": "多选",
"is_display": true,
"field_type": 4,
"field_type_info": "[{\"id\": \"1\", \"name\": \"A\"}, {\"id\": \"2\", \"name\": \"B\"}, {\"id\": \"1682407301578\", \"name\": \"C\"}]",
"is_preset": false
},
{
"id": 4142,
"tenantId": 144,
"name": "customize_5_19",
"required": false,
"sequence": 20,
"remark": null,
"display_name": "日期",
"display_en_name": "日期",
"is_display": true,
"field_type": 5,
"field_type_info": "{\"formatter\": \"yyyy-MM-dd\"}",
"is_preset": false
},
{
"id": 4143,
"tenantId": 144,
"name": "customize_6_20",
"required": false,
"sequence": 21,
"remark": null,
"display_name": "时间",
"display_en_name": "时间",
"is_display": true,
"field_type": 6,
"field_type_info": "{\"formatter\": \"yyyy-MM-dd HH:mm:ss\"}",
"is_preset": false
}
],
"traceId": "148b351a19514993951c549dc7ddd077"
}简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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）