-
Notifications
You must be signed in to change notification settings - Fork 6
SAAS saas_plat openapi batch_create
zjc1750514326 edited this page Jul 8, 2024
·
29 revisions
批量创建客户
- URL:
https://api.nxcloud.com/saas/cdp/openapi/customers/batch_create
- 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入参参数签名 查看公共约定 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
type | integer | 是 | 1 | 0:放弃旧数据,使用新数据 1:基于旧数据更新/增加数据项目 2:保留旧数据、放弃新数据 |
tenant_id | integer | 是 | 123 | 租户id |
app_key | string | 是 | 46oKF=os | appkey |
customers | array | 是 | customers信息 | 批量创建,单次限制100 |
- 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字符 |
String | 否 | - | instagram最大长度为30字符 | |
line | String | 否 | - | line最大长度为50字符 |
country | String | 否 | - | 国家 最大长度为50字符 |
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字符 |
ps:sms_phone、whats_app_phone、email、viber_phone、messenger、instagram、line不能同时为空。
body(application/json) 参数:
{
"type": 0,
"tenant_id": 1,
"customers": [
{
"full_name": "zhang san",
"sms_phone": "18163725558",
"whats_app_phone": "18667728886",
"country": "China",
"email": "[email protected]",
"address": "Wujin District, Tai'an City, Fujian Province",
"birthday": "1976-04-12",
"source": "voluptate Excepteur",
"remark": "nisi amet",
"tagStr": "test,99",
"time_zone": "GMT+8",
"gender": 0,
"customize_field": "{\"customize_1_14\": \"aa\"}"
},
{
"full_name": "li si",
"sms_phone": "18135539411",
"whats_app_phone": "18178516529",
"country": "China",
"email": "[email protected]",
"address": "Wujin District, Tai'an City, Fujian Province",
"birthday": "2015-08-19",
"source": "aliquip laboris dolore",
"remark": "ut",
"time_zone": "GMT+8",
"tagStr": "88,99",
"gender": 1
}
]
}
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 结果编码 |
data | JsonObject | 请求结果 |
message | String | 请求结果说明 |
traceId | String | 链路追踪ID |
{
"code": 0,
"message": "",
"data": "",
"traceId": "56bf81643292cd6a89ecde64ae00db13"
}
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- 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