-
Couldn't load subscription status.
- Fork 6
NXphone Android SDK功能说明文档
前言
本文为您介绍了NXphone Android SDK的功能说明以及参数和返回值描述。
SDK使用
NXphone-SDK的项目已开源至Sonatype中央仓库,您可在配置文件中添加jar包依赖如下所示。
Username和Password是您调用NXphone-SDK的账密,可以在牛信云平台生成和管理;
引入工程配置
- 主工程gradle 配置
maven { url 'https://repo1.maven.org/maven2/' }
- app工程gradle配置
implementation 'com.nxcloud.nxphone:sips:0.0.21'
- Module模块enable dataBinding
android {
...
dataBinding {
enabled = true
}
...
}
软功能使用(NxcallSdkUtil)
1)获取NxcallUtil实例。NxcallSdkUtil.getInstance(Context context)
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| context | 是 | Context | 界面activity的引用。 注意不要误用到 application context,要使用当前 activity 的context!!! |
2)设置nxcall电话监听(非必须)。NxcallSdkUtil.setNxcallListener(NxcallListener nxcallListener)
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| nxcallListener | 是 | NxcallListener | 无 |
3)初始化(必须初始化,只能初始化一次)。NxcallSdkUtil.init(Activity activity, View view, Chronometer mChronometer)
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| activity | 是 | Activity | 无 |
| view | 否 | View | 悬浮窗口view,可null |
| mChronometer | 否 | Chronometer | 悬浮窗口时间显示控件,可null |
4)登录账户。boolean nxLogin(String username, String password)
普通登录,速度快,但是选择的牛信话机接入点不一定是最优的,如果有通话问题,需要我们 noc 介入去调节通话质量
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| username | 是 | String | 账户 |
| password | 是 | String | 密码 |
5)测速登录。boolean nxPreLogin(String username, String password)
> 注意,登录、测速登录,只需要选择一种方式即可,不要两种登录一起使用!
牛信全球有很多接入点,测速登录,会花数十秒去自动侦测到每个接入点的网络连接质量,登录上后,是最优通话质量。注意此登录比较耗时。
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| username | 是 | String | 账户 |
| password | 是 | String | 密码 |
6)拨打号码。int nxcall(String number, String orderid)
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| number | 是 | String | 拨打号码,如果为空,自动跳转输入号码界面;如果不为空直接拨号 |
| orderid | 否 | String | 订单ID,客户自定义,用以识别队列;若为空则会自动生成 |
返回值 NxcallStateCode 拨号状态对应返回值
| 返回值 | 说明 |
|---|---|
| 1 | 成功 |
| -1000 | 未登录 |
| -1001 | SIP未连接 |
| -1002 | 正在通话中 |
| -1003 | 拨号码异常 |
7)销毁。void onDestroy()
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| 无 |
- 具体代码步骤示例
1)初始化
NxcallSdkUtil.getInstance(getApplicationContext())
.setNxcallListener(this)
.init(this, null, null);
2)登录
NxcallSdkUtil.getInstance(getApplicationContext())
.nxLogin("username", "password");
3)拨打号码
NxcallSdkUtil.getInstance(getApplicationContext())
.nxcall("number", "orderid");
4)销毁
NxcallSdkUtil.getInstance(getApplicationContext())
.onDestroy();
问题排查
- 是否正确使用了 NxcallSdkUtil.getInstance(mContext).nxLogin()
- 是否项目里有多个 nxcall sdk 版本依赖
- 全局搜索下 nxPreLogin nxLogin ,看是否有多个
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
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