首页 > 通信行业标准(YD) > YD/T 3191-2016 基于表述性状态转移 (REST) 技术的业务能力开放应用程序接口 (API) 非结构化补充数据业务
YD/T 3191-2016

基本信息

标准号: YD/T 3191-2016

中文名称:基于表述性状态转移 (REST) 技术的业务能力开放应用程序接口 (API) 非结构化补充数据业务

标准类别:通信行业标准(YD)

标准状态:现行

出版语种:简体中文

下载格式:.zip .pdf

相关标签: 基于 表述 状态 转移 技术 业务 能力 开放 应用 程序接口 补充

标准分类号

关联标准

出版信息

相关单位信息

标准简介

YD/T 3191-2016.RESTful based service capability open API Unstructured supplementary service data.
1范围
YD/T 3191规定了基于表述性状态转移(REST)技术的非结构化补充数据业务能力开放应用程序接口(API),包括接口数据结构、接口定义等。
YD/T 3191部分适用于提供非结构化补充数据业务开放的应用程序接口(API)。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
OMA-TS-REST_ Common-V1_ 0-20120724-A RESTful网络API通用定 义( Common definitions for RESTful Network APIs)
4接口概述
非结构化补充数据业务是一种基于全球移动通信系统网络的、实时在线的交互会话数据业务,是面向连接的业务。支持移动台发起的USSD请求,也支持由网络侧发起的USSD请求。支持移动终端与网络的多次交互。移动台发起的USSD请求,需要用户在终端输入USSD的业务号码、*#等符号,并点击呼叫。本标准主要规定了网络侧发起USSD请求的场景下的USSD能力开放。
非结构化补充数据业务API可以提供给应用发送、接收消息等功能。
非结构化补充数据业务的能力实现系统为电信运营商的非结构化补充数据业务平台。
5接口定义
5.1资源概述
表1给出了“非结构化补充数据业务”资源的详细说明、数据结构以及允许的HTTP方法。

标准图片预览






标准内容

