南京市建邺区短信平台API接口说明
目 录
1
API接口 .................................................................................................................................... 3 1.1 1.1.1 1.1.2
1.2
1.2.1 1.2.2 1.2.3
接口函数说明 ..................................................... 3
单条发送消息函数ExecSendMessage ................................... 3 群发短消息的函数ExecSendBatchMessage .......................... 4
企业接口调用方式 ................................................. 6
C#中的调用 .............................................................................. 6 Javascript的调用 ..................................................................... 7 Java的调用方式 ...................................................................... 7
1 API接口
API接口的实现使用了WebService的方式，用户通过调用WebService的指定接口函数以达到发送短信的目的；
企业接口的服务页面为Webservice/SendShortMessage.asmx，如果WEB服务器地址为：http://192.168.200.17:90那么访问WebService的地址就为：
http:// 192.168.200.17:90/Webservice/SendShortMessage.asmx 要查看接口的定义的话则在连接地址下面增加“?WSDL”，即： http:// 192.168.200.17:90/Webservice/SendShortMessage.asmx?WSDL 1.1 接口函数说明
企业接口中提供了三个函数，如下：
String ExecSendMessage(string messageContent, string sender, string receivers,
XmlDocument ExecSendBatchMessage (string messageContent, string sender, string
receivers,string singn)
string singn)
XmlDocment LoadReceiveMessage(string sendPhoneNum,string startTime,string endTime)
ExecSendMessage 函数为单条发送短消息的函数 ExecSendBatchMessage
函数为群发短消息的函数（不建议使用）
LoadReceiveMessage 函数为接收指定号码回复的短信记录的函数
1.1.1 单条发送消息函数ExecSendMessage
函数定义如下：
String ExecSendMessage(string messageContent, string sender, string receivers,string singn)
函数参数有四个：
参数名 说明 messageContent 要发送的短信内容（最长支持220个汉字） 短信发送人（如 计生系统或者是有意义的能够表示发送人信息的内sender 容 最长15个汉字） 短信接收号码（小灵通要加上区号） receivers 短信签名（最长25个汉字 如 计生平台） singn
返回参数为字符串类型：发送成功返回“成功”,否则返回错误原因。
1.1.2 群发短消息的函数ExecSendBatchMessage
函数定义如下：
XmlDocument ExecSendBatchMessage (string messageContent, string sender, string receivers,string singn)
函数参数有四个： 参数名 说明 messageContent 要发送的短信内容（最长支持220个汉字） 短信发送人（如 计生系统或者是有意义的能够表示发送人信息的内sender 容 最长15个汉字） 短信接收号码（小灵通要加上区号，多个号码用半角分号“;”间隔） receivers 短信签名（最长25个汉字 如 计生平台） singn 说明：为防止方法调用超时，短信接收号码不要大于50个。 返回参数为一个XML文档，XML文档的格式如下：
群发前，条件验证失败
群发中，出现错误
群发成功，返回结果 属性说明： Result节点，表示执行结果。其中： id: 可以有三个值：0，1和2，如果为0表示验证失败，如果为1则表示执行成功，如果为2表示部分号码发送失败 value: 此属性表示执行结果的文字描述 mess: 在id为0的时候，此属性显示验证失败的原因 Failed节点，表示群发时出现发送失败。其中： total： 此属性表示发送失败的号码总数 Tel： 此节点表示具体失败的号码信息，属性number表示短信接收号码，属性mess表示失败原因 1.1.3 接收指定号码回复的短信记录LoadReceiveMessage 函数定义如下： XmlDocment LoadReceiveMessage(string sendPhoneNum,string startTime,string endTime) 函数参数有四个： 参数名 说明 sendPhoneNum 指定的回复号码（多个号码请用半角逗号“,”分隔） 回复短信的开始时间（形如 YYYY-MM-DD），以短信接收时间为准 startTime 回复短信的结束时间（形如 YYYY-MM-DD），以短信接收时间为准 endTime 说明：为防止方法调用超时，以及返回的xml文档过大，指定的回复号码不要大于30个。 返回参数为一个XML文档，XML文档的格式如下： 验证失败，返回结果 成功，返回结果
短信平台API接口使用手册
