《应用工厂开放平台短信能力接口规范》由会员分享，可在线阅读，更多相关《应用工厂开放平台短信能力接口规范（18页珍藏版）》请在金锄头文库上搜索。
1、天翼空间应用工厂开放平台短信接口规范中国电信股份有限公司应用商店运营中心修订表文档变更记录日期 版本 修改说明 作者2011-01-27 V1.0 初稿 王平2011-04-19 V1.0 新增状态上报参数 SMSNumber，标识本次短信拆分条数 王平2011-12-16 V1.0 新增模式类型字段 PIdType，用于能够对应用鉴权 王平目录1. 用户场景描述 .11.1 短信发送时序图： .12. SENDSMS 发送短信给终端 .22.1 SENDSMSREQUEST请求输入参数 .22.2 SENDSMSRESPONSE返回参数 .63. NOTIFYSMSDELIVERYSTATU
2、S 状态上报接口 .83.1 NOTIFYSMSDELIVERYSTATUSREQUEST参数 .83.2 NOTIFYSMSDELIVERYSTATUSRESPONSE参数 .94. 示例： .114.1.1 Md5 加密： .114.1.2 3DES 加密： .115. 附录 .14第 1 页1. 用户场景描述长短信业务提供一次可以比普通短信业务发送更多短信内容的服务。SI 请求长短信业务，组织相关业务参数发送到应用工厂，应用工厂收到 SI 请求后返回给 SI 一个处理请求成功或失败的信息，应用工厂将短信内容向接收号码发送，接收号码接收短信的状态将以HTTP 协议的 Post 方式发送给
3、SI，SI 收到上报后给予应用工厂一个响应。1.1 短信发送时序图：S I 应用 应用工厂I M SS e n d S M S R e q u e s tS e n d S M S R e s p o n s eS e n d S M S R e q u e s tS e n d S M S R e s p o n s eN o t i f y S M S D e l i v e r y S t a t u s . R e q u e s tN o t i f y S M S D e l i v e r y S t a t u s . R e s p o n s eN o t i f y S
4、t a t u sN o t i f y S M S D e l i v e r y S t a t u sN o t i f y S M S D e l i v e r y R e s p o n s e图 1.1 短信发送时序图第 2 页2. SendSMS 发送短信给终端应用发送请求到应用工厂，要求应用工厂发送短信给终端用户。接口名称 短信发送请求-SendSMS.Request接口描述 短信下行接口协议 http 请求访问地址 http:/125.64.11.43:8080/udt-see/StartServiceServlet接口方向 应用请求-能力开放平台填写说明：接口名称短信发送
5、请求-SendSMS.Request；接口描述短信下行；接口协议HTTP 协议；访问地址电信固定地址；http:/125.64.11.43:8080/udt-see/StartServiceServlet；接口方向应用请求-能力开放平台；2.1 SendSMSRequest 请求输入参数输入参数（客户发起）：序号 名称 必填 类型 描述1 serviceId Y String 服务ID（值为：00001020101130）2 params Y RequestListJson格式请求参数集合RequestList 结构：序号 名称 必填 类型 描述1 APID Y String 应用工厂为SI分
6、配的ID值2 Key Y String 安全标识，由3DES加密算法加密TimeStamp和APID组合的字符串得到,加密的密钥由应用工厂分配。3 Msg Y String 短信内容，最大长度为：内容第 3 页按GBK编码，不包含双字节字符长度为600字符，包含双字节字符最大长度为300字符。短信小于70个字按1条计算，超过70个字按67字拆分。短信中包括英文和中文的，英文和数字也算1个字；短信中只有英文、数字的，英文和数字算0.5字。4 TimeStamp Y String 长度为14位的时间戳（格式：YYYYMMDDHHMISS）5 IsReport Y String 是否需要上报短信发送
7、状态0-需要上报1-不需要上报6 StatusReportUrlN String 短信发送状态上报地址。当IsReport=0时，地址不能为空，否则将收不到状态信息 。7 ProductID Y String PIdType1：此处填写产品能力ID；PIdType9：此处填写应用ID。注：产品ID和应用ID均由应用工厂分配。 8 Num Y String 短信接收号码，如：136603600009 IsUse N String 是否在短信回复中使用应用下发短信时附带的备用参数，并将备用参数随短信下发状态一起上报给应用。1-使用，0-不使用。10 UserID N String 用户ID11 P
8、IdType N String 模式类型：1：普通模式(默认值)9: 应用管理模式12 Parm1 N String 备用参数。当该字段的值等于字符串“SMS+UP+SCDX”时，下发短信使用的IMS号码将使用公共号码，这种情况下将不能使用短信回复功能，但是可以有大量的IMS号码为应用的短信发送功能服务；如果是其第 4 页它值，且应用拥有为其分配的IMS号码，则将使用这些分配的IMS号码为应用的短息发送功能服务，这种情况下可以使用短信回复功能，但是短信下发量会受其所拥有的IMS号码数量的限制；如果是其他值，且应用不拥有为其分配的IMS号码，则仍然可以使用短信发送功能，但是不能使用短信回复功能。
9、13 Parm2 N String 备用参数14 Parm3 N String 备用参数填写说明：（1）serviceId 定义电信能力的业务 ID，每产生一个新的业务时，均会为该业务生成一个新的、唯一的ID，其值固定不变，以便客户调用此能力业务，长短信 serviceId=00001020101130。必填项（2）params 定义为应用发起请求时需提交应用工厂的请求参数集合，为 Json 格式数据集合。必填项。（3）APID 定义客户 ID，客户申请注册成功后，由应用工厂分配的唯一用户编号。必填项。（4）Key 定义安全标识，用于防止消息篡改攻击。接口描述的接口请求消息中，对于请求信息使用
10、3DES 加密算法进行加密，形成密文，用于标志请求和应答信息没有被篡改过。密文的生成方法 3DES (TimeStamp+APID)，其中，加号“+”表示字符串的连接，连接后的字符串并不包括加号；TimeStamp 是 14 位时间戳（由系统时间获取，格式：YYYYMMDDHHMISS），加密密钥是由应用工厂能力平台分配给客户的，在用户注册时由应用工厂能力平台产生。必填项。（5）Num 定义接收短信的手机号码，如：13660360000，必填项。第 5 页（6）Msg 定义短信内容，最大长度为：不包含双字节字符最大长度为 600 字符，包含双字节字符最大长度为 300 字符。短信小于 70 个
11、字按 1 条计算，超过 70 个字按 67 字拆分。短信中包括英文和中文的，英文和数字也算 1 个字；短信中只有英文、数字的，英文和数字算 0.5 字。必填项。（7）TimeStamp 定义为 14 位时间戳，格式为：YYYYMMDDHHMISS，如：20110206121212，必填项。（8）IsReport 定义是否需要上报状态，0-需要上报， 1-不需要上报，必填项。（9）StatusReportUrl 定义短信发送状态上报地址。当 IsReport=0 时，状态上报该地址不能为空，否则将收不到状态信息 。地址格式如：http:/127.0.0.1/HttpReport/StatusReport。（10）ProductID 定义产品能力ID，在注册时由应用工厂分配。必填项。（11）IsUse 定义是否在短信回复中使用应用下发短信时附带的备用参数，并将备用参数随短信下发状态一起上报给应用。1-使用，0-不使用。非必填项。 (12)UserID定义用户ID。非必填项。（13）Parm1 定义业务备用参数。特别的：当该字段的值等于字符串“SMS+UP+SCDX”时，下发短信使用的 IMS 号码将使用公共号码，这种情况下将不能使用短信回复功能，但是可以有大量的 IMS 号码为应用的短信发送功能服务；如果是其它值，且应用拥有为其分配的 IMS 号码，则将使用这些分配的 IMS 号码为
