接口使用说明文档
接口文档样例模板
接口文档样例模板一、接口概述：本文档是针对XXX系统的接口文档，用于说明系统提供的各种接口的具体功能和使用方法。
二、接口列表：1.接口名称：用户登录接口请求方式：POST接口描述：用户使用用户名和密码进行登录验证，返回登录状态和用户信息。
请求参数：- username(string，必填)：用户输入的用户名。
- password(string，必填)：用户输入的密码。
返回参数：- status(string)：登录状态，值为"success"或"fail"。
- message(string)：登录状态描述信息。
- user_info(object)：用户信息，包括用户ID、昵称等。
请求示例：```json"username": "admin",}```返回示例：```json"status": "success","message": "登录成功","user_info":"user_id": 1,"nickname": "管理员"}}```2.接口名称：获取用户列表接口请求方式：GET接口描述：获取系统中所有用户的列表。
请求参数：无返回参数：- status(string)：获取状态，值为"success"或"fail"。
- message(string)：获取状态描述信息。
- user_list(array)：用户列表，包括用户ID、昵称等。
请求示例：无返回示例：```json"status": "success","message": "获取成功","user_list":"user_id": 1,"nickname": "管理员"},"user_id": 2,"nickname": "用户1"}}```三、接口调用说明：2. 接口调用前需确保用户已经获取到相应的access token，并将其作为请求头中的Authorization字段进行传递。
企业付款API接口说明文档_V2 (1)(1)
5764
32)
是 5K8264ILTKC String(
H16CQ2502SI 32)
8ZNMTM67V
S
是 C380BEC2BF String(
D727A4B684 32)
5133519F3A
D6
是 10000098201 String
41111123456
7890
是 OPEN_ID
String
可 oxTWIuGaIt6 选 gTKsQRLau2
企业付款操作说明信息。必填。
调用接口的机器 Ip 地址
数据示例： Xml 待补充
2.1.4 返回参数
字段名 变量名
必 示例值
填
返回状态 return_code 是 SUCCESS
码
类型
String( 16)
返回信息 return_msg 否 签名失败
String( 128)
以下字段在 return_code 为 SUCCESS 的时候有返回
第一步：对参数按照 key=value 的格式，并按照参数名 ASCII 字典序排序如下：
stringA="appid=wxd930ea5d5a258f4f&body=test&device_info=1000&mch_i
d=10000100&nonce_str=ibuaiVcKdpRxkhJA";
String
String
Uint64 _t String String( 32)
如果 user_type 为 WEIXIN_ID，必填
NO_CHECK：不校验真实姓名 FORCE_CHECK：强校验真实姓名（未绑卡 用户会校验失败，无法转账） OPTION_CHECK：针对已绑卡的用户校验 真实姓名（未绑卡用户不校验） 收款用户真实姓名。 如果 check_name 设置为 FORCE_CHECK 或 OPTION_CHECK，则必填用户真实姓名 企业付款金额，单位为分
api接口说明文档模板文
api接口说明文档模板文API是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力今天小编给大家整理了api知识供大家参考，我们一起来看看吧!api接口说明文档模板1API：应用程序接口(API：Application Program Interface)应用程序接口是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。
API 的一个主要功能是提供通用功能集。
程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。
API 同时也是一种中间件，为各种不同平台提供数据共享。
根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：远程过程调用(RPC)：通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信。
标准查询语言(SQL)：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。
文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。
当前应用于 API 的标准包括 ANSI 标准 SQL API。
另外还有一些应用于其它类型的标准尚在制定之中。
API 可以应用于所有计算机平台和操作系统。
这些 API 以不同的格式连接数据(如共享数据缓存器、数据库结构、文件框架)。
每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。
因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。
相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。
正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付 API 类型是比较理想的选择。
Aurora接口使用说明
在AMC-2C667X平台上使用FPGA的Aurora接口说明声明：本文档仅面向初学者。
1、针对平台用的V6芯片型号新建一个ISE工程，工程中加入Aurora IP核，IP核的设置如下（当然也可以选择其他设置，以下均是针对本测试设置而言）图1主要参数：lanes-通道数，即使用的GTX收发器个数Lane width:aurora 核与用户接口的数据位宽（一般可选2B或者4B）Lane rate:Aurora核的对外通信速率，由于采用8B/10B编码，实际有效速率要乘以0.8。
GT REFCLK:GTX参考时钟频率采用全双工，流水通信模式。
详细请参考Aurora的UG。
好了，最后一页了，这IP核设置够简单吧！！！（一共才两页好伐…），让你选择GTX位置平台上的V6片子一共有6组GTX QUAD，每个QUAD有4个GTX，选择一个GTX与平台的SFP+ F2相连，平台说明书写清楚了，是MGT_113_1，就是它了。
生成了这个核以后，核的文件夹下会多出一堆文件，这就是XILINX给你的一个示例工程-example design.图3接下来就可以仿真啦。
仿真：你可以直接使用它提供的testbench仿真，没问题。
但是有更简单的方法，其实你仿真只是为了看看它的时序，看看你加的东西对不对，因为只要你加对了，仿真一定通过。
那么简单的方法呢？打开modelsim，不要告诉我你没装，或者装了没有关联ISE仿真库，那你得先把这个问题解决了再说。
好了之后，新建一个modelsim工程（file-new…）在你之前那堆文件的/simulation/functional文件夹下，看图说话~下一个界面叫你create new files啥的直接close。
然后你就在modelsim命令窗口轻轻地敲了一行命令：do simulate_mti.do这个simulate_mti.do就是人家已经仿真好的仿真文件，就在那个文件夹里，意思就是我仿好了，你拿去用吧，看看就好，没什么技术含量。
汉印云打印 开放API 接口文档 使用说明书
【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述： (1)2.打印接口： (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下： (3)2.6加密示例： (3)2.7需要传递给API的参数是： (3)3.APP调用功能： (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息： (14)1.概述：汉印云打印平台是以互联网为基础，整合云打印机资源，构建漫游共享的打印平台，向所有用户提供随时随地高质量、标准化的打印服务，包含了云平台、API、云打印服务器、云打印机等，产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等，并致力于成为国内一线互联网云平台。
本文档提供了面向互联网开放的API接口，可有效的实现汉印云打印平台和应用开发者之间的对接，帮助用户和开发者方便地使用云平台的架构和功能。
2.打印接口：本节介绍如何发送数据到汉印云API并通过云平台输出打印指令，以及对应的状态返回码。
2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。
汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。
2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数（系统级参数和应用级参数）。
系统级参数应用级参数2.5签名加密算法如下：Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)，串在一起后进行MD5加密然后再转成大写，括号里面的参数只需要传入值。
2.6加密示例：000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列，然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是：UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。
人力资源(HrmService)WebService接口使用说明
人力资源WebService接口开发使用说明SUBMITED BY WEA VER文档版本历史变更序号日期版本文件变更申请编号变更说明修改人1 2011年8月26日V1.0 无新文件胡伟武目录一、前言 (4)1.1编写目的 (4)1.2名词定义 (4)二、接口调用步骤 (5)2.1检查web service是否已部署 (5)2.2接口方法概述 (5)2.3 接口相关对象说明 (7)2.4 生成客户端 (9)三、示例程序 (19)3.1 使用客户端同步公司信息 (19)一、前言1.1编写目的本文给有研发能力的客户或有系统集成需求的客户提供web service接口调用的参考例程。
本文的面向具有一定web service开发能力或了解web service技术的开发人员。
1.2名词定义1、Axis：著名的开源web service引擎。
2、外部系统：指调用或实现e-cology输入输出接口，与e-cology系统进行数据交接的其他系统。
二、接口调用步骤2.1检查web service是否已部署在浏览器中输入http://ecologyServer/services,应显示如下页面：如果未出先上述页面，则web service未部署成功，请与泛微项目人员联系。
接口部署成功之后，需要在OA的HrmWebserviceIP.properties配置文件中配置调用接口客户端的IP，调用接口时传入的参数ip包涵在此配置文件才能调用以下接口。
2.2接口方法概述名称参数返回值功能描述SynSubCompany String ipaddress：调用接口的IP地址，StringxmlData：分部信息的xml成功:1,失败:0,2:无权限调用同步分部信息SynDepartment String ipaddress：调用接口的IP地址，StringxmlData：部门信息的xml成功:1,失败:0,2:无权限调用同步部门信息SynJobtitle String ipaddress：调用接口的IP地址，StringxmlData：岗位信息的xml成功:1,失败:0,2:无权限调用同步岗位信息SynHrmResource String ipaddress：调用接口的IP地址，StringxmlData：人员信息的xml成功:1,失败:0,2:无权限调用同步人员信息getHrmSubcompanyInfo String ipaddress：调用接口的IP地址，SubCompanyInfo[]:分部信息列表获取所有分部信息列表getHrmDepartmentInfo String ipaddress：调用接口的IP地址，StringsubcompanyId：分部id，多个用逗号分隔（不为空时该条件有效）DepartmentInfo[]：部门信息列表根据参数条件获取部门信息列表getHrmJobTitleInfo String ipaddress：调用接口的IP地址，StringsubcompanyId：分部id，多个用逗号分隔（不为空时该条件有效）String departmentid：部门id，多个用逗号分隔（不为空时该条件有效）JobTitleInfo[]:岗位信息列表根据参数条件获取岗位信息列表getHrmUserInfo String ipaddress：调用接口的IP地址，StringsubcompanyId：分部id，多个用逗号分隔（不为空时该条件有效）String departmentid：部门id，多个用逗号分隔（不为空时该条件有效）String jobtitleid：岗位id，多个用逗号分隔（不为空时该条件有效）StringlastChangeDate：最后修改日期，日期格式“YYYY-MM-DD”（不为空时该条件有效）String workcode:人员编码（不为空时该条件有效）UserInfo[]：用户信息列表根据参数条件获取用户信息列表checkUser String ipaddress：调用接口的IP地址String loginid：登录名String password：密码True:表示存在False：表示不存在检测OA用户2.3 接口相关对象说明1）SynSubCompany 同步分部传入xml的格式如下（一定要按照此格式传入）：<?xml version="1.0" encoding="UTF-8"?><root><orglist><org action="add"><code>001</code><shortname>测试分部一</shortname><fullname>测试分部一</fullname><parent_code>0</parent_code><order>0</order></org><org action="edit"><code>002</code><shortname>测试分部二</shortname><fullname>测试分部二</fullname><parent_code>0</parent_code><order>1</order></org><org action="delete"><code>003</code><canceled>1</canceled></org></orglist></root>相关属性说明：Action：动作，add：添加，edit：编辑，delete：删除，OA中只做封存和解封，canceled=1封存，canceled=0解封Code：分部编码，唯一值Shortname：分部简称Fullname：分部全称Parent_code：上级分部编码，没有上级请填写0Order：排序值2）SynDepartment同步部门传入xml的格式如下（一定要按照此格式传入）：<?xml version="1.0" encoding="UTF-8"?><root><orglist><org action="add"><code>0001</code><shortname>测试部门一</shortname><fullname>测试部门一</fullname><org_code>001</org_code><parent_code>0</parent_code><order>0</order></org><org action="edit"><code>0002</code><shortname>测试部门二</shortname><fullname>测试部门二</fullname><org_code>003</org_code><parent_code>0</parent_code><order>1</order></org><org action="del"><code>0003</code><canceled>1</canceled></org></orglist></root>相关属性说明：Action：动作，add：添加，edit：编辑，delete：删除，OA中只做封存和解封，canceled=1封存，canceled=0解封Code：部门编码，唯一值Shortname：部门简称Fullname：部门全称Org_code：分部编码Parent_code：上级部门编码，没有上级请填写0Order：排序值3）SynJobtitle同步岗位传入xml的格式如下（一定要按照此格式传入）：<?xml version="1.0" encoding="UTF-8"?><root><jobtitlelist><jobtitle action="add"><jobtitlecode>00001</jobtitlecode><jobtitlename>测试岗位一</jobtitlename><jobtitleremark>测试岗位一</jobtitleremark><jobtitledept>0001</jobtitledept></jobtitle><jobtitle action="edit"><jobtitlecode>00002</jobtitlecode><jobtitlename>测试岗位二</jobtitlename><jobtitleremark>测试岗位二</jobtitleremark><jobtitledept>0002</jobtitledept></jobtitle><jobtitle action="delete"><jobtitlecode>00003</jobtitlecode><jobtitlename>测试岗位三</jobtitlename></jobtitle></jobtitlelist></root>相关属性说明：Action：动作，add：添加，edit：编辑，delete：删除Jobtitlecode：岗位编码，唯一值Jobtitlename：岗位简称Jobtitleremark：岗位全称Org_code：分部编码Jobtitledept：岗位所属部门编码4）SynHrmResource同步人员传入xml的格式如下（一定要按照此格式传入）：<?xml version="1.0" encoding="UTF-8"?><root><hrmlist><hrm action="add"><workcode>10001</workcode><loginid>test</loginid><lastname>test</lastname><password>123456</password><subcompany>测试分部一</subcompany><department>测试部门一</department><jobtitle>测试岗位一</jobtitle><statue>正式</statue><managerid>1024</managerid><sex>男</sex><birthday>1988-09-09</birthday><telephone>12345678</telephone><mobile>12345678</mobile><email>************</email><maritalstatus>已婚</maritalstatus></hrm><hrm action="edit"><workcode>10001</workcode><loginid>test</loginid><lastname>test</lastname><password>123456</password><subcompany>测试分部一</subcompany><department>测试部门一</department><jobtitle>测试岗位一</jobtitle><statue>正式</statue><managerid>1024</managerid><sex>男</sex><birthday>1988-09-09</birthday><telephone>12345678</telephone><mobile>12345678</mobile><email>************</email><maritalstatus>已婚</maritalstatus> </hrm></hrmlist></root>相关属性说明：Action：动作，add：添加，edit：编辑Workcode：人员编码，唯一值Subcompany：分部Department：部门Lastname：姓名Loginid：登录名Password：密码Seclevel：安全级别Sex：性别Jobtitle：岗位Jobactivityid：职务Jobgroupid：职务类别Jobcall：职称Joblevel：职级Jobactivitydesc：职责描述Managerid：直接上级（编码）Assistantid：助理（编码）Status：状态Locationid：办公室Workroom：办公地点Telephone：办公电话Mobile：移动电话Mobilecall：其他电话Fax：传真Email：邮箱Systemlanguage：系统语言Birthday：出生日期Folk：名族Nativeplace：籍贯Regresidentplace：户口Certificatenum：身份证号码Maritalstatus：婚姻状况Policy：政治面貌Bememberdate：入团日期Bepartydate：入党日期Islabouunion：工会会员Educationlevel：学历Degree：学位Healthinfo：健康状况Residentplace：现居住地Homeaddress：家庭联系方式Tempresidentnumber：暂住证号码以上是人员同步的所有节点信息，需要同步那些字段，就填写相应的值。
接口文档范例示意
接口文档范例示意文章标题：接口文档范例示意 - 简单易懂的API文档设计与编写引言：在软件开发过程中，为了实现不同系统之间的互联互通，接口文档的编写变得尤为重要。
好的接口文档不仅能够提供清晰的指导，还能减少开发者之间的沟通成本，提高开发效率。
本文将以一个示意的接口文档范例为例，探讨如何编写一份简单易懂的API文档。
第一部分：接口概述1.1 接口名称和版本信息在接口概述中，首先需要明确接口的名称和版本信息。
例如：接口名称：用户管理接口版本号：v1.01.2 接口描述在接口描述中，应该简要说明该接口的作用和功能。
例如：该接口用于对系统中的用户进行管理，包括用户的创建、查询、更新和删除等操作。
1.3 接口区域信息和请求方式在接口区域信息和请求方式中，需要提供接口的URL区域信息以及HTTP请求的方式。
例如：接口区域信息：/api/users请求方式：GET第二部分：请求参数2.1 公共请求参数公共请求参数是指在每个接口中都需要使用的参数，例如身份认证信息、时间戳等。
在该部分中，列举出每个公共请求参数的名称、类型和是否必填。
例如：- access_token（字符串，必填）：用于身份认证的令牌。
- timestamp（字符串，必填）：请求的时间戳。
2.2 接口请求参数接口请求参数是指该接口所需的具体参数，包括请求方法（GET、POST等），请求体中的参数以及可选的路由参数等。
在该部分中，详细描述每个请求参数的名称、类型、是否必填、描述以及示例值。
例如：- name（字符串，必填）：用户姓名。
- age（整数，选填）：用户年龄。
- gender（字符串，选填）：用户性别。
示例值：'male'或'female'。
第三部分：响应参数3.1 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数，例如状态码、错误信息等。
在该部分中，列举出每个公共响应参数的名称、类型和描述。
中控考勤机接口文档
GO
-- To update the currently configured value for advanced options. RECONFIGURE
GO
-- To enable the feature.
EXECsp_configure'xp_cmdshell', 1
GO
-- To update the currently configured value for this feature. RECONFIGURE
select a.*,b.EM_ID from dbo.hr_ats_CardData1 a
inner join v_HR_ATS_Employee b on a.卡号=b.FCardID
where not exists
(select * from HR_ATS_OriginalityCard where FCardID=a.卡号 and FCardDateTime=a.打卡时间)
3.下述具体步骤是制作该接口的过程，如非更换服务器或其他损坏等原因，则下面几步无需再做，仅供了解原理。
五(具体步骤:
1. 在中控客户端里可以查看它的数据文件位置(如图att2000.mdb)，记下此文件路径，
att2000.mdb中有一个表“CHECKINOUT”存放着打卡数据
表checkinout
3.要有SQL server;
三(接口原理:
1.中控客户端定时下载记录到att2000.mdb;
2.我们在SQL数据库中创建一个视图A来实时抓取att2000.mdb中表CHECKINOUT
的卡号和打卡时间;
3.然后再创建一个视图B获取视图A中最近一个月的数据;
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
中国移动短信网关SP端接口使用手册China Mobile Shot MessageGateway Interface for SP Manual作者：沈岗日期：2004年1月版本：V1.2一、CMSMIF.CMPPApp简要说明：该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。
本类中，采用长连接方式与ISMG通讯。
通信双方以客户-服务器方式建立TCP连接，用于双方信息的相互提交。
当信道上没有数据传输时，通信双方应每隔时间C发送链路检测包以维持此连接，当链路检测包发出超过时间T后未收到响应，立即再发送链路检测包，再连续发送N-1次后仍未得到响应则断开此连接。
参数C、T、N可通过属性配置。
消息发送时采用并发方式，即发送一条消息不等待网关回复确认，继续向网关发送短信，这样发送消息速度非常快，完全取决于网关的处理速度及网络速度。
为避免消息丢失，同时采用了滑动窗口流量控制，窗口大小可通过属性设置。
消息接收、网络断开等采用事件触发方式，不需应用程序轮询，在此接口基础之上编程方便。
类中运用了多线程技术，如一条线程处理发送网络包，而另一条线程处理从网关上接收网络包，其他还有一些线程处理检测包、网络连接情况监测等，使程序思路明确、执行效率很高、运行非常稳定。
（一）属性1.ActiveInterval说明：检测包发送时间间隔，单位：毫秒。
默认值为120000，即120秒。
为上述类说明中的C参数。
2.MaxNetworkPackSize说明：与ISMG通讯时最大网络包大小，单位：字节。
默认值为512Byte。
3.MaxRetryTimes说明：网络超时最大重发次数,单位：次。
默认值为3次。
为类说明中的N。
4.OverTime说明：网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。
默认值为60000，即60秒。
为类说明中的T。
5.QueueLength说明：网络队列大小，单位：个，默认值为20。
为类说明中的滑动窗口大小，以控制发送流量。
（二）方法1.ConnectToIsmg方法说明：连接到远程短信网关ISMG上，只有连接到远程短信网关上，才可进行短信收发操作。
在本操作中，自动初始化本地Socket，以连接到指定IP服务器的指定端口上。
声明原型：int ConnectToIsmg(string ServerIP,int Port,stringSP_ID,string Secret，string SN)参数说明：ServerIP：远程短信网关服务器的IP地址，如211.138.200.51Port：远程短信网关服务器的端口号，如7890SP_ID：企业服务代码Secret：连接认证码，由中国移动与源地址实体事先商定。
SN：本软件的使用许可序列号。
无效的序列号仅可在2004年8月份前试用。
如需继续使用需与本软件作者联系，E-mail：hurry_sg@。
返回值：整型，连接成功返回0，初始化端口失败返回－1，连接网关失败返回－2，序列号无效试用到期无法继续使用返回－3。
2.DisConnectWithIsmg方法说明：断开与远程短信网关的连接。
在此方法中同时释放与远程连接的Socket。
声明原型：int DisConnectWithIsmg()返回值：成功返回0，失败返回负值。
3.SendMessage方法说明：向指定手机发送短消息。
在此函数中，如发送的消息超过最大短信字符数（140Byte），则自动分条发送。
同时支持群发，超过最大群发数时（100条），则自动分批次发送。
声明原型：(1)int SendMessage(string Src_Id,string Service_Id,stringMsg_src,string Dest_terminal_Id, string Msg_content)(2)int SendMessage(string Src_Id,string Service_Id,stringMsg_src,string Dest_terminal_Id, string Msg_content,byte Msg_Fmt)参数说明：Src_Id：源号码，SP的服务代码或前缀为服务代码的长号码，该号码最终在用户手机上显示为短消息的主叫号码。
Service_Id：业务类型，是数字、字母和符号的组合。
Msg_src：企业代码。
Dest_terminal_Id：接收短信的手机号码。
群发时多个手机号码之间有逗号或分号隔开。
Msg_content：消息内容，长度大于最大短消息长度时，自动分条发送。
Msg_Fmt：消息编码格式。
0：ASCII串3：短信写卡操作4：二进制信息8：UCS2编码15：含GB汉字声明原型1时，Msg_Fmt默认为15，此时最大消息长度为70，无论是否包含汉字。
返回值：发送成功时返回大于0的流水号，失败时返回负值。
（三）事件1.OnDisConnected说明：与网关ISMG断开事件事件参数类： System.EventArgs事件参数成员：标准.net事件参数。
2.OnNetworkError说明：网络错误事件，一般为网络连发Ｎ次后仍未收到回复事件参数类：NetworkErrorEventArgs事件参数成员：int TotalLength,Command,Sequence;byte[] Message,MessageBody;int ErrorCode;//出错代码：1:网络包超时,2:发送队列满,3:发送消息到ISMG出错3.OnRecieveMessage说明：从网关收到消息事件事件参数类：RecieveMessageEventArgsstring MobileNumber,SPNumber,MessageContent,Service;//分别对应为：手机号，特服号，消息内容，服务代号long MsgId; //消息标识，由网关产生，可以用来唯一标识某一条短信int Sequence;byte[] MessageBody;4.OnRecieveSubmitMessageResp说明：收到网关发来的发送短消息确认事件事件参数类：RecieveSubmitMessageRespEventArgs事件参数成员：int Sequence; //消息发送流水号int Result; //发送消息结果：0:成功发送，小于0则为失败long MsgId; //消息标识，由网关产生，可用于标识唯一某条短信。
5.OnRecieveStateRpt说明：收到ISMG发来的状态报告事件。
SP端成功向网关提交一条短信后，稍后会收到服器发来的短信发送状态的报告信息，以判断短信是否成功发送到手机上。
事件参数类：RecieveStateRptEventArgs事件参数成员：long Msg_Id;//消息标识，该值与发送消息确认事件中的Msg_Id值相同。
string Stat,Dest_terminal_Id;// Stat：状态信息，说明详见后表，Dest_terminal_Id：发送消息的手机号。
DateTime Submit_time,Done_time;int SMSC_sequence;byte[] MessageBody;State含义对应表：6.OnRespQuery说明：查询消息状态回复事件事件参数类：ResQueryEventArgs事件参数成员：（说明参见CMPP协议）int Sequence;DateTime Time;byte Query_Type;string Query_Code;int MT_TLMsg,MT_Tlusr,MT_Scs,MT_WT,MT_FL,MO_Scs,MO_WT,MO_FL;（四）使用步骤1.调用ConnectToIsmg（）来连接到远程网关。
2.调用SendMessage（）来向网关发送一条消息，返回消息流水号Sequence。
3.继续调用SendMessage（）发送消息……。
4.从网关接收到发送消息确认信息，自动触发OnRecieveSubmitMessageResp事件，事件参数中的Msg_Id、Sequence，其中Sequence与SendMessage（）方法匹配出具体的消息，将Msg_Id保存到该消息上。
5.网关根据消息发送情况，向SP提交发送消息状态报告，自动触发OnRecieveStateRpt事件，根据状态报告参数中的Msg_Id标识某消息是否成功送达手机。
注意该事件一般在手机收成功收到短消息后触发，所以该事件经常在调用SendMessage后很长时间后才触发，如正常一般在10秒钟左右，但有时会在几分钟甚至在几个小时后才会触发。
6.如接收到网关发来的短消息，则触发OnRecieveMessage事件，消息内容、手机号码、发送的特服号均在事件参数中提供了。
7.调用DisConnectWithIsmg（）断开与网关的连接。
8.如在连接到网关后，因故发生网络故障则会触发OnNetworkError事件，一般发生在一个消息包重发N次后还未成功，或其他网络情况。
9.SP与网关服务器断开连接后，会触发OnDisConnected事件。
不管是SP主动提出中断、还是网关提出中断、或者因网络错误中断连接均会触发OnDisConnected事件。
二、CMSMGWCenter.CMSMGWCenter简要说明：短信网关应用程序。
该类是在CMSMIF.CMPPApp类基础上，从数据库中获取要发送的短信将其发送到网关上，同时将从网关上接收到的消息存到数据库中。
其中数据库中与该短信网关相关的主要有两张表：tbl_SendSM及tbl_RecieveSM，前者存储要发送的短信，后者存储从网关上接收下来的短信。
注：目前数据库仅支持SQL Server 2000，但仅需适当改变即可支持其他类型的数据库。
（一）方法说明1.Start方法说明：开始处理短信收发工作。
开始后，系统有一线程判断tbl_SendSM表中是否有新短消息需要发送，如有则调用CMSMIF.CMPPApp.SendMessage（）进行发送。
并分在收到“发送消息回复确认”事件及收到“消息发送状态包”事件中，设置短消息的状态位。
如从网关收到消息，则将消息写到数据库tbl_RecieveSM表中。
另还有一线程专门检测与网关连接情况，除SP主动与网关断开连接外，在收到“与网关断开连接”事件后自动再与服务器重新建立联接。
声明原型：int Start(string dBConnectionString,string cMSMGateWayIP,int port,string sP_ID,string secret，string SN, bool saveWasteSM)参数说明：dBConnectionString：数据库连接字符串。