~~NOTOC~~ ======应用管理====== 应用管理接口,为开发者提供创建应用,修改应用,删除应用和查询应用等功能。应用管理接口以form表单的方式提交参数。 应用管理包含以下数据结构: * [[#应用创建请求参数| 应用创建请求参数]] * [[#应用查询请求参数 | 应用查询请求参数]] * [[#应用删除请求参数 | 应用删除请求参数]] * [[#应用修改请求参数 | 应用修改请求参数]] * [[#添加接入号码请求参数 | 添加接入号码请求参数]] * [[#删除接入号码请求参数 | 删除接入号码请求参数]] * [[#查询响应对象 | 查询响应对象]] * [[#一般响应对象 | 一般响应对象]] 包含以下接口: * [[#应用创建|应用创建]] * [[#应用修改|应用修改]] * [[#应用删除|应用删除]] * [[#应用查询|应用查询]] * [[#添加接入号码|添加接入号码]] * [[#删除接入号码|删除接入号码]] ===== 数据结构说明 ===== ====应用创建请求参数 ==== {| style="width:90%;" ! style="width:8em;"|属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|必选 |主账户id,ucpaas平台生成,固定32位长度,可在开发者控制台查询 |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token,可在开发者控制台查询 |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |appName |String |style="text-align:center;"|必选 |应用名称,当前主账户下要求唯一,不超过10个字符,应用一旦创建,应用名称将不能修改;不支持特殊字符 |- |whiteList |String |style="text-align:center;"|可选 |服务器白名单,允许域名或者IP地址,以英文输入法分号;分隔,例如:www.baidu.com;8.8.8.8 |- |notifyCallback |String |style="text-align:center;"|必选 |通知类业务回调地址,应用涉及通知类业务处理成功后会回调此地址 |- |nbr |String |style="text-align:center;"|必选 |接入号或者叫热线号码,也叫中继号。多接入号之间以英文逗号隔开。联系工作人员获得 |- |op |String |style="text-align:center;"|必选 |业务标识,固定字符串ivr |} ---- http://www.ucpaas.com/maap/ipcc/app/add?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&appName=123hhh&whiteList=113.31.88.173¬ifyCallback=http://www.huidiao.com&nbr=075581234567&op=ivr ---- ==== 一般响应对象 ==== {| style="width:90%;" ! colspan="3" | 属性 ! 类型 !style="text-align:center;width:3em;"|约束 ! 说明 |- | rowspan="3" style="vertical-align: middle;"| resp | colspan="2" |respCode | String |style="text-align:center;"|必选 |参见[[:呼叫中心:errorcode_ipcc| 响应码说明]] |- | colspan="2" |respMsg | String |style="text-align:center;"|必选 |响应消息说明 |- |app |appId |String |style="text-align:center;"|可选 |应用ID |} ---- { "resp": { "respCode": "000000", "respMsg": "成功", "app": { "appId": "d12abd3da59d47e6bf13893ec43730b8" } } } ---- ====应用查询请求参数==== {| style="width:90%;" ! style="width:8em;"|属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|必选 |主账户id,固定32位长度,可在开发者控制台查看 |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token,可在开发者控制台查看 |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |appId |String |style="text-align:center;"|必选 |appid |} ---- http://www.ucpaas.com/maap/ipcc/app/get?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&appId=5584c13f832a4c3496d0212e266bbc1f ---- ==== 查询响应对象 ==== {| style="width:90%;" ! colspan="3" | 属性 ! style="text-align:center;width:5em;"|类型 !style="text-align:center;width:3em;"|约束 ! 说明 |- | rowspan="7" style="vertical-align: middle;"| resp | colspan="2" |respCode |width:5em;"|String |style="text-align:center;"|必选 |参见[[:呼叫中心:errorcode_ipcc| 响应码说明]] |- | colspan="2" |respMsg |width:5em;"| String |style="text-align:center;"|必选 |响应消息说明 |- | rowspan="5" style="vertical-align: middle;width:3em"|app |appId |width:5em;"|String |style="text-align:center;"|必选 |应用ID |- |appName |String |style="text-align:center;"|必选 |应用名称,当前主账户下要求唯一,不超过10个字符 |- |whiteList |String |style="text-align:center;"|可选 |服务器白名单,允许域名或者IP地址,以英文输入法分号;分隔,例如:www.baidu.com;8.8.8.8 |- |notifyCallback |String |style="text-align:center;"|必选 |通知类业务回调地址,应用涉及通知类业务处理成功后会回调此地址 |- |nbr |String |style="text-align:center;"|必选 |接入号或者叫热线号码,也叫中继号。多接入号之间以逗号隔开。联系工作人员获得 |} ---- { "resp": { "respCode": "000000", "respMsg": "成功", "app": { "appId": "d12abd3da59d47e6bf13893ec43730b8", "appName": "应用名称11", "whiteList": "www.baidu.com;8.8.8.8", "callBackAddr": "http://huidiao.com", "nbr": "10010,10086,10000" } } } ---- ====应用删除请求参数==== {| style="width:90%;" !style="text-align:center;width:8em;" |属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|可选 |主账户id,固定32位长度,可在开发者控制台查询 |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token,可在开发者控制台查询 |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |appId |String |style="text-align:center;"|必选 |创建应用时,返回的appid |- |op |String |style="text-align:center;"|必选 |业务标识,固定字符串ivr |} ---- http://www.ucpaas.com/maap/ipcc/app/del?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&appId=5584c13f832a4c3496d0212e266bbc1f&op=ivr ---- ==== 应用修改请求参数 ==== {| style="width:90%;" ! style="text-align:center;width:8em;"|属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|必选 |主账户id,UCpaas平台生成,固定32位长度 |- |appId |String |style="text-align:center;"|必选 |应用Id |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |whiteList |String |style="text-align:center;"|可选 |服务器白名单,允许域名或者IP地址,以英文输入法分号;分隔,例如:www.baidu.com;8.8.8.8 |- |notifyCallback |String |style="text-align:center;"|必选 |通知类业务回调地址,应用涉及通知类业务处理成功后会回调此地址 |- |nbr |String |style="text-align:center;"|必选 |接入号或者叫热线号码,也叫中继号。多接入号之间以逗号隔开。联系工作人员获得 |- |op |String |style="text-align:center;"|必选 |业务标识,固定字符串ivr |} ---- http://www.ucpaas.com/maap/ipcc/app/edit?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&appId=d12abd3da59d47e6bf13893ec43730b8&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&whiteList=113.31.88.173¬ifyCallback=http://www.huidiao.com&nbr=075581234567&op=ivr ---- ====添加接入号码请求参数 ==== {| style="width:90%;" ! style="width:8em;"|属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|必选 |主账户id,ucpaas平台生成,固定32位长度,可在开发者控制台查询 |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token,可在开发者控制台查询 |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |appId |String |style="text-align:center;"|必选 |创建应用时,返回的appId |- |nbr |String |style="text-align:center;"|必选 |接入号或者叫热线号码,也叫中继号。多接入号之间以英文逗号隔开。联系工作人员获得;一次请求最多添加50个。 |- |op |String |style="text-align:center;"|必选 |业务标识,固定字符串ivr |} ---- http://www.ucpaas.com/maap/ipcc/app/addNbr?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&appId=2cc0d635a2f443121e83bc787490d40a&nbr=075581234567,075581234567&op=ivr ---- ====删除接入号码请求参数 ==== {| style="width:90%;" ! style="width:8em;"|属性 ! |类型 !style="text-align:center;width:8em;"|约束 ! |说明 |- |sid |String |style="text-align:center;"|必选 |主账户id,ucpaas平台生成,固定32位长度,可在开发者控制台查询 |- |token |String |style="text-align:center;"|必选 |主账号授权令牌token,可在开发者控制台查询 |- |time |String |style="text-align:center;"|必选 |时间戳,当前系统时间( 24小时制),格式:yyyyMMddHHmmssSSS |- |sign |String |style="text-align:center;"|必选 |验证信息,使用MD5加密(主账户id+时间戳+账户授权令牌),共32位(小写) |- |appId |String |style="text-align:center;"|必选 |创建应用时,返回的appId |- |nbr |String |style="text-align:center;"|必选 |接入号或者叫热线号码,也叫中继号。多接入号之间以英文逗号隔开。 |- |op |String |style="text-align:center;"|必选 |业务标识,固定字符串ivr |} ---- http://www.ucpaas.com/maap/ipcc/app/delNbr?sid=2cc0d635a2f443121e83bc787490d40a&token=cc103e9a8c7c25dedf3295cb3e50b8df&time=20151022154226000&sign=7778def7c60a182348afbca46aac2541&appId=2cc0d635a2f443121e83bc787490d40a&nbr=075581234567,075581234567&op=ivr ---- ===== 接口说明 ===== ==== 应用创建 ==== {| style="width:90%;" !功能 |创建一个新的应用。呼叫中心所有的能力,都是基于应用来使用。 |- ! | URL | %%http://www.ucpaas.com/maap/ipcc/app/add%% |- ! |Method |Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! |Parameter | [[#应用创建请求参数| 应用创建请求参数]] |- ! Response | [[#一般响应对象| 一般响应对象]] |} ==== 应用删除 ==== {| style="width:90%;" !style="width:8em;" |功能 |删除一个已有的应用,应用删除后,针对该应用的后续操作均不可使用。应用删除后不可恢复,请慎重使用该接口。 |- ! | URL | %%http://www.ucpaas.com/maap/ipcc/app/del%% |- ! |Method |Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! Parameter | [[#应用删除请求参数| 应用删除请求参数]] |- ! Response | [[#一般响应对象| 一般响应对象]] |} ---- ==== 应用修改 ==== {| style="width:90%;" !style="width:8em;" |功能 |修改一个已有应用的相关信息,除了appName以外,其他的都能够修改。 |- ! | URL | %%http://www.ucpaas.com/maap/ipcc/app/edit%% |- ! |Method |Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! Parameter | [[#应用修改请求参数| 应用修改请求参数]] |- ! Response | [[#一般响应对象| 一般响应对象]] |} ---- ==== 应用查询 ==== {| style="width:90%;" !style="width:8em;" |功能 |查询一个已有的应用。 |- ! | URL | %%http://www.ucpaas.com/maap/ipcc/app/get%% |- ! |Method | Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! Parameter | [[#应用查询请求参数| 应用查询请求参数]] |- ! Response | [[#查询响应对象| 查询响应对象]] |} ---- ==== 添加接入号码 ==== {| style="width:90%;" !style="width:8em;" |功能 |批量添加接入号码,一次性最多添加50个。 |- ! | URL | %%http://www.ucpaas.com/maap/ipcc/app/addNbr%% |- ! |Method | Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! Parameter | [[#添加接入号码请求参数| 添加接入号码请求参数]] |- ! Response | [[#一般响应对象| 一般响应对象]] |} ---- ==== 删除接入号码 ==== {| style="width:90%;" !style="width:8em;" |功能 |批量删除接入号码,一次性最多删除50个。 |- ! | URL | %% http://www.ucpaas.com/maap/ipcc/app/delNbr%% |- ! |Method | Get 方式 |- ! |Headers |简单的HTTP Get请求头 |- ! Parameter | [[#删除接入号码请求参数| 删除接入号码请求参数]] |- ! Response | [[#一般响应对象| 一般响应对象]] |} ----