中国电信综合业务接入网关_ISAG_开放接口协议03-MMS RC V1.0.0

黄铖斌

CT

目 录

1 适用范围...........................................................................................................................................................4 2 引用标准...........................................................................................................................................................5 3 缩略语................................................................................................................................................................6 4 服务概述...........................................................................................................................................................7 5 序列图. (8)

6

数据类型 (9)

6.1 D ELIVERY S TATUS ....................................................................................................................................9 6.2 D ELIVERY I NFORMATION ........................................................................................................................9 6.3 M ESSAGE R EFERENCE .............................................................................................................................9 6.4 M ESSAGE URI .........................................................................................................................................10 6.5 M ESSAGE P RIORITY . (10)

7 接口定义.........................................................................................................................................................11 7.1 接口:S END M ESSAGE .........................................................................................................................11 7.1.1 操作:sendMessage ...............................................................................................................11 7.1.2 操作:getMessageDeliveryStatus .....................................................................................13 7.2 接口:G ET M ESSAGE ...........................................................................................................................14 7.2.1 操作:getReceivedMessages .............................................................................................14 7.2.2 操作:getMessageURIs .........................................................................................................15 7.2.3 操作:getMessage ...................................................................................................................16 7.3 接口:M ESSAGE N OTIFICATION ........................................................................................................17 7.3.1 操作:notifyMessageReception .........................................................................................17 7.3.2 操作:notifyMessageDeliveryReceipt .. (18)

8 差错定义 (19)

9

服务策略 (20)

信分

公司

前 言

中国电信移动业务网络综合业务接入网关(ISAG )将中国电信的网络能力高度抽象,向CP/SP 提供标准、统一的业务开发接口,支持电信自营增值业务、第三方CP/SP 增值业务及企业应用的接入。

本系列规范由六项规范组成,名称如下:

中国电信移动业务网络综合业务接入网关ISAG 技术规范

中国电信移动业务网络综合业务接入网关ISAG 设备要求

中国电信移动业务网络综合业务接入网关ISAG 开放接口协议 中国电信移动业务网络综合业务接入网关ISAG 业务流程规范 中国电信移动业务网络综合业务接入网关ISAG 协议映射规范 中国电信移动业务网络综合业务接入网关ISAG 业务测试规范

本系统规范主要依据3GPP 和OMA 的有关规范和信息产业部颁布的相关行业技术标准编制。 本规范解释权属于中国电信集团公司。

本规范起草单位:中国电信股份有限公司上海研究院。

信分

公司

1 适用范围

IT 领域的第三方业务提供商可以通过综合业务接入网关访问和使用电信网络的业务能力。本规范规定了中国电信综合业务接入网关向第三方提供的电信网络业务能力,描述了这些业务能力的应用开发接口(API),用于指导综合业务接入网关的设计开发及CP/SP 接口应用。

本规范适用于中国电信移动业务网络综合业务接入网关(ISAG )的设备提供商及与此相关的内容

提供商、服务提供商。为综合业务接入网关设备制造、工程设计和网络运行、管理和维护等方面提供技

术依据。

公司

2 引用标准

下列文件通过本文的参考而成为本规范的条款。凡是注日期的参考文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本文,凡是不注日期的参考文件,其最新版本适用于本文。 1 《中国电信移动增值业务网络技术体制》

2 《中国电信移动业务网络综合业务接入网关技术规范》

3 《中国电信综合业务管理平台流程规范》

4 《中国电信综合业务管理平台接口规范》

5 3GPP,TS 29.198 Open Service Access (OSA); Application Programming Interface (API)

6 Parlay Group, Parlay 4.0 Parlay X Web Services Specification

7

ETSI ES 202 391-2

信分

公司

3 缩略语

缩略语

英文全名

中文全名

3G 3rd Generation 第三代(移动通信) AOMT ApplicationOriginated MobileTerminated 应用发起,终端终止

CP Content Provider 内容提供商 GMLC GateWay Mobile Location Center 网关移动位置中心 GMSC GateWay Mobile Location Center 网关移动交换中心

HLR Home Location Register

归属位置寄存器 IDE

Integrated Development Environment

集成开发环境 IN Intelligent Network 智能网 IP Intelligent Peripheral 智能外设

ISAG Integrated Service Access Gateway 综合业务接入网关 ISMP Integrated Service Management Platform 综合业务管理平台 MOAT MobileOriginated ApplicationTerminated 终端发起,应用终止

MSC Mobile Switch Center

移动交换中心

