企业培训_cpsp接口开发培训

ISAG规范概述SMS业务能力接口介绍MMS业务能力接口介绍LCS业务能力接口介绍WapPush业务能力接口介绍 主要内容 主要内容 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 ISAG规范概述 ISAG即综合业务接入网关 将中国电信的网络能力高度抽象 向CP SP提供标准 统一的业务开发接口 支持电信自营增值业务 第三方CP SP增值业务及企业应用的接入 目前 ISAG规范包括12个业务能力 即 SMS MMS LCS WapPush AC CN TPC ECC TS USSD Payment Presence ISAG所有业务能力都是通过WebService调用来实现的 各个业务能力有个公共部分即SOAP头结构 SOAP头分为上行SOAP头和下行SOAP头 主要携带一些SPID SPPwd ServiceID等基本信息以便ISAG进行鉴权 ISAGAPI的实现方式 WEBSERVICE网络应用程序 使用SOAP协议实现 SOAP简单的理解 就是这样的一个开放协议SOAP RPC HTTP XML 采用HTTP作为底层通讯协议 RPC作为一致性的调用途径 XML作为数据传送的格式 允许服务提供者和服务客户经过防火墙在INTERNET进行通讯交互 WSDL WebServiceDescriptionLanguageWebService的描述语言 WSDL定义了一套基于XML的语法 将Web服务描述为能够进行消息交换的服务访问点的集合 ISAG WEBSERVICE WebService SAG与CP SP间 实现北向接口部分 主要作用是向CP SP提供标准 统一的业务开发接口 其主要功能是将标准的ParlayX接口封装为内部接口 并通过PCH将接口的同步处理方式转换为异步处理方式 将请求发送给平台 以便平台进行相应的业务处理 ISAG组网图 Webservice就是一个应用程序 它向外界暴露出一个能够通过Web进行调用的API 这就是说 你能够用编程的方法通过Web来调用这个应用程序 开发工具有Jbuilder eclipse gsoap等 Request ResponseMessageRequest调用远端对象的某个方法Response返回该方法运行后的输出结果 ISAGAPI的实现方式 SOAPHEADER参数 SPID StringSPID由ISAG提供 在ZXINSAG用户的SAG SPINFO里改 SPPAAWORD SAG SPINFOstringSP密码 MD5加密 MD5加密算法如下 SP密码 SPID 密匙 时间戳密匙部分由ISMP分配 时间戳由发端设备生成 格式为MMDDHHMMSS 月日时分秒SERVICEID SAG SERVICEINFO业务IDOA 定购参数 群发时不填 单发时必填sag msisdnrange业务订购地址 群发时不填 FA付费地址URL WEBSERVICE的地址ADDRESSES 目的地址 如要发给哪个手机 SENDERADDR SP的ACCESSCODE 也就是发到手机上显示的号码 在ZXINSAG用户的SAG SERVICEINFO表里可以修改 CAPABILITYCONFIG里 TIMELEN 是发多少次 CAPABILITY 容量即发多少条timeSamp时间戳格式为 格式为MMDDHHMMSS 月日时分秒SANstring业务接入码可选 transactionId业务流水号 用户组合业务 可选 transEnd交易结束标识 用户组合业务 可选 LinkID事务关联ID用户点播业务的事务关联 由平台产生 格式如下为MMDDHHMMSS 10位随机序列号 为空 二进制 表示无效 可选 mutiMessagingtrue 群发false 非群发 缺省 上行SOAPHEADER参数 spRevpasswordSP反向调用的密码 可选SpIdSPIDSAN业务接入码serviceId业务IDtransaction业务流水号 用于组合业务linkId事务关联ID 用于点播业务的事务关联 由平台产生 格式为为MMDDHHMMSS 10位随机序列号 可选spRevIdsp反向调用名 可选 ISAG规范介绍SMS业务能力接口介绍MMS业务能力接口介绍LCS业务能力接口介绍WapPush业务能力接口介绍 主要内容 SMS业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 SMS业务能力接口定义了短信业务能力集 包括应用端发起的能力集合以及网络侧发起的能力集合 用户登录短消息门户网站 使用该服务 用户编辑短信 点击发送 门户和GW间通过短信API 完成短信服务过程 GW会将短信中心传送回来的短信状态 通知APP 用户可以通过门户网站查询得知短信发送的状态 序列图如下 下行接口介绍 1 1 SendSmssendSms向签约用户发送短消息 业务触发条件由应用提供商与签约用户进行预先约定 参数如下 Addresses目的地址 或地址集合 SenderName短消息发送者的信息Charging可选参数 应用于本消息的计费应用可指定计费方案名称 由此确定这条短消息对谁计费以及金额几何Message短消息内容ReceiptRequest指示是否需要网络侧返回递交状态报告网关根据第三方的要求用NotifySmsDeliveryStatus返回状态报告 对本接口的调用 网关应返回RequestIdentifier 标示该短消息的发送请求 如果消息的长度大于可支持的最大长度 此条消息将被分成若干条连续的短消息进行发送 下行接口介绍 2 2 GetSmsDeliveryStatus通过调用GetSmsDeliveryStatus 可以查询之前requestIdentifier标识的SMS发送的状态 状态信息在deliveryStatus参数中返回 它与requestIdentifier标识的请求相关的一组状态信息 状态由用户地址和相关的发送状态共同标识 即使状态达到最终值 这个方法仍可被应用多次调用 然而 状态达到最终值之后 状态信息只在有限的期间内可用 超过该期间 业务接入网关抛出策略异常 其中 返回的状态包括 DeliveredToTerminal DeliveredToNetwork DeliveryImpossible Authpricefailed等 下行接口介绍 3 3 GetReceivedSms通过调用GetReceivedSms 应用可以通过网关获得所有满足registrationIdentifier标识准则的短消息 每执行一次该方法 网关将返回给应用的短消息从网关上删除 此外 每条短消息在某个最大时间间隔后 会从服务器上自动删除 这个最大的时间间隔在离线配置阶段定义 接收到的短消息信息在receivedSms参数中返回 其中包含短消息的发送者 内容和终端用来发送消息的目标地址 上行接口介绍 1 上行接口是由业务接入网关发起的 到业务应用服务器的调用 4 NotifySmsDeliveryStatus业务应用服务器先前向网关发送了短消息 如果带有ReceiptRequest字段 则当网关获得状态报告时 即调用本接口将短消息的递交状态报告给应用 该状态报告以ReceiptRequest Correlator和DeliveryStatus的组合进行标识 状态信息在DeliveryInformation中具体描述 上行接口介绍 2 5 NotifySmsReception业务触发条件由应用提供商与运营商进行预先约定 当业务接入网关收到发给特定地址的短消息时 即调用本接口 将短消息发送给业务应用服务器 notifySmsReception由业务接入网关调用 将短消息的接收通知应用 仅当收到的短消息满足预先约定的提供准则时 网关才会发出通知 这个提供准则由registrationIdentifier进行标识 短消息通过SMSMessage标识 包括参数Message标识短消息的内容 参数SmsServiceActivationNumber 即能被应用 监视 的短消息的目的地址 参数SenderAddress包含了发送者地址 应用可采取适当的业务逻辑来处理收到的短消息 应用提交短消息流程 应用提交短消息的调用流程 上图为应用提交短消息的调用流程 1 6 CP SP提交SMS发送请求给SAG 应答在接入认证完成 10 或向SMSC提交 14 之后返回 7 10 SLP通过ISMAP模块向ISMP进行鉴权批价处理 当鉴权失败时 直接进入21通知CP SP鉴权失败 11 14 SLP通过SMPP模块向SMSC提交短消息 返回成功后将信息入库 15 18 收到来自SMSC的短消息回执 19 22 SLP通过ISMAP模块向ISMP进行鉴权批价确认处理 23 28 SLP向CP SP返回发送状态报告 不要求状态报告时无此流程 注 接入认证见后图 ISAG规范介绍SMS业务能力接口介绍MMS业务能力接口介绍LCS业务能力接口介绍WapPush业务能力接口介绍 主要内容 MMS业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 MMS业务能力接口定义了彩信业务能力集 包括应用端发起的能力集合以及网络侧发起的能力集合 彩信和短信的流程基本类似 区别在于彩信消息中可以包含图片 文本等附件 用户登录一个卡通图片业务门户网站 为过生日的好友选择祝福卡片 并编辑祝福短信后 点击彩信发送 图片门户与MMS服务间通过API交互完成彩信的发送 同时 MMS服务会将彩信中心返回的状态报告通知给图片门户 这样用户可通过门户网站查询彩信发送的状态 下行接口介绍 1 下行接口是由业务应用服务器发起 到业务接入网关的调用 1 SendMessage业务触发条件由应用提供商与签约用户进行预先约定 由应用根据业务需要在恰当时刻调用本接口 给用户发送一条彩信 本消息调用是请求发送一条彩信到一组地址集合 并返回RequestIdentifier对本消息的发送进行标识 网关根据第三方的要求用notifyMessageDeliveryStatus返回状态报告 并使用RequestIdentifier与先前发送的消息相关联 彩信的内容是作为一个SOAP附件进行发送 第三方通过ReceiptRequest告知网关是否需要返回状态报告 下行接口介绍 2 2 GetMessageDeliveryStatus通过调用GetMessageDeliveryStatus 可以查询之前requestIdentifier标识的MMS发送的状态 状态信息在deliveryStatus参数中返回 它与requestIdentifier标识的请求相关的一组状态信息 状态由用户地址和相关的发送状态共同标识 即使状态达到最终值 这个方法仍可被应用多次调用 然而 状态达到最终值之后 状态信息只在有限的期间内可用 超过该期间 业务接入网关抛出策略异常 其中 返回的状态包括 DeliveredToTerminal DeliveredToNetwork DeliveryImpossible Authpricefailed等 下行接口介绍 3 3 GetReceivedMessages这个操作是使用一个特殊的注册标识符获得一组新的消息 该请求参数为RegistrationIdentifier和优先参数 Priority 可选 返回一个MessageReference数组 其中包括每条彩信的彩信标识 主题 发送方地址 目的地址等 通过该操作 应用可以获取特定标识的彩信基本信息 并依据各个彩信的标识进一步获取彩信URI地址组及彩信附件 绑定不同注册标识符参数是一个不在线的处理过程 ParlayX网关不允许使用一个未与应用关联的注册标识符获取消息 下行接口介绍 4 4 GetMessageURIs这个操作将依据MessageRefIdentifier读取消息的不同部分 在业务接入网关建立本地文件并且返回URI标识 应用可以仅仅读取每个文件或将其以链接的形式呈现给最终用户 5 GetMessage这个操作将依据MessageRefIdentifier这个操作将读取整条消息 在返回的消息中 数据以附件形式返回 上行接口介绍 1 上行接口是由业务接入网关发起的 到业务应用服务器的调用 6 NotifyMessageDeliveryReceipt业务应用服务器先前向网关发送了彩信 网关对该消息的发送分配了一个标识符RequestIdentifier 当网关获得状态报告时 即调用本接口将彩信的递交状态报告给应用 本接口的调用是将先前递交彩信的状态报告告知应用 该彩信以RequestIdentifier和DeliveryStatus的组合进行标识 状态信息在DeliveryInformation中具体描述 上行接口介绍 2 7 NotifyMessageReception业务触发条件由应用提供商与运营商进行预先约定 当业务接入网关收到发给特定地址的消息时 即调用本接口 将消息发送给业务应用服务器 当网关收到发送到特定业务激活号码的新消息时 将把消息作为附件通知到应用 参数RegistrationIdentifier标识业务激活号码 Message标识与接收消息相关的所有信息 ISAG规范介绍SMS业务能力接口介绍MMS业务能力接口介绍LCS业务能力接口介绍WapPush业务能力接口介绍 主要内容 LCS业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 LCS业务能力接口定义了定位业务能力集 包括应用端发起的能力集合以及网络侧发起的能力集合 定位业务能力集可分为一下三类 位置信息同步查询 应用向GW查询一个或一组用户位置信息 网关同步返回位置信息告知应用 位置信息异步查询 事件触发 应用调用一次位置请求 指定范围区域 在查询周期内 用户进入指定区域或离开指定区域 网络将上报用户位置信息 位置信息异步查询 周期性触发 应用可以调用一个API请求 网络按一定频率周期性上报用户位置信息 下行接口介绍 1 下行接口是由业务应用服务器发起 到业务接入网关的调用 LCS下行接口可分为两类 定位信息同步查询和定位信息异步查询 1 GetLocation定位信息同步查询接口 查询一个终端用户的位置信息 参数如下 Addresses 需定位的终端地址 RequestedAccuracy 要求精度 以米为单位 AcceptableAccuracy 可接受的精度 以米为单位 定位结果通过LocationInfo返回给应用 包括经度 纬度以及终端地址等 其中 纬度值以浮点数 90 0000 90 0000 形式表示 单位为十进度的度 方向与分钟和秒钟相反 正值表示赤道以北 负值表示赤道以南 经度值以浮点数 180 0000 180 0000 形式表示 单位为十进度的度 方向与分钟和秒钟相反 正值表示本初子午线 格林威治 以东 负值表示本初子午线 格林威治 以西 直到第180条子午线 下行接口介绍 2 2 GetTerminalDistance定位信息同步查询接口 查询一个与某个特定位置间的距离 该特定的位置以经度和纬度来表示 参数如下 Address 终端地址Latitude 指定位置的纬度Longitude 指定位置的经度返回终端与指定点间的距离 以米为单位 下行接口介绍 3 3 GetLocationForGroup定位信息同步查询接口 和接口GetLocation类似 区别在于GetLocationForGroup可以获取一组终端用户的位置信息 参数和GetLocation一样 定位结果通过LocationData数组返回给应用 其中除了包含LocationInfo中的基本信息外 还包括位置报告状态ReportStatus以及错误值ErrorInformation 当ReportStatus为 Error 时有效 下行接口介绍 4 4 StartGeographicalNotification定位信息异步查询接口 事件触发 用于请求GW以一定原则上报一个或多个终端的位置信息 报告上报的原则为用户进入或离开指定的区域 该请求的参数包括终端地址组 原点的经纬度 范围的半径 产生报告的原则 是否立即查询 上报最大频度 最大时长以及上报次数等 业务接入网关收到该请求后 通过LocationNotification按照应用的要求上报终端位置信息 错误信息通过LocationError上报应用 上报结束时调用LocationEnd通知应用 下行接口介绍 5 5 StartPeriodicNotification定位信息异步查询接口 周期性触发 用于请求GW按照一定的精度周期性上报一个或多个终端的位置信息 该接口和区域定位类似 也是通过LocationNotification等接口通知应用定位结果 6 EndNotification请求GW停止周期性或事件触发性的上报一个或多个用户的状态信息 周期性及事件触发性定位请求中将该请求的异步位置查询的请求标识 Correlator 带给业务接入网关 应用通过该标识通知GW停止上报 上行接口介绍 1 上行接口是由业务接入网关发起的 到业务应用服务器的调用 7 LocationNotification该接口用于业务接入网关向应用返回需要查询的终端用户位置信息 该通知消息通过参数Correlator和应用下发的周期性或事件触发异步位置查询请求相关联 位置信息放在LocationInfo数组中 当请求是事件触发的异步位置查询请求时 通过Criteria参数指明当前位置上报的原则 上行接口介绍 2 8 LocationError该接口用于业务接入网关查询用户位置消息出现错误时 通知业务应用服务器 该通知消息通过参数Correlator和应用下发的周期性或事件触发异步位置查询请求相关联 参数Address指明错误报告对应的终端地址 Reason指明错误原因 9 LocationEnd当位置报告的最大时长或者次数到时 则GW结束周期性监视状态 接口通过参数Correlator和应用下发的周期性或事件触发异步位置查询请求相关联 ISAG规范介绍SMS业务能力接口介绍MMS业务能力接口介绍LCS业务能力接口介绍WapPush业务能力接口介绍 主要内容 WapPush业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 WapPush业务能力接口定义了WapPush业务能力集 包括应用端发起的能力集合以及网络侧发起的能力集合 WapPush和短信的流程基本类似 基本业务流程如下 应用程序向业务接入网关提交推送请求 业务网关返回请求标识 应用程序可以根据返回的请求标识主动向业务接入网关查询状态 也可以等待业务接入网关发出推送结果通知 下行接口介绍 1 下行接口是由业务应用服务器发起 到业务接入网关的调用 1 SendMessage本操作请求把一个消息的URL地址推送到一组目标地址 并且返回一个请求标识 requestIdentifier 以唯一标识这个消息 应用程序可以稍后用requestIdentifier查询消息状态 第三方通过ReceiptRequest告知网关是否需要返回状态报告 网关根据第三方的要求用notifyMessageDeliveryStatus返回状态报告 并使用RequestIdentifier与先前发送的消息相关联 下行接口介绍 2 2 GetMessageDeliveryStatus通过调用GetMessageDeliveryStatus 可以查询之前requestIdentifier标识的推送请求的处理状态 状态信息在deliveryStatus参数中返回 它与requestIdentifier标识的请求相关的一组状态信息 状态由用户地址和相关的发送状态共同标识 即使状态达到最终值 这个方法仍可被应用多次调用 然而 状态达到最终值之后 状态信息只在有限的期间内可用 超过该期间 业务接入网关抛出策略异常 其中 返回的状态包括 DeliveredToTerminal DeliveredToNetwork DeliveryImpossible Authpricefailed等 上行接口介绍 上行接口是由业务接入网关发起的 到业务应用服务器的调用 3 NotifyMessageDeliveryReceipt本操作向客户端应用程序通知推送结果 本接口的调用是将先前递交的推送请求的状态报告告知应用 该短消息以RequestIdentifier和DeliveryStatus的组合进行标识 状态信息在DeliveryInformation中具体描述 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 AC业务能力接口介绍 概述下行接口介绍 概述 AC业务能力接口定义了语音呼叫业务能力集 该业务能力集只有应用端发起到业务接入网关调用的能力集合 AC提供了一种灵活的方式来传递语音信息 接口非常简单 不需要开发者去管理呼叫的产生 也不需要与呼叫交互来发送语音消息 有三种机制可以用于语音消息的内容 文本 使用Text To Speech TTS 引擎来播放语音内容 例如 wav 使用放音设备来播放VoiceXML 使用VoiceXML浏览器来播放目前只支持VoiceXML文本放音 下行接口介绍 1 应用调用接口请求放音 网关返回请求标识 应用根据该关联标识查询呼叫状态 同时应用也可以根据该关联标识取消放音服务 1 PlayVoiceXmlMessage调用该接口用于创建一个到用户的呼叫 该用户由Address标识 并且播放位于VoiceXmlUrl的VXML文件信息 当系统接收到请求后 调用会立即返回结果 实际的呼叫异步进行 返回值将被用来标识这次请求 这个操作被用来对单个终端播放一条信息 这里提供的应该是单个终端URI 而不是群组URI 如果提供了群组URI 则应用将收到PolicyException PlayTextMessage PlayAudioMessage和该接口类似 只是播放的语音内容不同 下行接口介绍 2 2 GetMessageStatus调用GetMessageStatus来得到先前请求的当前状态 先前请求由Correclator来标识 得到MessageStatus值 指明当前播放状态为已播放 正在播放 还未播放或是发生错误 3 EndMessage调用EndMessage取消或停止由Correlator标识的先前请求 返回值为Result 包含了在放弃请求时刻的状态 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 TPC业务能力接口介绍 概述下行接口介绍 概述 TPC业务能力接口定义了第三方呼叫业务能力集 该业务能力集只有应用端发起到业务接入网关调用的能力集合 TPC描述第三方呼叫 用于创建并管理应用发起的呼叫 此WebService的范围就是以简单的方式为应用开发商提供创建呼叫的功能 事实上 通过使用这个第三方呼叫WebService 应用开发商不需要掌握详细的电信知识 就能调用呼叫处理功能 基本流程 业务门户提供用户点击拨号的业务界面 用户只需通过点击网页就可以建立语音呼叫 业务网关会在业务请求收到后返回一个能唯一标识该次呼叫的参数Callidentifer 用户也可以通过业务界面停止该呼叫 下行接口介绍 1 1 makeCall第三方触发一语音增值业务 通过MakeCall指示网关发起业务呼叫 网关呼通主叫 再连接被叫 作为可选 应用还可以提供计费 charging 指示 返回的参数 callIdentifier 用于标识此呼叫 APP可以用它来监视这个呼叫的状态 或是取消呼叫等 2 getCallInformationAPP调用getCallInformation获得指定呼叫 由callIdentifier标识 的当前状态 呼叫结束后 在静态配置的有效期内 网关将保存呼叫状态 以供APP查询 返回的状态信息包括呼叫状态 开始时间 时长等 下行接口介绍 2 3 endCallAPP通过呼叫标识指示网关结束makeCall呼叫 如果呼叫还处于初始阶段 网关将放弃呼叫 如果呼叫已经建立 网关将切断呼叫 4 cancelCallAPP通过呼叫标识指示网关放弃makeCall呼叫 如果呼叫还未建立 指示网关放弃makeCall呼叫 如果呼叫已经建立 呼叫将不受影响 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 CN业务能力接口介绍 概述上行接口介绍 概述 CN业务能力接口定义了网络发起到第三方呼叫的业务能力集 用于处理网络中的签约用户发起的呼叫 一个第三方的应用将决定此呼叫将如何处理 CN基本是一个被叫属性触发的业务能力集 包括两类接口 四种触发方式 接口可分为两类CallDirection和CallNotification 两类接口都是依照事先配置的事件触发呼叫 不同的是CallNotification接口是网关用来通知APP 而CallDirection中定义的接口网关不但将呼叫通知APP 并等待APP的下一步动作指示 触发方式包括 被叫忙触发 被叫不可达触发 被叫无应答触发和接入码触发 上行接口介绍 1 1 CallDirection类接口CallDirection类接口包括四个 handleBusy handleNotReachable handleNoAnswer handleCalledNumber 这四个接口的参数及返回值类型一致 只是触发方式不同 在此以handleBusy为例说明 在一个基本呼叫中 当被叫忙时 触发智能业务 网关向APP进行智能请求 APP进行相关业务判断 指示网关进行动作 APP指示网关动作有三种 Continue 正常地处理网络中的被叫忙事件EndCall 结束呼叫Route 重新路由到应用指定的目标地址当应用指示的网关动作是Route时 返回的Action中还包含重新路由的地址 上行接口介绍 2 2 CallNotification类接口CallNotification类接口包括四个 notifyBusy notifyReachable notifyAnswer notifyCalledNumber 这四个接口的参数类型一致 只是触发方式不同 在此以notifyBusy为例说明 在一个基本呼叫中 当被叫忙时 触发智能业务 网关将被叫忙事件通知给APP 该类请求的参数和CallDirection类接口类似 包括主叫号码 被叫号码以及主叫方名称 可选 CallNotification类接口没有返回值 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 ECC业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 ECC 即enhanceCall 增强呼叫业务集 分为应用侧发起的呼叫和网络侧发起的呼叫 在 Thirdpartycall 和 CallNotification 中描述的呼叫控制API 无论是第三方发起的还是网络发起的 应用和网络的交互都是一次性的 在呼叫建立后 应用无法对呼叫的进展保持跟踪 因而也不能根据呼叫的具体进展情况作进一步的处理 同时 应用也无法利用网络专有资源向用户提供服务 这在很大程度上限制了应用开发商开发业务的灵活性和多样性 增强型呼叫控制API 以简单的方式为应用开发商提供持续控制一个呼叫的功能 下行接口介绍 1 下行接口即APPCall类接口 应用侧发起的呼叫 是由GW到业务应用服务器的调用 第三方可以发起一个呼叫 也可以根据呼叫标识查询呼叫状态或结束呼叫 1 enMakePowerCall第三方触发一语音增值业务 通过enMakePowerCall指示网关发起业务呼叫 并返回呼叫标识 请求参数 callingParty 主叫号码 action APP指示网关的处理动作 charging 计费标识 suppressservices 是否抑止T CSI 响应消息携带呼叫标识 用户点击网页触发语音增值业务 APP启动业务逻辑 指示网关先呼通主叫 主叫摘机应答后 网关按照action的指示处理呼叫 若action的指示为用户交互时 网关处理结束后必须上报APP 若action的指示为呼叫时 APP应指明网关是否需要上报呼叫处理结果 下行接口介绍 2 APP指示主叫摘机应答后 网关的处理动作 RunUI与用户语音交互BaseCall连接一个指定的被叫SequenceCall失败后 无条件顺呼ConcurrentCall同振2 enInterruptCall第三方根据已建立呼叫的呼叫标识调用enInterruptCall来指示网关中断终端正在进行的行为 放音 通话 开始一个新的处理动作 Action为新的处理动作的指示 被中断的终端为已被连接至系统的终端 下行接口介绍 3 3 enGetServiceStatus业务触发条件 APP业务已触发 并得到了呼叫标识 应用 应用调用enGetServiceStatus查询业务是否还正常进行 实现APP与GW之间的激活测试机制 4 enEndCall业务触发条件 APP业务已触发 并得到了呼叫标识 应用 APP根据呼叫标识调用enEndCall指示网关切断呼叫 结束业务呼叫服务 上行接口介绍 1 上行接口即NetworkCall类接口 网络侧发起的呼叫 是由GW到业务应用服务器的调用 GW生成呼叫标识callIdentifier APP根据该标识指示GW进行放音 呼叫接续 同振 顺呼 彩铃等动作 1 enhandleACall用户通过拨打业务接入码方式进行业务触发 GW将业务请求通知APP APP收到业务请求 启动业务应用 APP 开始增值业务服务 网关将呼叫信息 主 被叫 和业务触发原因上报给APP APP通过业务逻辑判断 指示网关如何处理当前呼叫 若处理的动作为用户交互时 网关处理结束后必须上报APP 若处理的动作为呼叫时 APP需要指示网关上报呼叫处理结果 否则网关不上报 上行接口介绍 2 网关通知APP业务请求时 呼叫的状态为 Busy被叫忙NotReachable被叫不可达NoAnswer被叫无应答OffHook主叫摘机Servicenumber业务接入码呼叫CalledAuthorizedMT呼叫流程触发情况OriginCollectedInfoMO呼叫流程触发情况APP指示网关的处理动作为 EndCall结束呼叫RunUI与用户语音交互BaseCall连接一个指定的被叫SequenceCall失败后 无条件顺呼ConcurrentCall同振 上行接口介绍 3 2 enhandleCallEvent业务触发条件 当网关根据应用指示对业务请求的处理动作为呼叫时 如 呼一个被叫 同振 顺呼 并且APP指示网关呼叫处理结束后上报呼叫处理结果 网关呼叫处理结束 通过enhandleCallEvent上报呼叫处理结果 APP收到呼叫处理结果 进行业务判断 指示网关下一步的处理动作 下一步动作和enhandleACall中的返回值一致 网关通知APP呼叫处理结果分以下几种 Busy呼叫失败 被叫忙NotReachable呼叫失败 被叫不可达NoAnswer呼叫失败 被叫无应答Offline呼叫失败 SIP终端离线CallSuccess呼叫完成 被叫挂机LimitReached呼叫完成 呼叫限制到 上行接口介绍 4 3 enhandleUIEvent业务触发条件 当网关根据应用指示对业务请求的处理为进行用户交互时 如 向用户播放语音 放音收号 取VXML脚本进行用户交互 用户交互结束后 网关通过enhandleUIEvent上报用户交互结果 APP根据网关上报的用户交互结果进行业务判断 指示网关下一步的处理动作 下一步动作和enhandleACall中的返回值一致 网关通知APP用户交互结果如下 用户交互结束 无收号uiResultUI End用户交互结束 有收号uiResultUI CollectNumuiCollection号码用户交互失败uiResultUI Failure 上行接口介绍 5 4 enNotifyEvent网关将被叫应答 主叫挂机等呼叫事件以通知的方式告知APP 通知的事件包括以下几种 CalledAnswer被叫应答Callingdisconnect主叫挂机CallingBusy主叫忙CallingNoAnswer主叫无应答CallingNotReachable主叫不可达各个呼叫控制步骤通过上行接口参数中的呼叫标识相互关联 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 USSD业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 USSD 即 unstructuredsupplementaryservicedata 即非结构化补充数据业务 是一种基于GSM网络 可以提供综合性 交互式信息服务的数据业务 USSD与短消息业务 SMS 都是通过网络的信令通道传递的 不同之处在于短消息属于存储转发方式 USSD则属于面向对话方式 当用户访问USSD业务时 该对话通路保持连接 直到对话结束 ISAGUSSDWebService用于在应用和用户之间的建立的USSD交互 以此完成一些信息的交互 USSD下行接口类包括如下接口类 SendUssdUSSD上行接口类包括如下接口类 NetworkNotify 下行接口介绍 1 接口类1 SendUssdmakeUssd由应用发起的USSD请求 将USSD信息传递给网关 应用调用本接口 向网关发起USSD交互请求 USSD交互的内容UssdMessage中描述 该消息的目的地址由DestinationAddress描述 应用的请求网关返回UssdIdentifier 以使本次交互与后续的USSD交互关联起来 方法有makeUssdRequest和 makeUssdResponse 上行接口介绍 1 接口类2 NetworkNotify1 handleUssdISAG网关调用本接口 向应用发起USSD交互请求及USSD消息内容 网关通过UssdIdentifer标识这次特定的USSD交互 USSD交互的内容在UssdMessage中描述 USSD请求的发起者由SenderAdderess描述 网关通过UssdArray请求应用给出下一步的交互的信息 上行接口介绍 2 2 handleUssdContinue在USSD交互已成功建立之时 网关调用本接口 将用户的USSD反馈信息告知应用 网关通过USSDIdentifier标识这次的特定的USSD交互 USSD交互的内容在USSdMessage中描述 USSD请求的发起者由SenderAddress描述 网关通过UssdArray请求应用给出下一步USSD交互信息 上行接口介绍 3 3 notifyUssdEnd网关调用本接口告知应用USSD交互被中止 并在EndReason参数中给出中止原因 网关通过UssdIdentifier标识这次特定的USSD交互 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 TS业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 TS业务 即TerminalStatus终端状态业务 queryterminalstatusandstatusnotifications查询终端状态和终端状态报告 下行接口介绍 1 TS业务下行接口类即TerminalStatus类接口 调用该接口查询一个终端用户的当前状态信息 1 GetStatus调用GetStatusRequest 获取终端地址列表信息 返回GetStatusResponse中的Result参数类型为Status终端状态列表信息 2 StartNotification通过本操作StarNotification请求GW周期性的上报一个或者多个用户的状态信息 并返回Correlator对本请求的进行标识 下行接口介绍 2 其中方法StartNotificationRequest中包括如下参数 参数 Reference监听异步请求返回值 接收用户的状态的URl地址信息 参数 Address需要获取的用户状态的终端URL地址数组参数 Criteria指定报告的一些状态 用于所有终端 参数 CheckImmediate是否立即检查状态标识参数 Frequency状态通知的最大频率 报告间隔的最小时间参数 Duration报告时长 若null则使用servicepolicy中的默认值参数 Coot报告次数的上限 0 为无限制输出 StartNotificationResponse3 EndNotification请求GW停止周期性的上报一个或者多个用户的状态信息 上行接口介绍 接口类TeminalNotification1 StatusNotification通过本操作StatusNotification业务接入网关向应用返回需要查询的用户状态信息 2 StatusError通过本操作智能业务接入网关查询用户状态消息时 出现的错误 通知业务应用服务器 3 StatusEnd通过操作StatusEnd 当状态报告的最大时长或者次数限制到时 则GW结束周期性的监视状态 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力介绍Presence业务能力接口介绍 主要内容 Payment业务能力接口介绍 概述下行接口介绍上行接口介绍 概述 本服务用于实现符合中国电信的结构体和标准的支付能力 SP CP通过使用本业务能力接口 可以在用户的银行 虚拟的通讯帐户上扣除因用户使用SP CP服务 或者购买SP CP商品而产生的费用 同时 为适用中国电信现状 本业务能力接口还增加了对用户直接从电信统一门户或者MPSS门户购买的商品的方式的支持 以及对派奖活动的支持 注意 本接口参考原ParlayX2 0规范中的Payment部分的内容 但是与其不兼容 若要兼容ParlayX2 0规范需对本接口进行扩展 下行接口介绍 1 支付接口类 该接口用于用户购买商品或服务后 SP CP从用户帐户中扣除因商品交易或服务交易而发生的费用 以及对派奖活动的支持 包括4个操作 1 支付请求 2 支付确认 3 冲正 4 派奖针对每个操作API分别为 tocharge SP向MPSS请求扣费 ChargeConfirm MPSS通知SP扣费完成 UndoCharge 发现问题后 对原来的成功的交易进行冲正 ChargeBonus 向用户的帐户中充入奖励给用户的金额 上行接口介绍 2 通知接口 该接口用于ISAG向SP CP发起通知类信息 包括2个API BuyNotification和ChargingNotification 操作方法包括 1 购买通知该操作主要用于向SP CP通报 用户已经从电信统一接入门户上订购了他们公司的产品或服务 2 支付通知该操作主要用于向SP CP通报 用户预授权 SP可以进行业务处理 包括通知的SP CPMPSS已经对用户预授权成功 AC业务能力接口介绍TPC业务能力接口介绍CN业务能力接口介绍ECC业务能力接口介绍USSD业务能力接口介绍TS业务能力接口介绍Payment业务能力接口介绍Presence业务能力接口介绍 主要内容 Presence业务能力接口介绍 概述Presence业务能力接口介绍 1 Presence业务能力接口介绍 2 Presence业务能力接口介绍 3 Presence业务能力接口介绍 4 Presence概述 Presence用于向用户提供呈现信息 并将这些呈现的信息提供给订阅这些信息的用户 Presence业务允许呈现信息被一个或更多的用户获取 同样也允许注册呈现信息 这些接口的典型的客户端可以是呈现信息的提供者 也可以是呈现信息的使用者序列图如订阅呈现信息序列图观察者应用向业务接入网关发送订阅请求 业务接入网关通知Presence服务器 等Presence服务器得到确认消息后 业务接入网关将订阅结果返回给观察者应用 Presence业务能力接口介绍 1 PresenceCommon接口类使用本接口的客户端的角色是观察者 该接口类只包含一个API 即register 是PS业务能力的基本操作 register用来在PS服务器上注册用户 只有用户在注册之后 用户才能使用subscribePresence消息订阅呈现者信息或者使用Publish消息发布自身信息 参数 watcher 注册用户 即观察者 expire 保持注册的存活时间 0表示注销 响应消息 statuscode 注册结果 true 成功或false 失败 expire 注册状态的超期时间 Presence业务能力接口介绍 2 PresenceConsumer接口类使用本接口的客户端的角色是观察者 观察者使用的本类的接口集合来获取呈现的数据 再订阅呈现数据后 观察者可在选择轮询或通知的模式来接收呈现数据 该接口类属于下行接口 该接口类包含四个API 1 subscribePresence 订阅呈现信息2 getUserPresence 获取呈现信息 暂不实现 3 startPresenceNotification 通知模式请求呈现信息 暂不实现 4 endPresenceNotification 主动停止呈现信息通知 暂不实现 Presence业务能力接口介绍 2 1 subscribePresence本接口用来调用用户的呈现信息 假设观察者之前已经被鉴权 因此其标识为可识别的 能与服务器总的签约信息关联 调用该方法 将联系被呈现的用户 并请求他授权给观察者 由于这个过程涉及到用户交互 因此不会马上就有响应 将使用的notifySubscription 来通知观察者 如果被呈现的用户是一个组 这要联系组中的每一个成员 要求他们授权 对每个成员 观察者都要得到一个通知 仅在订阅完成后且被呈现的用户允许对其属性进行接入后 观察者才能在使用getUserPresence 或者startPresenceNotification 之后获取信息 Presence业务能力接口介绍 2 参数说明 请求消息参数 attrubu