企业短信平台企业API接口使用手册

企业短信平台企业API接口说明2006-12-6版本时间更新内容更新人1.02006-6-20文档成立顺炽国2.02006-12-61.扩展发送接口函数,增加了如下功能:a.指定特服号发送(需要配置多个特服号,或配置的特服号支持扩展),否则默认用单一特服号发送;b.支持发送异网短信,即可以用企业绑定的电话号码发送异网短信;c.支持多号码发送,号码间用逗号分隔,号码类别(即各运营商号码,如:小灵通\手机)可混合发送同一条信息;d.支持回执确认的操作.e.支持定时发送的操作;f.返回格式更新为XML的模式,以存放更丰富的返回信息,如:发送状态报告,错误详细信息,发送的任务ID(便于以后查询状态);2.增加一个根据发送任务ID取发送状态的接口函数,便于查询此发送任务的短信发送结果;顺炽国目录1企业API接口.............................................................41.1接口函数说明.....................................................41.1.1发送消息函数SendMessage.........................................41.1.2接收消息函数RecvMessage.........................................61.2企业接口调用方式.................................................81.2.1ASP中的Jscript和VbScript的调用................................81.2.2C#中的调用.......................................................81.2.3Javascript的调用................................................91.2.4Java的调用方式..................................................91企业API接口企业API接口的实现使用了WebService的方式，企业用户通过调用WebService的指定接口函数以达到发送和接收短信的目的；企业接口的服务页面为WebService/EntInterface.asmx，如果WEB服务器地址为：那么访问WebService的地址就为：要查看接口的定义的话则在连接地址下面增加“?WSDL”，即：接口函数说明企业接口中提供了三个函数，如下：stringSendMessage(stringstrLoginCode,stringstrPass,stringstrSpNum,stringstrRecvNum,stringstrMsg,intbConfirm,stringAtDate)stringRecvMessage(stringstrLoginCode,stringstrPass)stringGetStatus(stringstrLoginCode,stringstrPass,stringstrSendID)SendMessage函数为发送消息的函数RecvMessage函数为接收企业用户消息的函数GetStatus函数为检测发送流水的消息函数1.1.1发送消息函数SendMessage函数定义如下：stringSendMessage(stringstrLoginCode,stringstrPass,stringstrSpNum,stringstrRecvNum,stringstrMsg,intbConfirm,stringAtDate)函数参数有七个：参数名说明strLoginCode分配给企业用户的登录名strPass分配给企业用户的对应密码strSpNum企业用户发送短信时所使用的特服号,如果分配了多个特服号,可使用分配的任意一个,如果特服号支持扩展,则可以在分配的特服号上扩展其它号码,例如:分配给A企业的特服号为220355和220366,其中220355可支持扩展号码,220366不支持扩展号码,那么,在发送的时候,可以使用220355,220366中的任何一个发送信息,也可以使用220355+扩展的数字来发送信息,不过220366则只能以220366来发送信息;(如果需要使用模拟号码池中号码进行轮询，特服号这列填空即可。)strRecvNum短信接收号码,可以为多个接收号码,号码间用分号”;”或逗号”,”分隔.可支持最大4096个字符的号码群,超过此长度的号码群将被截断,所以在群发的时候最好不要超过此长度.对于接收的号码不作限制,可以是任何运营公司的号码,不过对于在系统黑名单中的用户,是默认不发送出去的,同时,对于各个运营商的号码会分拆成不同的任务发送出去,所以对于发送不同运营商号码的群发,系统会返回多个流水号.strMsg要发送的实际内容,长度不能超过255个字符,超过各运营商默认短信的默认长度,会被拆分成多条短信发送,根据配置情况会计一次费用或多次费用.bConfirm是否需要取到用户回执:0-不需要,1-需要;建议在特别情况下才需要,否则默认都输入0,开启回执会对系统造成很大的负荷;AtDate定时发送时间,指定此短信任务的发送时间,须为标准的日期格式,即:YYYY-MM-DDHH:MM:SS,否则会出现错误,不能发送;如果不需要定时发送,那么,将其置为空即可.对于返回的结果XML结构如下:?xmlversion=1.0encoding=GB2312?resultstatus=0message=”发送成功”serial_idcount=2idvalue=”1005”sp_name=”电信”/idvalue=”1006”sp_name=”电信”//serial_id/result在每个result节点中:status的值表示当前服务器返回的结果，message表示其描述信息，其含义如下:statusmessage0发送成功及成功的信息描述1用户名密码不正确2用户名不允许登录3用户状态无效4企业状态不可用5企业接口未开启6IP地址不允许登录7超过限制时间内的最大发送数量8发送的接收号码为空或在黑名单限制中9特服号不可用10输入的特服号不正确11输入了没有扩展权限的特服号12接收号码长度不正确13该企业没有发送回执的权限14未配置企业收费代码，无法发送15发送数据出现异常16超过单次最大发送条数限制17预留18预留19预留20接收号码为空21发送内容为空22定时发送时间不正确下面的serial_id节点表示本次发送的任务流水号，count表示本次发送了多少个任务，对于此节点下面的id节点，每个节点都有两个属性:value和sp_name，value表示实际发送的任务ID，sp_name则表示此任务ID发送的号码是哪个运营商的，可选值为如下四个:电信、网通、移动、联通；即如果是群发任务的时候，每一个任务ID下可能会有多个号码，在查询发送结果的时候需要根据任务ID+号码的方式来查询，不同运营商的号码用不同的任务ID+号码才能查询到对应的发送结果。1.1.2接收消息函数RecvMessage函数定义如下：stringRecvMessage(stringstrLoginCode,stringstrPass)函数的参数有两个：参数名说明strLoginCode分配给企业用户的登录名strPass分配给企业用户的对应密码返回参数为一个XML文档，XML文档的格式如下：?xmlversion=1.0encoding=utf-8?msgtableresult=1count=0errmsg=企业被暂停,不能发送消息/所有的企业消息都存放在msgtable节点中，此节点有三个属性，result、count和errmsg。属性说明：result:可以有两个值：0和1，如果为0表示执行成功，如果为1则表示执行失败count:此属性表示本次提取所取出的消息总数errmsg:在result为1的时候，此属性显示当前的错误信息在有消息的时候，返回情况如下：?xmlversion=1.0encoding=utf-8?msgtableresult=0count=2errmsg=rowid=1sp_num444499/sp_numrecv_date2006-6-2016:41:25/recv_datesend_num051386501004/send_numrecv_content企业API接口测试短信1/recv_content/rowrowid=2sp_num444499/sp_numrecv_date2006-6-2016:41:29/recv_datesend_num051386501004/send_numrecv_content企业API接口测试短信2/recv_content/row/msgtable在msgtable节点中，每一个row节点表示一条短信内容，它下面有四个子节点:sp_num-接收的特服号码recv_date-短信发送日期send_num-发送短信的用户号码recv_content-接收的短信内容row节点中的id属性是表明当前是第几条记录1.1.3发送任务状态查询GetStatus函数定义如下：publicstringGetStatus(stringstrLoginCode,stringstrPass,stringstrSendID)函数的参数有两个：参数名说明strLoginCode分配给企业用户的登录名strPass分配给企业用户的对应密码strSendID发送时返回的发送流水返回结果为一个XML列表对象?xmlversion=1.0encoding=GB2312?resultstatus=0message=查询状态成功rowid=1recv_user_num051261052722/recv_user_numsend_date2007-1-1215:54:32/send_datesmc_code0/smc_codestatus发送完成/status/row/resultresult表示查询的结果:0——查询成功1——查询失败message表示失败时的错误信息row节点存放的是有多少条查询明细，即此任务发送了多少个号码的发送结果，每一个节点表示一个发送号码，每个节点下面都有如下的子节点:recv_user_num——发送的接收号码smc_code——网关返回代码send_date——短信发送时间status——任务状态1.2企业接口调用方式企业接口函数的调用方式，此处列出各种语言及开发环境调用的示例，具体环境还需要作实际的修改。1.2.1ASP中的Jscript和VbScript的调用在asp中使用WebService调用需下载msSoapToolkit20.exe,引用：MSSOAP.SoapClientvarWSDL_URL==Server.CreateObject(MSSOAP.SoapClient)soapclient.ClientProperty(ServerHTTPRequest)=tru