MSISDN Mobile Station International Subscriber

Directory Number

移动用户ISDN 号 NAG

Network Access Gateway

网络接入网关 OME Open Messaging Enabler 开放消息使能器 OSA Open Service Access 开放业务访问 OSS Operation Support System 运营支撑系统 PS Presence Server

呈现服务器 PHS Personal Handset System 个人手持电话系统 PSWAP Presence ServerWireless Application Protocol

呈现服务器无线应用协议 SCP Service Control Point 业务控制点 SCS

Service Capability Server

业务能力服务器 SE Service Enabler

业务引擎 SLA Service Level Agreement 业务层协议 SMSGW Short Message Gateway 彩信网关(PHS ) SP Services Provider 业务提供商 VLR

Visit Location Register 拜访位置寄存器 VMSC Visit Mobile Switch Center 拜访地移动交换中心 MPSS

Mobile Payment Service System

移动支付服务系统 Watcher Watcher

观察者

公司

4 服务概述

当前,为了接收和发送彩信,在写应用时必须使用专门的协议来接入网元(例如,彩信中心MMS-C )提供的MMS 功能。这种方式要求应用开发商对网络有高度的专业知识。本章定义了一种彩信Web Service ,通过使用这个MMS Web Service ,应用开发商不需要专门的电信知识,就能调用彩信功能。

应用调用一个API 给网络发送一条彩信(参见发送彩信API )。网关采用非同步的通知机制将彩信递交状态告知应用。

为从网络接收彩信,可使用通知机制(参见MMS Notification API )。通知机制更通用:网络发起的消息被发送到自我管理的应用侧web service 。与通知相关的提供准则不在此描述。

公司

5 序列图

图中为彩信服务的应用示例。

用户登录一个卡通图片业务门户网站,为过生日的好友选择祝福卡片,并编辑祝福短信后,点击彩信发送。图片门户与MMS 服务间通过API 交互完成彩信的发送。

同时MMS 服务会将彩信中心返回的状态报告通知给图片门户,这样用户可通过门户网站查询彩信发送的状态。

图1. 彩信服务

公司

6 数据类型

6.1 DeliveryStatus

数据类型:枚举

枚举值

描述

DeliveredToNetwork 短消息已成功递交至网络。

DeliveryUncertain 递交状态未知:例如,短消息被发送到另外一个网络。

DeliveryImpossible 无法成功发送;短消息在超时前无法被递交。

MessageWaiting 消息仍在排队等待递交。 DeliveredToTerminal

成功发送至终端。

DeliveryNotificationNotSupported 不支持发送回执功能。 Authpricefailed

鉴权计费失败

6.2 DeliveryInformation

数据类型:结构 参数名 参数类型

描述

address

xsd:anyURI

消息接收地址。 deliveryStatus DeliveryStatus

发送状态。

6.3 MessageReference

数据类型:结构 参数名

参数类型 描述

messageIdentifier

xsd:string 指向ISAG 中存储的彩信,如接收彩信为纯文本则此参数无效。(可选)

messageServiceActivationNumber xsd:string 目的地址。 senderAddress

xsd:anyURI

发送方地址。

信分

公司

subject xsd:string 彩信的标题。(可选) priority

MessagePriority 优先级,缺省值为Normal。

message

xsd:string

若接收彩信为纯文本,则消息体的内容填写如此参数,当此参数存在时,messageIdentifier 参数无效。

6.4 MessageURI

数据类型:结构

参数名 参数类型 描述

bodyText xsd:string 此域为接收彩信的文本部分。

fileReferences

xsd:anyURI [1..unbounded]

此域为附件数组,数组的内容是彩信 所有附件的引用地址(URI),这些引用地址直接指向不同文件,如GIF 图片,或者是

文本说明。

6.5 MessagePriority

数据类型:枚举 枚举值 描述

Default NULL 值。如果类型为MessagePriority 的参数被标记为‘可选的’,本参数可应用。 Low

低的消息优先级。 Normal 正常的消息优先级。 High

高的消息优先级。

信分

7 接口定义

7.1 接口:SendMessage

本节以消息调用、参数和数据类型的方式描述了发起能力的集合。本节描述的API ,是由业务应用服务器发起、到业务接入网关的调用:

SendMessage :应用发送消息给网关。

GetMessageDeliveryStatus :应用获取消息发送状态。

7.1.1 操作:sendMessage

