paas-node-sdk

################################################################## # API DOC # ################################################################## PAAS_NODE_SDK请求和返回数据都是JSON格式，典型的返回数据结果是： { "code":"200", "msg":null, "data":{ "value":{ "midnum":"02212345678" } } } 说明：code 必选请求状态码，取值200（成功），错误码为其他 msg 可选错误原因描述 data 必选正确返回数据 ##############中间号############## 1.绑定中间号方法名：midNum 参数：callerNum(必选) 主叫号码手机或固话号码（带区号） calleeNum（必选）被叫号码手机或固话号码（带区号） midNum（可选）中间号（主叫拨打的平台号码），为空则平台分配中间号 calleeShowNum（可选）外显号码，只能填写主叫号码或当前企业拥有的平台号码。为空则默认显示平台提供号码。 callerAudio（可选）主叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）被叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 outdate（可选）绑定到期时间，格式为“yyyy-MM-dd HH:mm:ss”，为空则默认次日凌晨03:00。该时间点之后，则绑定关系失效。 area（必选）区域代码由平台提供。 appId（可选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取返回说明：midnum 平台返回的中间号，主被叫对应唯一的中间号记录，主叫可拨打此号码呼叫被叫 2.获取中间号绑定关系方法名：getMidnums 参数：callerNum(可选) 主叫号码，手机或固话号码（带区号） calleeNum（可选）被叫号码，手机或固话号码（带区号） appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 area（必选）地区代码，由平台提供 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： midnum 中间号，主被叫对应唯一的中间号记录 callerNum 主叫号码 calleeNum 被叫号码 calleeShowNum 外显号码 callerAudio 主叫侧铃音标识，对应PAAS平台管理系统IVR列表ID calleeAudio 被叫侧铃音标识，对应PAAS平台管理系统IVR列表ID outdate 关系到期时间 calldata 随路数据，该数据体现在话单callData字段中。 appId 应用标识 3.释放中间号方法名：releaseMidnum 参数： callerNum(可选) 主叫号码，手机或固话号码（带区号） calleeNum（可选）被叫号码，手机或固话号码（带区号） appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 area（必选）地区代码，由平台提供返回说明：无 ##############总机号############## 1.绑定总机号方法名：saveBigExtNum 参数： token（必选）：sdk凭据，PAAS官网系统登陆后首页获取 account（必选）：账户名 bigNum（必选）：总机号 extNum（必选）：小号 calleeNum（必选）：被叫真实号码 appId（必选）：应用标识。由平台提供，通过PAAS平台管理系统应用详情获取 calleeShowNum（可选）：外显号码，只能填写平台提供的号码。为空则显示主叫的真实号码 callerAudio（可选）：主叫侧IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）：被叫侧IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calldata（可选）：随路数据，该数据体现在话单callData字段中返回说明：无 2.更新总机号方法名：updateBigExtNum 参数： token（必选）：sdk凭据，PAAS官网系统登陆后首页获取 account（必选）：账户名 bigNum（必选）：总机号 extNum（必选）：小号 calleeNum（必选）：被叫真实号码 appId（必选）：应用标识。由平台提供，通过PAAS平台管理系统应用详情获取 calleeShowNum（可选）：外显号码，只能填写平台提供的号码。为空则显示主叫的真实号码 callerAudio（可选）：主叫侧IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）：被叫侧IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calldata（可选）：随路数据，该数据体现在话单callData字段中返回说明：无 3.查询总机号方法名：queryBigExtNum 参数： token（必选）：sdk凭据，PAAS官网系统登陆后首页获取 account（必选）：账户名 appId（必选）：应用标识。由平台提供，通过PAAS平台管理系统应用详情获取 bigNum（必选）：总机号 extNum（可选）：小号 calleeNum（可选）：被叫真实号码 page（可选）：页码 size（可选）：每页容量返回说明： bignum 400号码 extnum 小号 calleenum 被叫号码 calleeshownum 外显号码 callerAudio 主叫侧铃音 calleeAudio 被叫侧铃音 subTime 绑定时间 calldata 随路数据 appId 应用标识 4.删除总机号方法名：deleteBigExtNum 参数： token（必选）：sdk凭据，PAAS官网系统登陆后首页获取 account（必选）：账户名 bigNum（必选）：总机号 extNum（必选）：小号 calleeNum（必选）：被叫真实号码 appId（必选）：应用标识。由平台提供，通过PAAS平台管理系统应用详情获取返回说明：无 ##############语音验证码############## 1.发送语音验证码方法名：veriCodeNotify 参数： calleeNum（必选）被叫号码,接收验证码的号码 calleeShowNum（可选）外显号码，只能填写平台提供的号码。为空则显示平台统一号码 code（必选）验证码，必须为长度小于10位的数字 area（可选）区域代码，由天地提供 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 config（可选）外呼验证码配置，包含两个配置项repeatspace repeat（可选）播放铃音重复次数为空则默认为3次 interval（可选）每次铃音的播放间隔(单位秒) 为空则默认为1秒 calldata（可选）随路数据，该数据体现在话单callData字段中返回说明：无 2.查询语音验证码方法名：getVeriCode 参数： calleeNum(可选) 被叫号码 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 callTime（可选）呼叫时间，格式为“yyyy-MM-dd HH:mm:ss”，查询该时间之后的记录。 calldata（可选）随路数据，该数据体现在话单callData字段中。 size（可选）每页展示的数据量，用于分页展示，默认为50 page(可选) 页码，用于分页展示，默认1 返回说明： code 平台播放的验证码 calleeNum 被叫号码，接收验证码的号码 calleeShowNum 平台外显的号码，即被叫看到的号码 subTime 发送播放请求的世杰 calldata 发送验证码请求时携带的随路数据 appId 应用标识 ##############语音通知############## 1.发送语音通知方法名：callNotify 参数： calleeNum(必选) 被叫号码，接收语音通知的号码 calleeShowNum（可选）外显号码，只能填写平台提供的号码。为空则默认显示平台统一号码 calleeAudio（必选）待播放的IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 area（可选）区域代码，由天地提供 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 config（可选）外呼语音配置项 repeat重复次数 space间隔时间 calldata（可选）随路数据，该数据体现在话单callData字段中。 repeat（可选）播放铃音重复次数为空则默认为3次 interval（可选）每次铃音的播放间隔(单位秒) 为空则默认为1秒返回说明：无 2.查询语音通知方法名：getCallNotify 参数： calleeNum（可选）被叫号码 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 callTime（可选）呼叫时间，格式为“yyyy-MM-dd HH:mm:ss”，查询该时间之后的记录。 calldata（可选）随路数据，该数据体现在话单callData字段中。 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： calleeAudio 外呼通知铃音标识 calleenum 被叫号码 calleeshownum 外显号码 subTime 绑定时间 calldata 随路数据 appId 应用标识 ##############双向外呼############## 1.双向外呼方法名：callTwoWay 参数： callerNum（必选）主叫号码 calleeNum（必选）被叫号码 callerShowNum（可选）主叫外显号码，只能填写平台提供的号码。为空则默认显示平台统一号码 calleeShowNum（可选）被叫外显号码，只能填写平台提供的号码。为空则默认显示平台统一号码 callerAudio（可选）播放给主叫的IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）播放给被叫的IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 duration（可选）本次通话的最大时长(单位秒),为空则默认时长(2个小时) area（必选）区域代码，由天地提供 appId（必选）应用标识。由PAAS平台提供 calldata（可选）随路数据，该数据体现在话单callData字段中返回说明：无 2.查询双向外呼记录方法名：getCallTwoWay 参数： callerNum(必选) 主叫号码 calleeNum（必选）被叫号码 callTime（可选）呼叫时间，格式为“yyyy-MM-dd HH:mm:ss”，查询该时间之后的记录 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 calldata（可选）随路数据 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： callernum 主叫号码 calleenum 被叫号码 callershownum 主叫外显号码 calleeshownum 被叫外显号码 callerAudio 主叫铃音标识 calleeAudio 被叫铃音标识 subTime 绑定时间 calldata 随路数据 appId 应用标识 ##############话单############## 1.查询话单方法名：getCallrecords 参数： callTime（可选）话单呼叫时间，格式为“yyyy-MM-dd HH:mm:ss”，查询该时间之后的记录。 syncFlag（可选）话单推送标识 1表示获取推送成功的话单， 2表示获取通知失败话单为空则获取全部话单 appId（可选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 productionId（可选）功能Id，1代表语音验证码，2代表中间号，3 代表语音通知 4代表双向外呼，5代表总机号，空默认为查询应用下的全部功能 size（可选）每页展示的数据量，用于分页展示，默认为50 startId（可选）话单记录ID 获取指定ID之后的话单空默认1 返回说明： appid 应用标识 id 话单id 查询用 cost 此条话单消费 minute*费率 callernum 主叫号码 callid 话单标识 callednum 被叫号码 callershow 主叫外显号码 calleeshow 被叫外显号码 startdate 进入平台时间即呼叫开始时间 enddate 离开平台时间即呼叫结束时间 answertime 被叫应答时间 soundurl 录音地址 billduration 主叫通话时长即 enddate-startdate callduration 被叫通话时长即 enddate-answertime minute 分钟数根据billduration/60 以整计 productionid 功能标识 result 通话结果，参照结果码对照表 syncflag 推送标识 1为推送成功 2推送失败 calldata 随路数据 ##############短信############## 1.发送短信方法名：sendSMS 参数： phone（必选）接收短信的号码手机，暂不支持群发 sms（必选）短信内容内容以【企业签名】开头 appId（可选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取 calldata（可选）随路数据。该数据体现在话单callData字段中。返回说明：无 2.查询短信记录方法名：getSMS 参数： phone（可选）接收短信的号码 calldata（可选）随路数据 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 callTime（可选）该时间之后的记录 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： sms 短信内容 phone 短信接收号码 subtime 发送的时间 status 发送状态 0 成功其他为失败 calldata 随路数据，该数据体现在话单callData字段中。 appId 应用标识 ##############直拨号############## 1.绑定直拨号方法名：directCall 参数： directCallNum（必选）直拨号码 400号码 calleeNum（必选）直拨号码对应的被叫支持多个被叫，以英文“,” 隔开 calleeShowNum（可选）外显号码，只能填写主叫号码或当前企业拥有的平台号码。为空则默认显示平台提供号码。 callerAudio（可选）主叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）被叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 area（必选）区域代码由平台提供。 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 calldata（可选）随路数据。该数据体现在话单callData字段中。返回说明：无 2.查询直拨号方法名：getDirectCalls 参数： directCallNum（可选）直叫号码 400号码 area（必选）区域代码由平台提供。 appId（可选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 calleeNum（可选）直拨号码对应的被叫支持多个被叫，以英文“,” 隔开 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： directCallNum 直拨号 calleeNum 被叫 calleeShowNum 外显 callerAudio 主叫铃音 calleeAudio 被叫铃音 appId 应用标识 calldata 随路数据 subTime 提交时间 3.更新直拨号方法名：updateDirectCall 参数： directCallNum（必选）直拨号码 400号码 calleeNum（必选）直拨号码对应的被叫支持多个被叫，以英文“,” 隔开 calleeShowNum（可选）外显号码，只能填写主叫号码或当前企业拥有的平台号码。为空则默认显示平台提供号码。 callerAudio（可选）主叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 calleeAudio（可选）被叫侧IVR铃音ID，为空则播放默认铃音。该ID通过PAAS平台管理系统IVR列表获取，IVR铃音请先通过管理系统上传到PAAS平台，并通过审核之后才可以使用。支持TTS语音，格式必须为 TTS:语音内容 area（必选）区域代码由平台提供。 appId（必选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 calldata（可选）随路数据。该数据体现在话单callData字段中。返回说明：无 4.删除直拨号方法名：releaseDirectCall 参数： directCallNum（可选）直叫号码 400号码 area（必选）区域代码由平台提供。 appId（可选）应用标识。由平台提供，通过PAAS平台管理系统应用详情获取。 calleeNum（可选）直拨号码对应的被叫支持多个被叫，以英文“,” 隔开返回说明：无 ##############提醒############## 1.设定提醒方法名：remind 参数： remindPhone（必选）被提醒的号码 count（可选）提醒的次数 duration（可选）提醒的时间间隔(单位分钟) remindTime（必选）提醒的开始时间格式为“yyyy-MM-dd HH:mm:ss”，提醒时间应至少大于当前时间一分钟 audio（必选）提醒时播放的IVR铃音ID，为空则播放默认铃音。IVR铃音需提前在PAAS平台上传，并通过审核之后才可以使用。 showNum（可选）外显号码，只能填写平台提供的号码，为空则由平台生成外显 appId（必选）应用标识。由PAAS平台提供。返回说明： remindGroup 提醒组标识，每添加一次提醒生成唯一的提醒组标识，用来查询删除提醒 2.提醒查询方法名：getRemind 参数： remindGroup（可选）提醒组标识 remindTime（可选）提醒时间格式为“yyyy-MM-dd HH:mm:ss”，查询该时间之后的提醒记录。 remindPhone（可选）被提醒号码 appId（必选）应用标识。由PAAS平台提供。 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： remindPhone 提醒号码 shownum 外显号码 remindCount 该组提醒的第几次提醒 remindTime 提醒时间 audio 铃音 jobGroup 提醒组 subTime 提交时间 status 状态 0为提醒成功，其他为提醒失败 3.提醒删除方法名：deleteRemind 参数： remindGroup（可选）提醒组标识 remindTime（可选）提醒时间格式为“yyyy-MM-dd HH:mm:ss”，删除该时间之后的提醒记录。 remindPhone（可选）提醒号码 appId（可选）应用标识返回说明：无 4.提醒到方法名：alwaysRemind 参数： remindPhone（必选）要提醒的号码 audio（必选）提醒的语音 showNum（可选）外显号码 appId（必选）应用标识。由PAAS平台提供。返回说明：无 ##############黑名单############## 1.添加黑名单方法名：saveBlackNum 参数： blackNum（必选）要添加的主叫黑名单号码 timelimit（可选）黑名单时限格式为“yyyy-MM-dd HH:mm:ss”，黑名单在该时间内有效返回说明：无 2.获取黑名单方法名：getBlackNums 参数： blackNum（可选）主叫黑名单号码 timelimit（可选）黑名单时限格式为“yyyy-MM-dd HH:mm:ss”，黑名单在该时间内有效 size（可选）每页展示的数据量，用于分页展示，默认为50 page（可选）页码，用于分页展示，默认1 返回说明： blacknum 黑名单号码 limittime 时限 subtime 提交时间 3.删除黑名单方法名：deleteBlackNum 参数： blackNum（可选）主叫黑名单号码 timelimit（可选）黑名单时限返回说明：无