短信平台API接口使用手册

1、南京市建邺区短信平台API接口说明目 录1 API接口 31.1 接口函数说明 3 单条发送消息函数ExecSendMessage 3 群发短消息的函数ExecSendBatchMessage 41.2 企业接口调用方式 5 C#中的调用 5 Javascript的调用 5 Java的调用方式 61 API接口API接口的实现使用了WebService的方式，用户通过调用WebService的指定接口函数以达到发送短信的目的；要查看接口的定义的话则在连接地址下面增加“?WSDL”，即：1.1 接口函数说明企业接口中提供了三个函数，如下：String ExecSendMessage(string

2、 messageContent, string sender, string receivers,string singnXmlDocument ExecSendBatchMessage (string messageContent, string sender, string receivers,string singnXmlDocment LoadReceiveMessage(string sendPhoneNum,string startTime,string endTimeExecSendMessage 函数为单条发送短消息的函数ExecSendBatchMessage 函数为群发短消

3、息的函数（不建议使用）LoadReceiveMessage 函数为接收指定号码回复的短信记录的函数ExecSendMessage函数定义如下：String ExecSendMessage(string messageContent, string sender, string receivers,string singn函数参数有四个：参数名说明messageContent要发送的短信内容（最长支持220个汉字）sender短信发送人（如 计生系统或者是有意义的能够表示发送人信息的内容 最长15个汉字）receivers短信接收号码（小灵通要加上区号）singn短信签名（最长25个汉字 如 计

4、生平台）返回参数为字符串类型：发送成功返回“成功”,否则返回错误原因。函数定义如下：XmlDocument ExecSendBatchMessage (string messageContent, string sender, string receivers,string singn函数参数有四个：参数名说明messageContent要发送的短信内容（最长支持220个汉字）sender短信发送人（如 计生系统或者是有意义的能够表示发送人信息的内容 最长15个汉字）receivers短信接收号码（小灵通要加上区号，多个号码用半角分号“;”间隔）singn短信签名（最长25个汉字 如 计生平台

5、）说明：为防止方法调用超时，短信接收号码不要大于50个。返回参数为一个XML文档，XML文档的格式如下：群发前，条件验证失败无法发送 " mess="短信内容为空"/></SendMessage>群发中，出现错误错误 "/>号码格式错误 "/>群发成功，返回结果成功 "/>属性说明：Result节点，表示执行结果。其中：id:可以有三个值：0，1和2，如果为0表示验证失败，如果为1则表示执行成功，如果为2表示部分号码发送失败value:此属性表示执行结果的文字描述mess:在id为0的时候，此属性显

6、示验证失败的原因Failed节点，表示群发时出现发送失败。其中：total：此属性表示发送失败的号码总数Tel：此节点表示具体失败的号码信息，属性number表示短信接收号码，属性mess表示失败原因函数定义如下：XmlDocment LoadReceiveMessage(string sendPhoneNum,string startTime,string endTime函数参数有四个：参数名说明sendPhoneNum指定的回复号码（多个号码请用半角逗号“,”分隔）startTime回复短信的开始时间（形如 YYYY-MM-DD），以短信接收时间为准endTime回复短信的结束时间（形如

7、YYYY-MM-DD），以短信接收时间为准说明：为防止方法调用超时，以及返回的xml文档过大，指定的回复号码不要大于30个。返回参数为一个XML文档，XML文档的格式如下：验证失败，返回结果  total=" 0 " mess=" 指定回复号码为空 " />  成功，返回结果  total=" 2 " mess="" />   <SendNum>1385196xxxx   2009-01-08 11:10:20.0   xxxx &

8、#160; 国研科技   浏试接收服务     138519 xxxxx   2009-01-08 11:41:38.0   xxxx   国研科技   一测试接收     属性说明：Result节点，表示执行结果。其中：total:回复的记录总数mess:验证失败时，指示失败原因Message节点，表示一条回复短信。其中：SendNum：此子节点表示回复号码SendTime：此子节点表示回复时间MemberName：此子节点表示回复人姓名MemberCompany：此子节点表示回复人单位Content：

9、此子节点表示回复内容1.2 企业接口调用方式企业接口函数的调用方式，此处列出各种语言及开发环境调用的示例，具体环境还需要作实际的修改。在C#中调用WebService很简单，在项目中添加一个WEB引用，打入服务器的地址：会列出此服务下面的所有方法，点击添加引用即可，在代码里面可以像本地类一样的使用WebService的服务，例如，你建立的WebService的引用为testSvc，那么调用的方式为：testSvc. SendShortMessage obj = new testSvc. SendShortMessage(;xml = obj. ExecSendBatchMessage (“me

10、ssageContent”, “sender”，“receivers”，“singn”；xml即为返回的结果。用javascript调用的方式有两种，一是使用微软提供的webservice.htc脚本进行调用，另一种调用方式是需要下载msSoapToolkit20.exe创建一个客户端的对象进行调用；通过客户端调用可以使用如下方法：在HTML代码中插入下面这段：id="tServer" style="BEHAVIOR:url(./css/webservice.htc" > >url(中的地址即为webservice.htc的站点相对路径；使用的时候可以使用ExecSendBatchMessage","messageContent", "sender"，"receivers"，&quo