信通企业信息服务平台接口手册.doc

精品文档 1欢迎下载 一信通企业信息服务平台一信通企业信息服务平台 接口手册接口手册 产品名称一信通企业信息服务平台接口手册 版本编号 2 1 2 文档编号 发布者 发布日期 2011 11 28 目录目录 一信通企业信息服务平台一信通企业信息服务平台 1 1 1 1 概述概述 3 3 1 1编制目的 3 1 2内容概述 3 1 3名称解释 3 1 4参考文献 3 2 2 短信短信 4 4 2 1HTTP接口 4 2 1 1消息协议 4 2 1 2发送短信 4 2 1 3回执接口 6 2 1 4剩余短信条数查询 6 精品文档 2欢迎下载 2 1 5上行回复内容查询接口 7 2 1 6上行回复内容确认接口 8 2 2WEBSERVICE接口 8 2 2 1消息协议 8 2 2 2发送短信 8 2 2 3回执接口 10 2 2 4上行回复内容查询接口 10 2 2 5上行回复内容确认接口 11 2 2 6内容审核 12 修改历史修改历史 日期日期版本版本作者作者修改内容修改内容评审号评审号更改请求号更改请求号 1 1 概述概述 1 11 1 编制目的编制目的 该接口文档手册编写在于描述一信通企业信息服务平台 UMS 以下简称 UMS 具体的接口 协议 供第三方系统能够顺利接入一信通短信网关 1 21 2 内容概述内容概述 本规范主要讲了第三方系统接入短信通系统的协议要求 协议三大状态和协议指令的格式 和响应信息 精品文档 3欢迎下载 1 31 3 名称解释名称解释 缩略语缩略语英文全名英文全名中文全名中文全名 UMSUnified Message Service 一信通 SMSShort Messaging Service 短消息服务 APIApplication Proframming Interface 应用程序编程接口 MOMessage Original 消息上行 MTMessage Terminal 消息下行 SPService Provider 服务提供商 CPContent Provider 内容提供商 1 41 4 参考文献参考文献 2 2 短信短信 httphttp 接口接口 2 1 12 1 1消息协议消息协议 接口地址 8888 sms Api 通过接口提交参数时 参数内容必须为 GB2312 编码 且经过 url 编码后的内容 例如 您好 的 url 编码为 C4 FA BA C3 接口返回的内容是一些键值对的字符串集合 形式为 k1 v1 Matcher m Ppile parsePattern matcher line Properties result newnew Properties whilewhile m find String key m group 1 trim String value m group 2 trim result put key toUpperCase value returnreturn result 如果要获取取接受短信的号码则使用 String mdn String result get MDN 即可 其他字段类似方式 2 1 42 1 4剩余短信条数查询剩余短信条数查询 功能描述 功能描述 剩余短信条数查询接口 调用格式调用格式 对 8888 sms Api SearchNumber do 进行 post 返回格式返回格式 result 000000000000000000010 000000000000000000010 2 2 42 2 4上行回复内容查询接口上行回复内容查询接口 功能描述 功能描述 上行回复内容查询 调用方式调用方式 利用 webservice 客户端进行 http 请求 返回格式返回格式 ReplyResponseReplyResponse ReplyRequestReplyRequest请求参数说明请求参数说明 类别类别参数名称参数名称类型类型说明说明 输入In0 string 企业编号 输入In1 string 用户名称 输入In2 string 用户密码 ReplyResponseReplyResponse返回值返回值 类别类别参数名称参数名称类型类型说明说明 输出result string 返回码 输出confirm time string 回复时间 格式 yyyy MM dd HH mm ss 输出replysreply 数组多个 relpy 对象组成 输出Id String 最后一条回复信息的 ID 返回值返回值错误描述错误描述 0 成功 1 提交参数不能为空 2 账号无效 3 账号密码错误 20 系统错误 精品文档 11欢迎下载 reply 的属性值 类别类别参数名称参数名称类型类型说明说明 输出callMdn string 接入号 输出mdn string 用户手机号 输出message string 回复内容 输出reply time string 回复时间 格式 yyyy MM dd HH mm ss 输出 idstring 回复 id 编号 2 2 52 2 5上行回复内容确认接口上行回复内容确认接口 功能描述 功能描述 上行回复内容查询 调用方式调用方式 利用 webservice 客户端进行 http 请求 返回格式返回格式 ReplyConfirmResponseReplyConfirmResponse ReplyConfirmRequestReplyConfirmRequest请求参数说明请求参数说明 类别类别参数名称参数名称类型类型说明说明 输入In0 string 企业编号 输入In1 string 用户名称 输入In2 string 用户密码 输入In3 string 上行回复内容查询接口返回的时间 格式 yyyy MM dd HH mm ss 输入In4 string 最后一条回复信息的 id ReplyConfirmResponseReplyConfirmResponse返回值返回值 类别类别参数名称参数名称类型类型说明说明 输出result string 返回码 返回值返回值错误描述错误描述 0 成功 1 提交参数不能为空 2 账号无效 3 账号密码错误 4 时间格式不正确 格式为 yyyy MM dd HH mm ss 20 系统错误 2 2 62 2 6内容审核内容审核 功能描述 功能描述 短信发送 调用格式调用格式 利用 webservice 客户端进行 http 请求 精品文档 12欢迎下载 返回格式返回格式 AuditingResponseAuditingResponse AuditingRequestAuditingRequest请求参数说明请求参数说明 类别类别参数名称参数名称类型类型说明说明 输入In0 string 企业编号 输入In1 string 用户名称 输入In2 string 用户密码 输入In3 string 短信内容 最大 402 个字符 AuditingRespon