UIM基线版本PC客户端接口说明SIP部分.doc

UIM基线版本PC客户端接口说明(SIP部分)
UIM基线版本PC客户端接口说明
(SIP部分)
Prepared by Date
拟制 日期
Reviewed by Date 评审人 日期
Approved by Date yyyy-mm-dd
批准 日期
Revision Record 修订记录
Date Revision CR ID Sec No. Change Description Author 日期 CR号 修改章节 修改描述 作者 Version
修订版本
开始编制
1. 范围
本规范规定了UIM基线版本PC客户端SIP相关部分间的通信机制及接口，是UIM基线版本PC客户端SIP应用部分各逻辑层数据通讯需要遵从的技术文件，为UIM基线版本PC客户端SIP应用架构的开发、维护提供技术依据。
2. 引用文件
本规范的编制遵循下列列表中的文件。
序号 标准编号 标准名称 发布单位
UIM基线版本PC客户端总体设计报告1
().doc
2
3 4 5 6 3. 缩略语定义
本文档所涉及的缩略语解释请参见下表。
缩略语 英文全名 中文解释
XML
SIP
4. 接口描述
因为UIM基线版本PC客户端SIP应用部分软件体系采用层设计模式，同时，SIP标准
协议及其扩展协议核心内容主要涉及，发送方发送请求并接受响应，接受方接受到请求并返回响应，故在定义一个功能接口时，先按一个请求数据流在各逻辑层间的流动顺序说明各逻辑层的接口参数，然后按接受方接受到该请求和发送方接受到响应的解析回调数据流在各逻辑层间的流动顺序说明各逻辑层的接口参数。
鉴于SIP标准协议及其扩展协议的请求和响应的多样性，而XML格式可以包容数据的多样性，所以本文件涉及绝大部分接口输入参数采用XML类型。这里规定:XML的元素标签以大写字母开头，元素的属性以小写母开头。

发送短消息/短信接口描述涉及到点对点、点对多的消息和短信的发送、接受和应答等，采用XML承载请求和响应的各种参数变化格式，是一个统一的格式，但消息体不能超过1300字节。

5. 接口定义



?标准IM短消息
?Schema
?Sample
<?xml version="" encoding="UTF-8"?>
<IMUIMsg>
<RecvList num= “1”>
<Entry uri= “sip:”/>
</RecvList>
<RealContent type= “text/plain”length=“31”>
Test IM Standardized Message !
</RealContent>
</IMUIMsg>
?参数说明
参数名 类型 范围 说明
RecvList num Unsigned 大于0 接受者列表数量，对于点对点只能是1
int
接受者的Sip URI Entry uri string
RealContent 消息体类型，对于标准消息只能是text/plain
string
type
Unsigned 消息体长度 RealContent 不大于
1300 length int
RealContent 消息体，对于标准消息只能是text string
?扩展短消息/短信
?Schema
?Sample
<?xml version="" encoding="UTF-8"?>
<IMUIMsg>
<RecvList num= “2”>
<Entry uri= “sip:”/>
<Entry uri= “sip:”/>
</RecvList>
<RealContent type= “Message/CPIM”>
<ExtBiz type=“IM” report=“Yes”/>
<Content type=“multipart/mixed”>
<SubContent type= “text/plain”length=“31”
charset=“UTF-8”transferencoding=“8bit”>
Test IM Standardized Message !
</SubContent>
<SubContent type=“image/jpeg”dispositio