业务触发条件由应用提供商与签约用户进行预先约定,由应用根据业务需要在恰当时刻调用本接口,给用户发送一条彩信。本消息调用是请求发送一条彩信到一组地址集合,并返回RequestIdentifier 对本消息的发送进行标识。网关根据第三方的要求用notifyMessageDeliveryStatus 返回状态报告,并使用RequestIdentifier 与先前发送的消息相关联。彩信的内容是使用MIME 编码作为一个SOAP 附件进行发送。第三方通过ReceiptRequest 告知网关是否需要返回状态报告。

7.1.1.1

输入:sendMessageRequest

参数名

参数类型

描述

addresses

xsd:anyURI[1..unbounde d] 彩信接收地址。

senderAddress

xsd:string

发送彩信的源地址。指示消息发送者的地址。本参数是不允许由所有第三方提供商填充的。网关服务器需要根据特定应用的SLA 对其进行处理,因此本参数的使用可能导致PolicyException 。(可选)

subject xsd:string 本参数指示消息的主题。

(可选) priority MessagePriority

本参数代表消息的优先级。如果未定义,网络将基于运营商策略分配一个优先级。(可选) charging Common:ChargingInfor

可选参数。指示计费相关信息。

信分

公司

mation

receiptRequest Common:SimpleReferen ce

指示是否需要网络侧返回递交状态报告。

输入的附件

content MIME 格式 和Message 一起发送的数据,使用MIME 格式,作为一个SOAP 附件被发送。

7.1.1.2 输出:sendMessageResponse

参数名

参数类型 描述

requestIdentifier

xsd:string

标识一个特定的消息发送请求,可用于getMessageDeliveryStatus 消息调用。

最大长度32位;(编码格式:ISAG 设备号(6位)+预留位“0”+厂商内部

编码)

7.1.1.3

差错

业务异常:

SVC0001 – 业务错误。

SVC0002 – 非法输入值。 SVC0004 – 非法地址。 SVC0006 – 非法组。

策略异常:

POL0001 – 策略错误。 POL0006 – 组不被允许。 POL0007 – 嵌套组不被允许。 POL0008 – 不允许提交计费信息。 POL0900– 不支持群发。 POL0907– 不允许群发。

信分

公司

7.1.2 操作:getMessageDeliveryStatus

7.1.2.1

输入:getMessageDeliveryStatusRequest

参数名

参数类型 描述

requestIdentifier

xsd:string

标识一个特定的状态请求。

最大长度32位;编码格式:ISAG 设备号(6位)+预留位“0”+厂商内部编码

7.1.2.2 输出:getMessageDeliveryStatusResponse

参数名 参数类型

描述

result

DeliveryInformation[1..unbounded]

以前发送的一组消息的状态。每组要素表现为一条发送的消息:例如,目的地址和传送状态。

7.1.2.3

差错

业务异常:

SVC0001 – 业务错误。 SVC0002 – 非法输入值。 策略异常:

POL0001 – 策略错误。

信分

公司

7.2 接口:GetMessage

本节以消息调用、参数和数据类型的方式描述了发起能力的集合。本节描述的API ,是由业务应用服务器发起、到业务接入网关的调用:

GetReceivedMessages :应用获取消息的参考消息。 GetMessageURIs :应用获取指定消息的URIs 。 GetMessage :应用获取整条消息内容。

7.2.1 操作:getReceivedMessages

这个操作是使用一个特殊的注册标识符获得一条新的消息。如果注册标识符未被指定,Parlay X 服务器将返回应用发送的所有消息的参考信息。绑定不同注册标识符参数是一个不在线的处理过程。Parlay X 网关不允许使用一个未与应用关联的注册标识符获取消息。应用可设置优先参数(Priority)接收高优先级的消息,即,如果设置为普通级参数,则会返回普通级别以上的的所有消息。如果该优先级参数省略,则会返回所有的消息信息。

7.2.1.1

输入:getReceivedMessagesRequest

参数名

参数类型

描述

registrationIdentifier xsd:string

标识不在线状态的应用接收通知,消息接收根据制定标准。

priority MessagePriority 从Parlay X 网关得到的优先消息。所有拥有指

定优先权和高级优先权的消息都会找回。如果没有指定,所有消息都将被返回,例如,都同样指定为低级。(可选)

7.2.1.2

输出:getReceivedMessagesResponse

参数名

参数类型

描述

result MessageReference [1..unbounded] 包括一组收到根据指

公司

定过滤注册标识符和优先权的消息。

7.2.1.3

差错

业务异常:

SVC0001 – 业务错误。

SVC0002 – 非法输入值。 策略异常:

