行业移动平台组件接口设计说明书.doc

移动平台组件接口设计说明书移动平台接口设计说明书1. 概述1.1. 文档概述本文档描述了短信平台与第三方IT系统交互的短信接口。1.2. 术语定义和缩略语缩写词英文解析中文解析CRMCustomer Relationship Managerment客户资源管理ERPEnterprise Resource Planning企业资源规划FTPFile Transfer Protocol文件传输协议GPRSGeneral Packet Radio Service通用无线分组业务HTTPHypertext Transfer Protocol超文本传输协议HTTPSSecure HTTP加密的HTTP协议SOAPSimple Object Access Protocol简单对象访问协议OAOffice Automation办公自动化2. 接口说明2.1. 短消息接口2.1.1. 接口说明第三方IT系统通过此接口收发短消息。WebService方式通信收到第三方IT系统的发送请求后，通过短信平台中的SMS通信协议模块发送SMS；当从SMS通信协议模块收到SMS后，通过此接口将短消息发送给第三方IT系统。2.1.2. 流程说明短消息接口包括发送和接收两个流程。图1-1 短消息发送流程示意图发送短信由第三方IT系统发起，通过sendSms操作实现。在提交短信发送请求之后，第三方IT系统可以主动获取短信发送状态（getSmsDeliveryStatus操作），或由短信平台调用接口通知第三方IT系统发送状态（notifySmsDeliveryStatus操作）。图1-2 短消息接收流程示意图接收短信可以通过两种方式，一种是由第三方IT系统发起（GetReceivedSms操作），然后短信平台将所接收到的短信发往该第三方IT系统；第二种是由第三方IT系统提前注册接口，然后短信平台调用接口(NotifySmsReceptions)通知第三方IT系统接有上行短信(无特殊要求目前采用第一种方式)2.1.3. 数据类型定义. 短信实体(SMSMessage)定义1、 Message：短信正文（string）2、 ReceivedAddress：接收方地址（string）3、 SendAddress：发送方地址（string）4、 MessageFormat:编码格式(int)5、 ChannelID:通道编号. 短信发送状态(DeliveryStatus)定义枚举值参数描述0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus已发送,等待状态报告。3DeliveryFailed发送失败。. 短信发送状态实体(DeliveryInformation)定义1、 DeliveryStatus：发送状态（DeliveryStatus）2、 ReceivedAddress：接收方地址（string）3、StatusCode：状态码，如果发送失败可确定错误原因（string）2.1.4. 短信发送接口. 调用方式：接口接口定义发起方落地方说明发送短信sendSms第三方IT系统短信平台发送文件sendFile第三方IT系统短信平台发送之前文件必须通过ftp 上传到短信平台上,文件可重复使用.发送点点通文件sendPPFile第三方IT系统短信平台发送之前文件必须通过ftp 上传到短信平台上,文件可重复使用.获取发送状态GetSmsDeliveryStatus第三方IT系统短信平台通知发送状态NotifySmsDeliveryStatus短信平台第三方IT系统第三方IT系统必须提前注册对应的接口. 接口定义.1. 发送短信接口(sendSms)发起方：第三方IT系统落地方：短信平台string sendSms(string OperatorID,string Password,string DestinationAddresses, string Message,string WapPushurl,int MessageFormat,int SendMethod,String ExtendCode,bool DeliveryResultRequest,string ChannelID)备注： .1.1. 请求参数定义参数类型可选性描述OperatorIDxsd:stringM操作员IDPasswordxsd:stringM操作员密码DestinationAddressesxsd:string M短消息要被发送到的地址。多个号码以”,”隔开。ExtendCodexsd:stringO内部扩展号码。Messagexsd:stringM在短消息中发送的文本。为十六进制字符串WapPushUrlxsd:stringO发送WapPush地址,当MessageFormat=15，SendMethod=3时有效MessageFormatxsd:intM消息编码类型。0:ASCII4:Binary8:UCS215:含GB汉字SendMethodxsd:intM发送消息选项。0:普通短信1:闪电短信2:长短信3:wap pushDeliveryResultRequestxsd:booleanO指示是否需要网络侧返回递交状态报告。True表示需要网络侧返回递交状态报告，false表示不需要网络侧返回递交状态报告。ChannelIDxsd:string0短信通道ID,由短信平台指定,如果有多个短信通道,第三方IT系统可以指定使用某个短信通道.1.2. 返回值定义1、 成功则返回此次发送信息的唯一标识符，用于用户查询发送状态。2、 如果调用失败,则返回错误代码.2. 发送文件接口(sendFile)发起方：第三方IT系统落地方：短信平台 string sendFile(string OperatorID,string Password,string FileName, string Message,string WapPushurl,int MessageFormat,int SendMethod,String ExtendCode,bool DeliveryResultRequest,string ChannelID).2.1. 请求参数定义参数类型可选性描述OperatorIDxsd:stringM操作员IDPasswordxsd:stringM操作员密码FileNamexsd:string M号码文件名。通过ftp 上传到短信平台上,文件可重复使用.上传文件须是每行为一个手机号码的txt文件ExtendCodexsd:stringO内部扩展号码。Messagexsd:stringM在短消息中发送的文本。十六进制字符串标示WapPushUrlxsd:stringO发送WapPush地址,当MessageFormat=15，SendMethod=3时有效MessageFormatxsd:intM消息编码类型。0:ASCII4:Binary8:UCS215:含GB汉字SendMethodxsd:intM发送消息选项。0:普通短信1:闪电短信2:长短信3:wap pushDeliveryResultRequestxsd:booleanO指示是否需要网络侧返回递交状态报告。True表示需要网络侧返回递交状态报告，false表示不需要网络侧返回递交状态报告。ChannelIDxsd:string0短信通道ID,由短信平台指定,如果有多个短信通道,第三方IT系统可以指定使用某个短信通道.2.2. 返回值定义1、 成功则返回此次发送信息的唯一标识符，用于用户查询发送状态2、 如果调用失败,则返回错误代码.3. 发送点点通文件接口发起方：第三方IT系统落地方：短信平台string sendPPFile(string OperatorID,string Password,string FileName,string WapPushurl,int MessageFormat,int SendMethod,String ExtendCode,bool DeliveryResultRequest,string ChannelID).3.1. 请求参数定义参数类型可选性描述OperatorIDxsd:stringM操作员IDPasswordxsd:stringM操作员密码FileNamexsd:string M号码文件名。通过ftp 上传到短信平台上,文件可重复使用.上传文件的类型必须是txt文本文件、Excel文件和CSV文件。文本文件每行格式为:手机号码 短信内容;CSV文件每行格式为:手机号码,短信内容;Excel文件每行的格式为:第一列是手机号码 第二列是短信内容。ExtendCodexsd:stringO内部扩展号码。MessageFormatxsd:intM消息编码类型。0:ASCII4:Binary8:UCS215:含GB汉字SendMethodxsd:intM发送消息选项。0:普通短信1:闪电短信2:长短信3:wap pushDeliveryResultRequestxsd:booleanO指示是否需要网络侧返回递交状态报告。True表示需要网络侧返回递交状态报告，false表示不需要网络侧返回递交状态报告。ChannelIDxsd:string0短信通道ID,由短信平台指定,如果有多个短信通道,第三方IT系统可以指定使用某个短信通道.3.2. 返回值定义1、 成功则返回此次发送信息的唯一标识符，用于用户查询发送状态2、 如果调用失败,则返回错误代码.4. 查询短信发送状态接口(GetSmsDeliveryStatus)发起方：第三方IT系统落地方：短信平台DeliveryInformation GetSmsDeliveryStatus(string OperatorID,string Password, string RequestIdentifier);.4.1. 请求参数定义参数类型可选性描述OperatorIDxsd:stringM操作员IDPasswordxsd:stringM操作员密码RequestIdentifierxsd:stringM发送短信时,由短信平台分配的请求标示.4.2. 返回值定义1、 返回发送状态列表。（类型：DeliveryInformation数组）.5. 短信发送状态通知接口(NotifySmsDeliveryStatus)发起方：短信平台平台落地方：第三方IT系统限制条件：第三方IT系统必须注册接口void NotifySmsDeliveryStatus(string RequestIdentifier,DeliveryInformation DeliveryStatus);.5.1. 请求参数定义参数类型可选性描述RequestIdentifierxsd:stringM标识一个短消息发送请求。DeliveryInformationdeliveryInformationM短消息递交状态参数。.5.2. 返回值定义1、 无返回值2.1.5. 短信接收接口. 调用方式：接口接口定义发起方落地方说明接收短信GetReceived第三方IT系统短信平台上行短信通知NotifySmsReception短信平台第三方IT系统第三方IT系统必须提前注册对应接口. 接口定义.1. 接收短信接口（GetReceived）发起方：第三方IT系统落地方：短信平台SmsMessage GetReceived(string OperatorID,string Password, string ExtCode, string ChannelID);.1.1. 请求参数定义参数类型可选性描述OperatorIDxsd:stringM操作员IDPasswordxsd:stringM操作员密码ExtCodexsd:stringO扩展码ChannelIDxsd:string0短信通道I