YD/T 3187-2016
基本信息
标准号： YD/T 3187-2016
中文名称：基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)聊天业务
标准类别：通信行业标准(YD)
标准状态：现行
出版语种：简体中文
下载格式：.zip .pdf
相关标签： 基于 表述 状态 转移 技术 业务 能力 开放 应用 程序接口
标准分类号
关联标准
出版信息
相关单位信息
标准简介
YD/T 3187-2016.RESTful based service capability open API-chat.
1范围
YD/T 3187规定了基于表述性状态转移(REST)的针对聊天业务的API接口定义，包括接口数据结构、接口定义、接口流程和接口安全要求等。
YD/T 3187适用于提供聊天业务能力开放的应用程序接口(API) 。
2规范性引用文件
下列文件对于本文件的应用足必不可少的。凡事注日期的引用文件，仅注日期的版本适用于本文件。凡事不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。
YD/T 2423-2012基于表述性状态转移(REST) 技术的电信业务能力开放平台技术要求
OMA-ER-Autho4网络API投权框架(Authorization Framework for Network APIs)
API-V1_ 0
OMA-TS-REST_RESTful风格的网络API通用定义1.0版本(Common definitions for RESTful NetAPI_ Common Network )
IETF RFC 2392 内容标识和消息标识统一资 源定位符(Content-ID and Message-ID Unifor Resource Locators)
IETF RFC 2616 超文本传输协议一HTTP/1.1 (ypertext Transfer Protocol -- HTTP/1.1)
IETF RFC 3261 SIP:会话发起协议(SIP: Session Initiation Protocol)
IETF RFC 3966 电话号码的Tel URI (The tel URI for Telephone Numbers)
IETF RFC 3986 统一资源标示符(URI): 一般语法(Uniform Resource Identifier(URI): Generic Syntax)
1范围
YD/T 3187规定了基于表述性状态转移(REST)的针对聊天业务的API接口定义，包括接口数据结构、接口定义、接口流程和接口安全要求等。
YD/T 3187适用于提供聊天业务能力开放的应用程序接口(API) 。
2规范性引用文件
下列文件对于本文件的应用足必不可少的。凡事注日期的引用文件，仅注日期的版本适用于本文件。凡事不注日期的引用文件，其最新版本(包括所有的修改单)适用于本文件。
YD/T 2423-2012基于表述性状态转移(REST) 技术的电信业务能力开放平台技术要求
OMA-ER-Autho4网络API投权框架(Authorization Framework for Network APIs)
API-V1_ 0
OMA-TS-REST_RESTful风格的网络API通用定义1.0版本(Common definitions for RESTful NetAPI_ Common Network )
IETF RFC 2392 内容标识和消息标识统一资 源定位符(Content-ID and Message-ID Unifor Resource Locators)
IETF RFC 2616 超文本传输协议一HTTP/1.1 (ypertext Transfer Protocol -- HTTP/1.1)
IETF RFC 3261 SIP:会话发起协议(SIP: Session Initiation Protocol)
IETF RFC 3966 电话号码的Tel URI (The tel URI for Telephone Numbers)
IETF RFC 3986 统一资源标示符(URI): 一般语法(Uniform Resource Identifier(URI): Generic Syntax)
标准图片预览
标准内容
ICS33.040
中华人民共和国通信行业标准
YD/T3187—2016
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）聊天业务
RESTful based seryicecapability openAPI-chat(OMA-ERP-REST NetAPI Chat-V1 0-20130513-C RESTful Network API Chat vl.0, NEQ)2016-10-22 发布
中华人民共和国工业和信息化部2017-01-01实施
前言，
1范围．
2规范性引用文件
3术语、定义和缩略谱.
3.1术语和定义
3.2缩略语
聊天业务特征概述.
5状态呈现业务RESTfulAPI定义
5.1资源概述
枚举类型定义.
数据结构定义
5.4序列图..
一对一聊天。
群聊，
用户间的一对一聊天会话，
创建一对一消息
订阅消息通知
单一的消息订阅通知,
7.1群聊会话，
发送群聊内容.
群聊事件订阅管理.
7.4特定的群聊事件订阅管理
7.5聊天消息到达通知，
错误定义.
8.1业务异常...
8.2策略异常
9授权框架.1
使用Autho4API框架
9.2‘acr:auth'的用法
YD/T 3187—2016
YD/T 3187--2016
本标准足“基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）”系列标准之一，该系列标雅的结构及名称预计如下：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）短消息和多媒体消息业务部分：
基于表述性状态转移（REST）技术的业务能力F放应用程序接口（API）点击拨号：一基于表述性状态转移（REST）技术的业务能力T放应用程序接口（API）终端状态；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端能力信息：一基于表述性状态转移（REST）技术的业务能力T放应用程序接口（APJ）微博业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）搜索业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接！I（API）地址本：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）文件传输业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）定位业务：-基十表述性状态转移（REST）技术的业务能力元放应用程序接口（API）状态呈现业务；基」表述性状态转移（REST）技术的业务能力开放应用程序接口（API）聊天业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APT）用户信息业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）支付业务；一基」表述性状态转移（REST）技术的业务能力川放应用程序接口（API）视频共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）图片共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）移动互联网用户上下文感知业务：
基于表述性状态转移（REST）技术的业务能力放应用程序接II（API）非结构化补充数掂业务。
随着技术和市场的发展，还将根勘情说制定后续相关标准。本标准按照GB/1.1-2009给山的规则起草。本标准使用重新起草法参考OMA-ERP-REST_NetAPIChat-V10-20130513-C基于表述性状态转移（REST）技术的聊大业务应用程序接口（API）（OMARESTfulNetworkAPIChatyI.0）》编制，本标雅与0MA-ERP-RESTNetAPIChat-V10-20130513-C的-致性程度灯非等效。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准中中国通信标准化协会提出并口。本标准起草单位：中国移动通信集团公司、中国信息通信研究院、中国联合网络通信集团有限公司、中国电信集团公司。
本标准主要起草人：刘悦、庞亚昆、杨波、赵婷、汗洋。1范围
基于表述性状态转移（REST）技术的YD/T3187—2016
业务能力开放应用程序接口（API）聊天业务本标准规定了基于表述性状态转移（REST）的针对聊天业务的API接口定义，包括接口数结构、接口定义、接口流程和接口安全要求等。本标准适用于提供聊天业务能力并放的应用程序接口（API）。2规范性引用文件
下列文件对于不文件的应旧是必不可少的。凡事注口期的引用文件，仪注日期的版本适用于本义件。凡事不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。YD/T2423-2012
基于表述性状态转移（REST）技术的电信业务能力开放平台技术要求OMA-ER-Autho4
络API授权框架（AuthorizationFramework forNetwork APIs）API-VI 0
OMA-TS-REST
NetAPI Conmon
IETFRFC2392
IETFRFC2616
IETFRFC3261
IETFRFC 3966
IETFRFC3986
IETFRFC4627
IETF RFC 4975
XMLSchemal
XMLSchenma2
RESTful风格的网络API通用定义1.o版本（CommondefinitionsforRESTfulNetwork)
内容标识和消息标识统一资源定位符（Content-IDandMessage-IDUniformResource Locators)
超文木传输协议——HTTP/1.1（ypertextTransferProtocol --HTTP/1.1）SIP:会话发起协议（SIP：SessionInitiationProtocol）电话号码的TelURI（ThetelURIforTelephoneNumbers）统一资源标示符（URI）：般语法（UniformResourceIdentifier（URI）：GenericSymtax)
Java描述语言对象符号的应用/基于java描述语言的轻量级数据交换格式（Theapplication/json Media Type for JavaScript Objeet Notalion (JSON))消息会话中继协议（MSRP）（TheMessage SessionRelayProtocol（MSRP)）可扩展标识语言架构第1部分：结构（第二版）（W3CXMLSehemaDefinitionLanguage (XSD) 1.1 Part l: Structures Second Edition)可扩展标识语言架构第2部分（W3CXMLSchemaDefinitionLanguagc（XSD）1.1 Part 2:Datatypes)
YD/T 3187 2016
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适州于本文件。3.1.1
表述性状态转移Representational StateTransfer一种针对网络应用的设计和开发方式，指的是：组架构约束条件和原则，可以降低开发的复杂性，提高系统的可仰缩性。见YD/T2423-2012。3.1.2
Web服务Web Service
-种构建应用程序的普遍模型,可以在何支持网络通信的操作系统中实施运行：是种新的Web应用程序分支，是自包含、自摘述、模块化的应用，可以发布、定位、通过Web调用。3.1.3
简单对象访问协议SimpleObjectAccessProtocol一种轻量的、简单的、基于XML的协议，它被设计成在WEB上交换结构化的和固化的信息。3.2缩略语
下列缩略语适用丁本义件。
Anonymous Customcr RefercnceApplicationProgramming lnterfaceHyperText Transfcr Protocol
Identitifer
JavaScript Objcct Notation
MultipurposelntermetMailExtensionsOpen Mobile Alliance
REpresentational State TransferStatic Conformancc RequiremcntsTechnical Specification
UniformResoureLocator
eXtensible Markup Language
XML Schenia Definition
4聊天业务特征概述
聊天业务通过并放接口能够提供以下业务特征：2
磨名客户参考
应用程序编程接门
超文本传输协议
基于JavaScript语言的轻量级的数据交换格式多功能因特网邮件护充
开放移动联盟
表述性状态转移
静态一致性需求
技术规范
统一资源定位符
可扩展性标记语言
XML模式定义
应用发起建文对聊天：
应用发起建立：对多聊大：
应用直接发送一对，聊人内容，或通过已建立的一对多聊天发送聊天内容：c）
应用订阅已发送聊天内容的处理状态通知；d)
应用接收已建立聊天内容的响应消息。5状态呈现业务RESTfulAPI定义
5.1资源概述
水节概要描述了图片共享的RESTfulAPI所用到的资源。YD/T 3187--2016
本标准中URL变量“apiVersion\的取值为\vI\表明该API对应了·本标准。L'RL变量“apiVersion”的语义定义,OMA-TS-RESTNetAPI.Common-Vl 0。图1所示为图片共享RESTfulAPI的资源树结构图。注：资源树实线框所示的节点表示该节点有关联的 HTTP方法。As ervar oayhatpeversiong rhus enong
Aathserk
esteda
Amessagelep
Reservedvue
otosdo
Kpanesperia o
maxges
segeFa
图1聊天业务RESTfulAPI资源结构4
YD/T 3187-—2016
表1给出了本标准中定义的资源的概述，非数据类型表示和允许的HTTP方法，其中数据结构的具体定义见第5.3节。
客户端算理聊天通知的订阅的资源概述见表1，表1客户端管理聊天通知的订阅
茶础URL：
所有卿天事件
通知的订阅
单独聊天事件
通知的订阅
http://(serverRoot)
/chat/(apiVersion)/
asertd
/subscriptions
fsubscriptions/isubs
criptionld
数据结构
ChatSubscriptionList
（月于GET）
ChatNotificationSubse
ription
(HI于POST)
common:ResourceRef
erence（在POST响应
中条件可选）
ChatNotificationSubsc
riplion
允许客户端管理对一聊天的资源概述见表2。GET
读活跃的卿大
通知订阅列表
读一个单独的
聊天逆知订阅
表2充许客户端管理一对一聊天
基URL
htip://(serverRoot)
Icha/(apiVersion)/
userid/oneToOne
所有两个用户
之间的对
聊大会证
单一的一对
聊天会话
/otherUserld)
(otherUserld)/[ses
sionld)
(otherUserild)/(ses
对一聊天会www.bzxz.net
话状态
siontdy/status
数据结构
ChatSessionInfomation
(TPOST)
common:ResourceRefer
ence（在POST的响
条件可选）
ChatSessionInformation
ParticipantSessionStatus
读一对
-聊天
会话的
夏P方法
创建新的
聊天通知
款方法
接受·对·聊
大会话邀请
DELELE
取消订阅并停
止和此订阅相
关的通知
创建一个
—对-·聊
天会讲
取消邀请
（发起方）
或拖绝邀请
（接收方）
或终止会话
将·对聊天
扩展为群螂
表2允许客户端管理一对一聊天（续）tm:/ncrerRoot)
/chat/(apiVersion
userid)/oneToOne
aiherUserld)/(ses
sionid//extend
微据结构
ParticipantList
ExtensionParameters
允诈客户端管理一对·聊天消息的资源概述见表3。no
表3允许客户端管理一对一聊天消息础R
htip//(scryerRoot)/c
haVtapiVeniony/
fuseridy/oneToOne/
otherUserldy
sessionld
·对 聊天
中的聊天消
-对·聊天
/messages
数据结构
ChatMessage,Outgoing
MultimediaChatMessage,
IsComposing(H丁POST)
common:ResourceRefcren
ce（在POST响中条件
可选）
/messages/(messagel /
MessageStalusReport
中的单·消dy/status
总状态
messageid见1FTF
RFC2392
允许客户端管埋群聊会话的资源概述见表4。no
读·个聊
天游息的
表4充许客户端管理群聊会话
E础URL
http:/serveRoot
fchatapiVersion
fuserld
所有的群聊
单一的群聊
Igroup/ (sessionId)
数据结构
GroupChatSessionlnfor
mation（用于POST)
comman:ResourceRefer
nc（在POST响应中条
件可选）
GroupChatSessionlnfor
mation
允许客户端管理群聊参与者的资源概述见表5。no
获收群聊会
话信息
HP方法
YD/T 3187—2016
将一对
聊天扩展
为群聊
报·个
唧天消息
的状态
创建（发
送）个聊
天消息
新的群聊
DBLETE
取消群聊会话（发
起方）或终结群聊
会话（发起方）
YD/T3187—2016
基础ORL
http://tserverRooty/
chat/(apiVersion)/f
tuserid)/greup/(acss
所有烊聊会话
的参与名
单一的群聊参
单一的群聊参
与者状态
/parlicipants
/patticipants/tpartic
ipantidj
/participants/ (partic
ipantId)/status
表5允许客户端管理群聊参与者
数据结构
ParticipantList（用」
GFT) ParticipantList
ParticipantItufarmation
(H十POST）
common:ResourceRef
erence（在POST响应
中条件可选）
Participantinformation
ParticipantSession
Stalus
允许客户端管埋群聊消息的资源概述见表6。OBT
读群聊参
异的列衣
读一个单—
辩聊参与者
的信息
接受群聊邀
表6充许客户端管理群聊消息
基础URL：
htp://(serverRoot)/
chat/(apr Version
fuserld/group/
群聊会话中的
聊天消息
/messages
数据结构
ChatMessagc,Outgoing MultinediaChatMessagc,IsComposing（用7-POsT）comnon:ResourccReference（f:POST响应中条件可选）
允许客广端接收聊人通知的资源概述见表7。表7允许客户端接收聊天通知
通知客户端有
收到的消息
基URL
当订阅被创建或配
置时由案户端指定
数据结构
ChatMessageNotificatian
群聊会话
中添加个
或多个参』
者或重新加
入：·个会话
DPLETE
从群聊中移
除参与者
（发起方）
或拒绝群聊
邀请（接收
方）或离
群卿会话
(参与者）
创建一个
聊天消息
H装P方法
通知客户端有收
到的消息
通判客户端消
息状态
通知客户端有
一对一聊天邀
通知客户端有
群聊邀请
通知客户端聊
天会话事件
通知客户端群
聊参与者状态
通知客户端订
阅取消
逆知客户端收
到多媒体消息
由客户端指定>
表7允许客户端接收聊天通知（续）数据结构
当订阅被创建或配
置时出客户端指定
当订阅被创建或配
置时山客户端指定
当订阅被创建或配
置时由客端指定
当订阅被创建或配
置时由客户端指定
当订阅被创建或配
置时由容户端指定
当订阅被创建或配
置时由客户端指定
当订阅被创建或配
置时由客户端指定
5.2枚举类型定义
ParticipantStatus
ChatMessageStatus
Notification
ChaiSessionInvitation
Notification
GroupChatSessian
InvitationNotification
ChalEventNotification
ChatParticipantStatus
Notification
ChatSubscription
CancellationNolification
MultimcdiaChatMessage
Notification
该参数为枚举炎型，描述聊天参与者状态的可能值。具体见表8。表8ParticipantStatus：枚举
枚举值
Invited
Cornected
Disconnccled
5.2.2EventType
参与者已被邀请加入一个会话
参与者已进入一个会语
参与者已与个会话断开
该参数为枚举类型。描述通知的事件类型。具体见表9。表9EventType：枚举
SessionCancelled
SessionEnded
Declined
Accepted
Tineout
Unteachable
YD/T3187—2016
HTTP方法
通知客户端一个
聊天消息已被发
通知客户端有
对一聊天邀请
通知客户端有群
聊邀请
通知客户端聊天
会话事件
通知客端群聊
参与者状态变化
通知客户端订阅
取消（如超时）
通知客户端收到
多媒体消总
The Originator has cancelled the chal session during the invite phase (in Confirmed 1-l Chatand in group chat)
The session has cnded (in Confirmed 1-I Chat and in group chal)The Participant has declined the chat session invite (only in Confirmed I-1 Chat)The Participant has acceptcd thc chal invite (only in Confirmcd 1-I Chat)The session invitation to the Participant has timed out (only in Confirmed I-1 Chat)The Participant could not be reached or is unknown (only in Confirmed 1-I Chat)7
YD/T 3187—2016
5.2.3MessageStatus
该参数为枚举类型。描述消息状态的可能类型。具体见表10。表10MessageStatus：枚举
Delivered
Displayed
Failed
消息被发往网络的第一跳节点，但尚未到达接收方消息的起始状态，不能被川于客户端的PUT请求中
消息已送达接收方客-端与IETFRFC5438中的“已送达”或IETF RFC 4975中的成功报件（“Success-Rcport-yes\）剂对应，只被用于服务器发送通知，不能川于客户端的PUT操作消息已被客户端展示。“IETFRFC5438中的“已展示”对应消总没行被逆送给客户端。只被用于服务器发送通知，不能用于客户端的PUT操作中与IETFRFC49754的失败报告（\Failure-Report-yes\）相对应，或者任何在实现中检测到的可能错误中5.3数据结构定义
5.3.1 ChatSubscriptionList
描述聊天通知订阅列表的信息。具体见表11。表 11 ChatSubscriptionList
chalNotificationSubscriplionresourceURL
ChalNotificationSubseriplion[0..unbounded]
sd:anyURI
5.3.2 ChatNotificationSubscription必选
描述与聊人相关的事件通知订阅的信息。具体见表12。聊大通知订阅数纠
白相关URL
表12ChatNotificationSubscription参数名
callbackReferencc
ConfirmedChat
Supported
AdhocChal
Supportcd
参数类型
common:CallbackReference
xsd:boolean
xsd:boolean
必选/可选
客户端的通知URL和可选的回调数据在资源创建请求中，这个标识光诉服务器这个客户端支持一对聊天
在创建府的资源，客户端创建一对会话请求时将此位设为真，若服务器支持对一聊关，则将服务器上的该标识也设为真默认值为假
在资源创建请求中，这个标识告诉服务器这个客户端支持ad-hoc模式对一聊天在创键后的资源中，客户端创建ad-hoc模式一对一会话请求时将此位设为真，若服务器支持ad-hoc模式--对---聊大，则将服务器1:的该标识也设为真
默认值为真
参数名
duration
clicnCorrclator
resourceURL
表12ChatNotificationSubscription（续）参教类型
xsd:int
xsd:string
xsd:anyURI
5.3.3ChatEventNotification
必选/可选
YD/T 3187—2016
提供通知的时段
个创建资源过程中客户端可以用丁标记特定资源的计数器
白相URL
描述描述聊天事件的通知，述的事件没有任何特定参数限制。具体见表13。表13ChatEventNotification
参数类型必选/可选
callbackData
eventType
eventDescription
xsd:string
common:Link[0..unbounded]
EventTypc
xsd:string
5.3.4ChatSessionlnvitationNotification必选
描述一对一聊天会话邀消的通知。具体见表14。当创建·个关于聊大事仆的通知的订阅时，该参数在callbackRcference中的应用被携带。见OMA-TS-REST NetAPI_Cotmmon
与通知相关的其他资源的链接（如与聊天会话相关）事件类型
事件的义本据述
表14ChatSessionlnvitationNotification名敏类型必选用选
callbackDala
subject
oniginalorAddress
originatorNamc
tParticipanlAddrcss
tParticipantName
initialMessage
initialMultimedia
Message
xsd:string
common:Link
[o..unbounded]
xsd:string
xsdianyURI
xsd:string
xsd:anyUR[
xsd:string
ChatMessagc
InconingMultimcdia
ChatMessagc
条件可选
条件可选
\创一个关于聊天事件的通知的订阅时，该参数在“callbackReference'中的成用被携带。见OMA-TS-REST NeLAPI Common
与通知相关的其他资源的链接（如与聊天会话相关）服务器必须包含表示真实通知源的该参数。固时，服务器应齿包含与计阅相关的该参数聊天会话的出题
发起方的地址（如sipURI、telURI或acr URI）。见IETF RFC 3261、IETF RFC 3966及[FTF RFC 3986人类可读的发起方名学
接收方的地圳：（如sipURI、telURJ或acrURI）人类可读的接收方名字
在会话的邀请中他含第一条聊人消息，可选在会话的邀请中包含第一条多媒体消息：可选9
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。
中华人民共和国通信行业标准
YD/T3187—2016
基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APD）聊天业务
RESTful based seryicecapability openAPI-chat(OMA-ERP-REST NetAPI Chat-V1 0-20130513-C RESTful Network API Chat vl.0, NEQ)2016-10-22 发布
中华人民共和国工业和信息化部2017-01-01实施
前言，
1范围．
2规范性引用文件
3术语、定义和缩略谱.
3.1术语和定义
3.2缩略语
聊天业务特征概述.
5状态呈现业务RESTfulAPI定义
5.1资源概述
枚举类型定义.
数据结构定义
5.4序列图..
一对一聊天。
群聊，
用户间的一对一聊天会话，
创建一对一消息
订阅消息通知
单一的消息订阅通知,
7.1群聊会话，
发送群聊内容.
群聊事件订阅管理.
7.4特定的群聊事件订阅管理
7.5聊天消息到达通知，
错误定义.
8.1业务异常...
8.2策略异常
9授权框架.1
使用Autho4API框架
9.2‘acr:auth'的用法
YD/T 3187—2016
YD/T 3187--2016
本标准足“基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）”系列标准之一，该系列标雅的结构及名称预计如下：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）短消息和多媒体消息业务部分：
基于表述性状态转移（REST）技术的业务能力F放应用程序接口（API）点击拨号：一基于表述性状态转移（REST）技术的业务能力T放应用程序接口（API）终端状态；一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）终端能力信息：一基于表述性状态转移（REST）技术的业务能力T放应用程序接口（APJ）微博业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）搜索业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接！I（API）地址本：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）文件传输业务：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）定位业务：-基十表述性状态转移（REST）技术的业务能力元放应用程序接口（API）状态呈现业务；基」表述性状态转移（REST）技术的业务能力开放应用程序接口（API）聊天业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（APT）用户信息业务：基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）支付业务；一基」表述性状态转移（REST）技术的业务能力川放应用程序接口（API）视频共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）图片共享：一基于表述性状态转移（REST）技术的业务能力开放应用程序接口（API）移动互联网用户上下文感知业务：
基于表述性状态转移（REST）技术的业务能力放应用程序接II（API）非结构化补充数掂业务。
随着技术和市场的发展，还将根勘情说制定后续相关标准。本标准按照GB/1.1-2009给山的规则起草。本标准使用重新起草法参考OMA-ERP-REST_NetAPIChat-V10-20130513-C基于表述性状态转移（REST）技术的聊大业务应用程序接口（API）（OMARESTfulNetworkAPIChatyI.0）》编制，本标雅与0MA-ERP-RESTNetAPIChat-V10-20130513-C的-致性程度灯非等效。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准中中国通信标准化协会提出并口。本标准起草单位：中国移动通信集团公司、中国信息通信研究院、中国联合网络通信集团有限公司、中国电信集团公司。
本标准主要起草人：刘悦、庞亚昆、杨波、赵婷、汗洋。1范围
基于表述性状态转移（REST）技术的YD/T3187—2016
业务能力开放应用程序接口（API）聊天业务本标准规定了基于表述性状态转移（REST）的针对聊天业务的API接口定义，包括接口数结构、接口定义、接口流程和接口安全要求等。本标准适用于提供聊天业务能力并放的应用程序接口（API）。2规范性引用文件
下列文件对于不文件的应旧是必不可少的。凡事注口期的引用文件，仪注日期的版本适用于本义件。凡事不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。YD/T2423-2012
基于表述性状态转移（REST）技术的电信业务能力开放平台技术要求OMA-ER-Autho4
络API授权框架（AuthorizationFramework forNetwork APIs）API-VI 0
OMA-TS-REST
NetAPI Conmon
IETFRFC2392
IETFRFC2616
IETFRFC3261
IETFRFC 3966
IETFRFC3986
IETFRFC4627
IETF RFC 4975
XMLSchemal
XMLSchenma2
RESTful风格的网络API通用定义1.o版本（CommondefinitionsforRESTfulNetwork)
内容标识和消息标识统一资源定位符（Content-IDandMessage-IDUniformResource Locators)
超文木传输协议——HTTP/1.1（ypertextTransferProtocol --HTTP/1.1）SIP:会话发起协议（SIP：SessionInitiationProtocol）电话号码的TelURI（ThetelURIforTelephoneNumbers）统一资源标示符（URI）：般语法（UniformResourceIdentifier（URI）：GenericSymtax)
Java描述语言对象符号的应用/基于java描述语言的轻量级数据交换格式（Theapplication/json Media Type for JavaScript Objeet Notalion (JSON))消息会话中继协议（MSRP）（TheMessage SessionRelayProtocol（MSRP)）可扩展标识语言架构第1部分：结构（第二版）（W3CXMLSehemaDefinitionLanguage (XSD) 1.1 Part l: Structures Second Edition)可扩展标识语言架构第2部分（W3CXMLSchemaDefinitionLanguagc（XSD）1.1 Part 2:Datatypes)
YD/T 3187 2016
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适州于本文件。3.1.1
表述性状态转移Representational StateTransfer一种针对网络应用的设计和开发方式，指的是：组架构约束条件和原则，可以降低开发的复杂性，提高系统的可仰缩性。见YD/T2423-2012。3.1.2
Web服务Web Service
-种构建应用程序的普遍模型,可以在何支持网络通信的操作系统中实施运行：是种新的Web应用程序分支，是自包含、自摘述、模块化的应用，可以发布、定位、通过Web调用。3.1.3
简单对象访问协议SimpleObjectAccessProtocol一种轻量的、简单的、基于XML的协议，它被设计成在WEB上交换结构化的和固化的信息。3.2缩略语
下列缩略语适用丁本义件。
Anonymous Customcr RefercnceApplicationProgramming lnterfaceHyperText Transfcr Protocol
Identitifer
JavaScript Objcct Notation
MultipurposelntermetMailExtensionsOpen Mobile Alliance
REpresentational State TransferStatic Conformancc RequiremcntsTechnical Specification
UniformResoureLocator
eXtensible Markup Language
XML Schenia Definition
4聊天业务特征概述
聊天业务通过并放接口能够提供以下业务特征：2
磨名客户参考
应用程序编程接门
超文本传输协议
基于JavaScript语言的轻量级的数据交换格式多功能因特网邮件护充
开放移动联盟
表述性状态转移
静态一致性需求
技术规范
统一资源定位符
可扩展性标记语言
XML模式定义
应用发起建文对聊天：
应用发起建立：对多聊大：
应用直接发送一对，聊人内容，或通过已建立的一对多聊天发送聊天内容：c）
应用订阅已发送聊天内容的处理状态通知；d)
应用接收已建立聊天内容的响应消息。5状态呈现业务RESTfulAPI定义
5.1资源概述
水节概要描述了图片共享的RESTfulAPI所用到的资源。YD/T 3187--2016
本标准中URL变量“apiVersion\的取值为\vI\表明该API对应了·本标准。L'RL变量“apiVersion”的语义定义,OMA-TS-RESTNetAPI.Common-Vl 0。图1所示为图片共享RESTfulAPI的资源树结构图。注：资源树实线框所示的节点表示该节点有关联的 HTTP方法。As ervar oayhatpeversiong rhus enong
Aathserk
esteda
Amessagelep
Reservedvue
otosdo
Kpanesperia o
maxges
segeFa
图1聊天业务RESTfulAPI资源结构4
YD/T 3187-—2016
表1给出了本标准中定义的资源的概述，非数据类型表示和允许的HTTP方法，其中数据结构的具体定义见第5.3节。
客户端算理聊天通知的订阅的资源概述见表1，表1客户端管理聊天通知的订阅
茶础URL：
所有卿天事件
通知的订阅
单独聊天事件
通知的订阅
http://(serverRoot)
/chat/(apiVersion)/
asertd
/subscriptions
fsubscriptions/isubs
criptionld
数据结构
ChatSubscriptionList
（月于GET）
ChatNotificationSubse
ription
(HI于POST)
common:ResourceRef
erence（在POST响应
中条件可选）
ChatNotificationSubsc
riplion
允许客户端管理对一聊天的资源概述见表2。GET
读活跃的卿大
通知订阅列表
读一个单独的
聊天逆知订阅
表2充许客户端管理一对一聊天
基URL
htip://(serverRoot)
Icha/(apiVersion)/
userid/oneToOne
所有两个用户
之间的对
聊大会证
单一的一对
聊天会话
/otherUserld)
(otherUserld)/[ses
sionld)
(otherUserild)/(ses
对一聊天会www.bzxz.net
话状态
siontdy/status
数据结构
ChatSessionInfomation
(TPOST)
common:ResourceRefer
ence（在POST的响
条件可选）
ChatSessionInformation
ParticipantSessionStatus
读一对
-聊天
会话的
夏P方法
创建新的
聊天通知
款方法
接受·对·聊
大会话邀请
DELELE
取消订阅并停
止和此订阅相
关的通知
创建一个
—对-·聊
天会讲
取消邀请
（发起方）
或拖绝邀请
（接收方）
或终止会话
将·对聊天
扩展为群螂
表2允许客户端管理一对一聊天（续）tm:/ncrerRoot)
/chat/(apiVersion
userid)/oneToOne
aiherUserld)/(ses
sionid//extend
微据结构
ParticipantList
ExtensionParameters
允诈客户端管理一对·聊天消息的资源概述见表3。no
表3允许客户端管理一对一聊天消息础R
htip//(scryerRoot)/c
haVtapiVeniony/
fuseridy/oneToOne/
otherUserldy
sessionld
·对 聊天
中的聊天消
-对·聊天
/messages
数据结构
ChatMessage,Outgoing
MultimediaChatMessage,
IsComposing(H丁POST)
common:ResourceRefcren
ce（在POST响中条件
可选）
/messages/(messagel /
MessageStalusReport
中的单·消dy/status
总状态
messageid见1FTF
RFC2392
允许客户端管埋群聊会话的资源概述见表4。no
读·个聊
天游息的
表4充许客户端管理群聊会话
E础URL
http:/serveRoot
fchatapiVersion
fuserld
所有的群聊
单一的群聊
Igroup/ (sessionId)
数据结构
GroupChatSessionlnfor
mation（用于POST)
comman:ResourceRefer
nc（在POST响应中条
件可选）
GroupChatSessionlnfor
mation
允许客户端管理群聊参与者的资源概述见表5。no
获收群聊会
话信息
HP方法
YD/T 3187—2016
将一对
聊天扩展
为群聊
报·个
唧天消息
的状态
创建（发
送）个聊
天消息
新的群聊
DBLETE
取消群聊会话（发
起方）或终结群聊
会话（发起方）
YD/T3187—2016
基础ORL
http://tserverRooty/
chat/(apiVersion)/f
tuserid)/greup/(acss
所有烊聊会话
的参与名
单一的群聊参
单一的群聊参
与者状态
/parlicipants
/patticipants/tpartic
ipantidj
/participants/ (partic
ipantId)/status
表5允许客户端管理群聊参与者
数据结构
ParticipantList（用」
GFT) ParticipantList
ParticipantItufarmation
(H十POST）
common:ResourceRef
erence（在POST响应
中条件可选）
Participantinformation
ParticipantSession
Stalus
允许客户端管埋群聊消息的资源概述见表6。OBT
读群聊参
异的列衣
读一个单—
辩聊参与者
的信息
接受群聊邀
表6充许客户端管理群聊消息
基础URL：
htp://(serverRoot)/
chat/(apr Version
fuserld/group/
群聊会话中的
聊天消息
/messages
数据结构
ChatMessagc,Outgoing MultinediaChatMessagc,IsComposing（用7-POsT）comnon:ResourccReference（f:POST响应中条件可选）
允许客广端接收聊人通知的资源概述见表7。表7允许客户端接收聊天通知
通知客户端有
收到的消息
基URL
当订阅被创建或配
置时由案户端指定
数据结构
ChatMessageNotificatian
群聊会话
中添加个
或多个参』
者或重新加
入：·个会话
DPLETE
从群聊中移
除参与者
（发起方）
或拒绝群聊
邀请（接收
方）或离
群卿会话
(参与者）
创建一个
聊天消息
H装P方法
通知客户端有收
到的消息
通判客户端消
息状态
通知客户端有
一对一聊天邀
通知客户端有
群聊邀请
通知客户端聊
天会话事件
通知客户端群
聊参与者状态
通知客户端订
阅取消
逆知客户端收
到多媒体消息
由客户端指定>
表7允许客户端接收聊天通知（续）数据结构
当订阅被创建或配
置时出客户端指定
当订阅被创建或配
置时山客户端指定
当订阅被创建或配
置时由客端指定
当订阅被创建或配
置时由客户端指定
当订阅被创建或配
置时由容户端指定
当订阅被创建或配
置时由客户端指定
当订阅被创建或配
置时由客户端指定
5.2枚举类型定义
ParticipantStatus
ChatMessageStatus
Notification
ChaiSessionInvitation
Notification
GroupChatSessian
InvitationNotification
ChalEventNotification
ChatParticipantStatus
Notification
ChatSubscription
CancellationNolification
MultimcdiaChatMessage
Notification
该参数为枚举炎型，描述聊天参与者状态的可能值。具体见表8。表8ParticipantStatus：枚举
枚举值
Invited
Cornected
Disconnccled
5.2.2EventType
参与者已被邀请加入一个会话
参与者已进入一个会语
参与者已与个会话断开
该参数为枚举类型。描述通知的事件类型。具体见表9。表9EventType：枚举
SessionCancelled
SessionEnded
Declined
Accepted
Tineout
Unteachable
YD/T3187—2016
HTTP方法
通知客户端一个
聊天消息已被发
通知客户端有
对一聊天邀请
通知客户端有群
聊邀请
通知客户端聊天
会话事件
通知客端群聊
参与者状态变化
通知客户端订阅
取消（如超时）
通知客户端收到
多媒体消总
The Originator has cancelled the chal session during the invite phase (in Confirmed 1-l Chatand in group chat)
The session has cnded (in Confirmed 1-I Chat and in group chal)The Participant has declined the chat session invite (only in Confirmed I-1 Chat)The Participant has acceptcd thc chal invite (only in Confirmcd 1-I Chat)The session invitation to the Participant has timed out (only in Confirmed I-1 Chat)The Participant could not be reached or is unknown (only in Confirmed 1-I Chat)7
YD/T 3187—2016
5.2.3MessageStatus
该参数为枚举类型。描述消息状态的可能类型。具体见表10。表10MessageStatus：枚举
Delivered
Displayed
Failed
消息被发往网络的第一跳节点，但尚未到达接收方消息的起始状态，不能被川于客户端的PUT请求中
消息已送达接收方客-端与IETFRFC5438中的“已送达”或IETF RFC 4975中的成功报件（“Success-Rcport-yes\）剂对应，只被用于服务器发送通知，不能川于客户端的PUT操作消息已被客户端展示。“IETFRFC5438中的“已展示”对应消总没行被逆送给客户端。只被用于服务器发送通知，不能用于客户端的PUT操作中与IETFRFC49754的失败报告（\Failure-Report-yes\）相对应，或者任何在实现中检测到的可能错误中5.3数据结构定义
5.3.1 ChatSubscriptionList
描述聊天通知订阅列表的信息。具体见表11。表 11 ChatSubscriptionList
chalNotificationSubscriplionresourceURL
ChalNotificationSubseriplion[0..unbounded]
sd:anyURI
5.3.2 ChatNotificationSubscription必选
描述与聊人相关的事件通知订阅的信息。具体见表12。聊大通知订阅数纠
白相关URL
表12ChatNotificationSubscription参数名
callbackReferencc
ConfirmedChat
Supported
AdhocChal
Supportcd
参数类型
common:CallbackReference
xsd:boolean
xsd:boolean
必选/可选
客户端的通知URL和可选的回调数据在资源创建请求中，这个标识光诉服务器这个客户端支持一对聊天
在创建府的资源，客户端创建一对会话请求时将此位设为真，若服务器支持对一聊关，则将服务器上的该标识也设为真默认值为假
在资源创建请求中，这个标识告诉服务器这个客户端支持ad-hoc模式对一聊天在创键后的资源中，客户端创建ad-hoc模式一对一会话请求时将此位设为真，若服务器支持ad-hoc模式--对---聊大，则将服务器1:的该标识也设为真
默认值为真
参数名
duration
clicnCorrclator
resourceURL
表12ChatNotificationSubscription（续）参教类型
xsd:int
xsd:string
xsd:anyURI
5.3.3ChatEventNotification
必选/可选
YD/T 3187—2016
提供通知的时段
个创建资源过程中客户端可以用丁标记特定资源的计数器
白相URL
描述描述聊天事件的通知，述的事件没有任何特定参数限制。具体见表13。表13ChatEventNotification
参数类型必选/可选
callbackData
eventType
eventDescription
xsd:string
common:Link[0..unbounded]
EventTypc
xsd:string
5.3.4ChatSessionlnvitationNotification必选
描述一对一聊天会话邀消的通知。具体见表14。当创建·个关于聊大事仆的通知的订阅时，该参数在callbackRcference中的应用被携带。见OMA-TS-REST NetAPI_Cotmmon
与通知相关的其他资源的链接（如与聊天会话相关）事件类型
事件的义本据述
表14ChatSessionlnvitationNotification名敏类型必选用选
callbackDala
subject
oniginalorAddress
originatorNamc
tParticipanlAddrcss
tParticipantName
initialMessage
initialMultimedia
Message
xsd:string
common:Link
[o..unbounded]
xsd:string
xsdianyURI
xsd:string
xsd:anyUR[
xsd:string
ChatMessagc
InconingMultimcdia
ChatMessagc
条件可选
条件可选
\创一个关于聊天事件的通知的订阅时，该参数在“callbackReference'中的成用被携带。见OMA-TS-REST NeLAPI Common
与通知相关的其他资源的链接（如与聊天会话相关）服务器必须包含表示真实通知源的该参数。固时，服务器应齿包含与计阅相关的该参数聊天会话的出题
发起方的地址（如sipURI、telURI或acr URI）。见IETF RFC 3261、IETF RFC 3966及[FTF RFC 3986人类可读的发起方名学
接收方的地圳：（如sipURI、telURJ或acrURI）人类可读的接收方名字
在会话的邀请中他含第一条聊人消息，可选在会话的邀请中包含第一条多媒体消息：可选9
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。