POL0001 – 策略错误。

7.2.2 操作:getMessageURIs

这个操作将读取消息的不同部分,在 业务接入网关建立本地文件并且返回URI 标识。应用可以仅

仅读取每个文件或将其以链接的形式呈现给最终用户。文件的URIs 将在协定的时间被激活。

7.2.2.1

输入:getMessageURIsRequest

参数名

参数类型

描述

messageRefIdentifier xsd:string

标识需要获取的消息。

7.2.2.2

输出:getMessageURIsResponse

参数名

参数类型

描述

result MessageURI

包含完整的信息,例如,消息的文本部分,如果存在的话,还会包含消息附件的文件列表。

信分

公司

7.2.2.3

差错

业务异常:

SVC0001 – 业务错误。 SVC0002 – 非法输入值。 策略异常:

POL0001 – 策略错误。

7.2.3 操作:getMessage

这个操作将读取整条消息。在返回的消息中,数据以附件形式返回,该附件在SOAP 消息中的附

件[7]中定义。

7.2.3.1

输入:getMessageRequest

参数名

参数类型

描述

messageRefIdentifier xsd:string

消息标识。

7.2.3.2 输出:getMessageResponse

参数名 参数类型 描述 无

7.2.3.3

差错

业务异常:

SVC0001 – 业务错误。 SVC0002 – 非法输入值。 策略异常:

信分

公司

POL0001 – 策略错误。

7.3 接口:MessageNotification

本节以消息调用、参数和数据类型的方式描述了发起能力的集合。本节描述的API ,是由业务接入网关发起的、到业务应用服务器的调用:

NotifyMessageReception :网关将发送到特定号码的消息告知应用。 NotifyMessageDeliveryStatus :网关将特定彩信的递交状态告知应用。

7.3.1 操作:notifyMessageReception

业务触发条件由应用提供商与运营商进行预先约定,当业务接入网关收到发给特定地址的消息时,

即调用本接口,将消息发送给业务应用服务器。应用web service 的URI 注册是预先约定的。这意味着在网关应有一个注册机制,能将不同的RegistrationIdentifier 参数与应用及其web service URI 绑定。当网关收到发送到特定业务激活号码的新消息时,将把消息作为附件通知到应用。

7.3.1.1

输入:notifyMessageReceptionRequest

参数名

参数类型

描述

RegistrationIdentifier xsd:string 连接到预先注册过的通知的句柄。

本参数区分指向同一个应用web service 的不同注册。

Message MessageReference 与接收消息相关的所有信息。 输入的附件

Content Content Content

7.3.1.2

输出:notifyMessageReceptionResponse

参数名 参数类型 描述 无

信分

公司

7.3.1.3

差错

无。

7.3.2 操作:notifyMessageDeliveryReceipt

业务应用服务器先前向网关发送了彩信,网关对该消息的发送分配了一个标识符

RequestIdentifier 。当网关获得状态报告时,即调用本接口将彩信的递交状态报告给应用。本接口的调

用是将先前递交彩信的状态报告告知应用,该短消息以RequestIdentifier 和DeliveryStatus 的组合进行

标识。状态信息在DeliveryInformation 中具体描述。

7.3.2.1 输入:notifyMessageDeliveryReceiptRequest

参数名 参数类型 描述

Correlator

xsd:string

标识一个特定的彩信状态报告。 最大长度50位。

DeliveryStatus DeliveryInformation

是先前被发送的消息的状态,包括消息的目标地址和它的递交状态。

7.3.2.2

输出:notifyMessageDeliveryReceiptResponse

参数名 参数类型

描述 无

7.3.2.3

差错

无。

信分

公司

8 差错定义

无。

信分

公司

9 服务策略

名称 类型 描述

GroupSupport xsd:boolean 是否支持组地址。 NestedGroupSupport xsd:boolean 是否支持嵌套组。

ChargingSupported xsd:boolean 是否支持计费。

AllowEndPoint

xsd:boolean 是否允许指定地址。

MaximumDestinationAddresses xsd:int 北向接口支持数组的最大长度。

MaximumMessageLength

xsd: int

北向接口中消息内容大小的最大值。

AllowNotifySmsReception xsd:boolean 是否支持通知。

GetMessageSupport xsd:boolean

是否支持用get 方式收彩信 GetStatusSupport xsd:boolean 是否支持用get 方式收彩信状态

MultiSupport xsd:boolean 是否支持群发 MultiAllowed

xsd:boolean

是否允许彩信群发

信分公司

相关文档
最新文档