ICS33.040
中华人民共和国通信行业标准
YD/T3191-—2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)
非结构化补充数据业务
RESTful based service capability open APIUnstructured supplementary service data2016-10-22发布
中华人民共和国工业和信息化部2017-01-01实施
1范围
2规范性引用文件
3缩略语.此内容来自标准下载网
接口概述
接口定义.
5.1资源概述..
5.2数据类型.
5.3流程图.
资源详细规范.
6.1通用要求
6.2资源:非结构化补充数据业务消息发送参考文献.
YD/T3191—2016
YD/T3191—2016
本标准是“基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)”系列标准之一。该系列标准的结构及名称预计如下:一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)体消息业务部分;
一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)户上下文感知业务:
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)数据业务。
随着技术和市场的发展,还将根据情况制定后续相关标准。本标准按照GB/T1.1-2009给出的规则起草。短消息和多媒
点击拨号;
终端状态:
终端能力信息;
微博业务;
搜索业务;
地址本;
文件传输业务;
定位业务;
状态呈现业务:
聊天业务;
用户信息业务;
支付业务;
视频共享;
图片共享;
移动互联网用
非结构化补充
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由中国通信标准化协会提出并归口。本标准起草单位:中国联合网络通信集团有限公司、华为技术有限公司。本标准主要起草人:胡尼亚。
1范围
YD/T3191—2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)
非结构化补充数据业务
本标准规定了基于表述性状态转移(REST)技术的非结构化补充数据业务能力开放应用程序接口(API),包括接口数据结构、接口定义等。本标准部分适用于提供非结构化补充数据业务开放的应用程序接口(API)。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。OMA-TS-RESTCommon-V10-20120724-ARESTful网络API通用定义(CommondefinitionsforRESTfulNetworkAPIs)
3缩略语
下列缩略语适用于本文件。
AnonymousCustomerReference
ApplicationProgrammingInterfaceGlobalSystemforMobileCommunicationsHyperTextTransferProtocol
Identifier
JavaScriptObjectNotation
Representational StateTransferTelecomserviceOpenPlatform
UniformResourceIdentifier
UniformResourceLocator
UnstructuredSupplementaryServiceDataeXtensibleMarkupLanguage
名用户参考
应用程序编程接口
全球移动通信系统
超文本传送协议
标识符
JavaScript对象表示法
表述性状态转移
电信业务能力开放平台
统一资源标识符
统一资源定位符
非结构化补充数据业务
可扩展标记语言
YD/T3191—2016
4接口概述
XMLSchemaDefinition
XML架构定义
非结构化补充数据业务是一种基于全球移动通信系统网络的、实时在线的交互会话数据业务,是面向连接的业务。支持移动台发起的USSD请求,也支持由网络侧发起的USSD请求。支持移动终端与网络的多次交互。移动台发起的USSD请求,需要用户在终端输入USSD的业务号码、*#等符号,并点击呼叫。本标准主要规定了网络侧发起USSD请求的场景下的USSD能力开放。非结构化补充数据业务API可以提供给应用发送、接收消息等功能。非结构化补充数据业务的能力实现系统为电信运营商的非结构化补充数据业务平台。5接口定义
5.1资源概述
表1给出了“非结构化补充数据业务”资源的详细说明、数据结构以及允许的HTTP方法。表1应用发送非结构化补充数据业务消息资源
非结构化补
充数据业务
消息发送
URL:基础URL:
http://(serverRoot)/ussd/(apiVersion)/requests
数据结构
USSDMessagereq
USSDMessagersp
表1中,\apiVersion\需要用V1值指明是本标准所定义的版本。5.2数据类型
5.2.1XML命名空间
非结构化补充数据业务数据类型的命名空间:urn:oma:xml:rest:netapi:ussd:12数据类型
类型:USSDMessagereq
应用发送USSD消息功能,数据类型见表2。表2应用发送USSD消息元素
destinationAddress
message
sessionID
xsd:string
xsd:string
xsd:string
可选/必选
HTTP方法
应用发送
USSD消息
(非首次)
应用发送
USSD消息
(首次)
DELETE
应用结束
USSD消
息会话
个单独的终端,指终端的地址(例如,‘sip'URI,tel'URI,‘acr'URI)USSD消息内容
会话控制标识
类型:USSDMessagersp
应用接收USSD消息功能,数据类型见表3。表3应用接收USSD消息元素
message
sessionID
5.3流程图
xsd:string
xsd:string
可选/必选
5.3.1应用发送非结构化补充数据业务的消息USSD消息内容
会话控制标识
YD/T3191—2016
图1显示了应用发送非结构化补充数据业务消息,以及结束非结构化补充数据业务会话流程。资源地址:
http://(serverRoot)/ussd/(apiVersion)/requests应用
流程说明如下:
1、发送USSD消息
这回响应
2、发送USSD消息
返回响应
3、结束USSD消息
发送USSD消息
1.应用程序使用POST方法发送USSD消息。服务端
2.应用程序使用PUT方法继续发送USSD消息(此步骤为可选)。3.应用程序使用DELETE方法结束USSD消息发送。YD/T31912016
6资源详细规范
6.1通用要求
在本标准中,无论资源是何种表示形式,下列要求对所有资源都适用:(i.e.XML,JSON,application/x-www-form-urlencoded):·据IETFRFC3986规范,URL变量中的保留字符(URL的部分名称在花括号中被定义)应是百分制编码。注意,无论URL是作为请求URL或者在一个资源的表示中,这种规范始终是适用的(比如“\resourceURL\和link”\等)。·如果anyURI类型的用户标识符(e.g.address,userld,etc)是MSISDN格式,那么根据IETFRFC3966规范,它应被定义为一个全局数字(e.g.tel:+19585550100).除了数字和引导符+\之外的符号应该尽量避免使用,以确保URL的唯一性。无论用户标识符出现在URL变量或者是一个HTTP消息的实体之中,本标准都适用。·如果anyURI类型的用户标识符(e.g.address,userld,etc)是SIPURI格式,应根据IETFRFC3261规范予以定义。
·如果anyURI类型的用户标识符(e.g.address,userId,etc)是名客户参考(ACR)格式,应根据IETF_ACR_draft范予以定义。换言之,它应包含协议前缀‘acr:至于ACR之前。一ACR的\auth”是一个支持保留关键字,一定不能被指定为任何特定的终端用户的ACR。·对于有实体的请求和响应,适用下列规范:在接受请求中,服务器应支持在实体中的JSON和XML编码的参数,并且可能支持实体中的application/x-www-form-urlencoded参数。在响应实体中,按照OMA-TS-RESTCommon-V10-20120724-A的说明,服务器应参照其内容类型的协商结果返回JSON或XML编码变量。在通知客户端时,服务器应该使用XML编码或者是JSON编码,具体采用哪种编码,取决于客户端在相应订阅中指定的格式。按照OMA-TS-RESTCommon-V10-20120724-A的说明,JSON的生成和处理表达应该遵循在HTTP请求/响应中JSON所遵循的规则。关于HTTP响应码、策略异常和服务异常错误码,见OMA-TS-RESTCommon-V10-20120724-A。6.2资源:非结构化补充数据业务消息发送6.2.1概述
使用的资源是:http://(serverRoot)/ussd/(apiVersion)/(senderAddress)/requests该资源用来发送非结构化补充数据业务消息。该接收端采用senderAddress标识。6.2.2请求URL变量
下面请求的URL变量在该资源的所有的HTTP方法中适用,见表4。表4资源的URL变量表
serverRoot
apiVersion
服务器URL:hostname+port+base路径,如:http:/example.com/exampleAPI客户希望使用的API版本
6.2.3POST
6.2.3.1POST概述
该操作用来发送结构化补充数据业务消息。6.2.3.2实例:应用发送USSD消息(首次)6.2.3.2.1Request
POST/exampleAPI/ussd/v1/requestsHTTP/1.1Accept application/xml
Host:example.com
Content-Type:application/xmlContent-Length:nnnntel:+1350000001LastCallCharge:0.00RMB,Duration:00:03:25302398502
6.2.3.2.2Response
HTTP/1.12000K
Date:Thu,04Jun201002:52:00GMTContent-Type:application/xmlContent-Length: nnn
302398502
6.2.3.2.3Request
POST/exampleAPI/ussd/v1/tel%3A%2B19585550100/requestsHTTP/1.1Accept:application/xml
Host:example.com
Content-Type:application/xmlContent-Length:nnnnYD/T3191—2016
YD/T3191—2016
商场订餐取号,选择商场:1君太2老佛爷3大悦城1023902
6.2.3.2.4Response
HTTP/1.1200OK
Date:Thu,04Jun201002:52:00GMTContent-Type:application/xmlContent-Length: nnnn
3
1023902
6.2.4.1PUT概述
该操作用来发送USSD消息(非首次)。6.2.4.1.1Request
PUT/exampleAPI/ussd/v1/tel%3A%2B19585550100/requestsHTTP/1.1Accept:application/xml
Host:example.com
Content-Type:application/xmlContent-Length:nnnn大悦城订餐取号商户:1港丽餐厅2鹿港小镇3禾绿回转1023902
6.2.4.1.2Response
HTTP/1.1200OK
Date:Thu,04Jun201002:52:00GMT6
Content-Type:application/xmlContent-Length: nnnn
2
1023902
6.2.5DELETE
6.2.5.1DELETE概述
该操作用来使应用结束USSD消息会话。6.2.5.2实例:应用结束USSD消息会话6.2.5.2.1Request
DELETE/exampleAPI/ussd/v1/tel%3A%2B19585550100/requestsHTTP/1.1Accept:application/xml
Host. example.com
Content-Type:application/xmlContent-Length:nnnn302398502
6.2.5.2.2Response
HTTP/1.12000K
Date:Thu,04Jun201002:52:00GMTContent-Type:application/xmlContent-Length: nnnn
<\\xmlversion-\1.0\encoding-\UTF-8\?>0
302398502
YD/T3191—2016
YD/T3191—2016
[1]YD/T1282-2003
设备技术要求
参考文献
900/1800MHzTDMA数字蜂窝移动通信网非结构化补充业务数据(USSD)中华人民共和国通信行业标准
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)
非结构化补充数据业务
YD/T3191—2016
人民邮电出版社出版发行
北京市丰台区成寿寺路11号邮电出版大厦邮政编码:100064
北京康利胶印厂印刷
版权所有不得翻印
开本:880×1230
印张:1
字数:22千字
2017年6月第1版
2017年6月北京第1次印刷
15115·1222
定价:10元
本书如有印装质量问题,
请与本社联系电话:(010)81055492
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。