短信平台WebService接口文档(v2)
- 格式:doc
- 大小:53.50 KB
- 文档页数:4
提供Web Service、Http 两种接⼊入模式注册接⼜⼝口Reg输⼊入参数:CorpID-帐号Pwd-密码CorpName-企业名称LinkMan-联系⼈人Tel-联系电话Mobile-联系⼈人⼿手机Email-邮件Memo-其他备注输出参数:整数,0:注册成功;-1、帐号已经注册;-2、其他错误;-3、帐号密码不匹配public int Reg(string CorpID,string Pwd,string CorpName,string LinkMan,string Tel,string Mobile,string Email,string Memo){}h t t p://w w w.512688.c o m/w s/R e g.a s p x? CorpID=*&Pwd=*&CorpName=*&LinkMan=*&Tel=*&Mobile=*&Email=*&Memo=*更改密码UpdPwd输⼊入参数:CorpID-帐号Pwd-密码NewPwd-新密码输出参数:整数,0:密码修改成功;-1、帐号未注册;-2、其他错误;-3、密码错误public int UpdPwd(string CorpID,string Pwd,string NewPwd){}/ws/UpdPwd.aspx?CorpID=*&Pwd=*&NewPwd=*修改注册信息UpdReg输⼊入参数:CorpID-帐号Pwd-密码CorpName-企业名称LinkMan-联系⼈人Tel-联系电话Mobile-联系⼈人⼿手机Email-邮件Memo-其他备注输出参数:整数,0:修改成功;-1、帐号未注册;-2、其他错误;-3、密码错误public int UpdReg(string CorpID,string Pwd,string CorpName,string LinkMan,string Tel,string Mobile,string Email,string Memo){}h t t p://w w w.512688.c o m/w s/U p d R e g.a s p x? CorpID=*&Pwd=*&CorpName=*&LinkMan=*&Tel=*&Mobile=*&Email=*&Memo=*查询余额SelSum输⼊入参数:CorpID-帐号Pwd-密码输出参数:整数,>=0,剩余条数;-1、帐号未注册;-2、其他错误;-3、密码错误public int SelSum(string CorpID,string Pwd){}/ws/SelSum.aspx?CorpID=*&Pwd=*发送短信Send输⼊入参数:CorpID-帐号Pwd-密码Mobile-发送⼿手机号Content-发送内容Cell-⼦子号(可为空)SendTime-定时发送时间(固定14位长度字符串,⽐比如:20060912152435代表2006年9⽉月12⽇日15时24分35秒,可为空)输出参数:整数,0,发送成功;-1、帐号未注册;-2、其他错误;-3、密码错误;-4、⼿手机号格式不对;-5、余额不⾜足;-6、定时发送时间不是有效的时间格式;注意:禁⽌止10⼩小时以内向同⼀一⼿手机号发送相同短信;public int Send(string CorpID,string Pwd,string Mobile,string Content,string Cell,string SendTime){}h t t p://w w w.512688.c o m/w s/S e n d.a s p x? CorpID=*&Pwd=*&Mobile=*&Content=*&Cell=*&SendTime=*群发短信BatchSend输⼊入参数:CorpID-帐号Pwd-密码Mobile-发送⼿手机号(多个号码以逗号分隔,最多⽀支持600个号码)Content-发送内容Cell-⼦子号(可为空)SendTime-定时发送时间(固定14位长度字符串,⽐比如:20060912152435代表2006年9⽉月12⽇日15时24分35秒,可为空)输出参数:整数,0,发送成功进⼊入待发进程;1、直接发送成功;-1、帐号尚未注册;-2、其他错误;-3、帐号或者密码错误;-4、⼀一次提交信息不能超过600个⼿手机号码;-5、企业号帐户余额不⾜足,请先充值再提交短信息!;-6、定时发送时间不是有效的时间格式;-7、发送短信内容包含⿊黑字典关键字;-8、发送内容需在3到250个字之间;-9、发送号码为空注意:禁⽌止10⼩小时以内向同⼀一⼿手机号发送相同短信;PublicInt BatchSend(stringCorpID,stringPwd,stringMobile,stringContent,stringCell,stringSendTime) {}h t t p://w w w.512688.c o m/w s/B a t c h S e n d.a s p x? CorpID=*&Pwd=*&Mobile=*&Content=*&Cell=*&SendTime=*群发短信GetReportFail输⼊入参数:CorpID-帐号,Pwd-密码,cell-⾃自定义输出参数:字符串,如果⽆无返回报告返回'全部正确提交,⽆无错误返回报告';-1、帐号未注册;-2、其他错误;-3、密码错误返回格式:||⼿手机号#返回内容#提交时间#定时时间#⼦子号||⼿手机号#返回内容#提交时间#定时时间#⼦子号……public string GetReportFail(string CorpID,string Pwd, string cell){}/ws /GetReportFail.aspx?CorpID=*&Pwd=*&cell=*接收短信Get输⼊入参数:CorpID-帐号,Pwd-密码输出参数:字串,具体字串;-1、帐号未注册;-2、其他错误;-3、密码错误返回格式:||⼿手机号#上⾏行内容#发送时间#⼦子号||⼿手机号#上⾏行内容#发送时间#⼦子号…… public string Get(string CorpID,string Pwd){}/ws/Get.aspx?CorpID=*&Pwd=*帐号充值ChargeUp输⼊入参数:CorpID-帐号Pwd-密码CardNo-充值卡卡号CardPwd-充值卡密码输出参数:整数,0,充值成功;-1、帐号未注册;-2、其他错误;-3、密码错误;-7、充值失败(可能原因:充值卡号密码不匹配或者卡已经被使⽤用)public int ChargeUp(string CorpID,string Pwd,string CardNo,string CardPwd){}/ws/ChargeUp.aspx?CorpID=*&Pwd=*&CardNo=*&CardPwd=*注销UnReg输⼊入参数:CorpID-帐号Pwd-密码输出参数:整数,0,注销成功;-1、帐号未注册;-2、其他错误;-3、密码错误public int UnReg(string CorpID,string Pwd){}/ws /UnReg.aspx?CorpID=*&Pwd=*。
MAS 2WebService短信接口使用说明若雅软件系统有限公司2010-9-19前置条件1. 客户的客户端程序已经开发完成,能够调用MAS提供的WebService服务地址发送短信2. 客户的服务端程序已经开发完成,MAS能够调用客户提供的WebService服务地址将上行短信推送到客户应用系统MAS需要提供的数据1. 提供客户WebService插件应用编号ID:以P开头填写16位编号P0000000000080012. 提供发送短信的WebService服务地址,例如http:// localhost/services/cmcc_mas_wbs备注:MAS向客户提供URL时将示例URL更换为localhost即可,方法名不变,。
以上数据需要提供给客户客户需要提供的数据1. 提供接受短信的WebService服务地址,例如http://localhost:51888/services/cmcc_mas_wbsMAS WebService短信接口页面配置步骤1>在应用接入—客户信息页面,点击“新增”,输入从移动申请的企业代码和基本接入号码,点击“确认”。
步骤2>在应用接入—插件信息页面,点击“新增”,在企业代码下拉列表中选择步骤1设置的企业代码。
输入应用插件编号,为P开头的16位编号。
选择应用系统类型为“插件”。
选择接入时间。
选择通信能力为“短信能力”。
长服务号码、旧服务代码、业务代码分别填写从移动申请的接入信息。
黑白名单选择启用黑名单。
基本接入号可扩展选择“不启用”。
分发上行处理类名勾选WebService短信上行处理类,分发状态报告处理类名勾选WebService短信状态报告处理类。
选择状态为“启用”。
点击“确认”。
步骤3>在插件管理—插件管理中,增加一个WebService插件,在插件标识下拉列表中选择步骤2增加的插件标号,输入开发商信息,例如:roya(此值可任意输入),选择应用系统类别,例如:CRM系统,点击“提交”步骤4>在插件管理—插件注册中,添加一个插件注册信息,插件标识填写步骤1设置的接入ID;插件进程ID填写为任意数字;插件所在的主机IP地址填写对方应用的IP 地址;服务地址填写对方应用的回调地址(用于接收上行短信和获取状态报告)。
短信平台二次开发接口(http和Webservice接口)I.基本说明参数传递时,密码按MD5生成32字节字符串II.Http接口说明1. 文本短信发送示例:/intf/sendsms.asp?UserName=帐号名&Pwd=密码&SmsContent=短信内容&ToPhoneList=接收手机2. 帐户余额查询3. 修改帐号密码示例:/intf/ChangePassword.asp?UserName=帐号名&OldPwd=旧密码&NewPwd=新密码参数说明:III.Webservice接口函数说明WebService地址:/smsservice/service.asmx1. 文本短信发送int SmsSend(string UserName, string Pwd, string Starttime, string SmsContent, string[] ToPhoneList)2. 帐户余额查询int getBalance(string UserName,string Pwd)相关参数说明:3. 用户密码修改int ChangPwd(string UserName,string oldPwd,string newPwd) 参数说明:4. 接收回复短信返回值:接收到的短信结构数组struct stRecvSms{ public string fromtel; //对方号码public string smsmsg; //短信内容public string recvtime; //接收时间}stRecvSms[] GetRecvSMS(string UserName, string Pwd)参数说明:。
DCIwebservice第三方应用配置接口调用说明文档配置:Ip地址:管理员为第三方应用配置验证IP地址,第三方应用调用webservice接口需与此配置IP地址匹配,验证才会通过。
Url地址:为第三方应用所配置的作业回执消息的url地址,作业执行完成后,如果第三方应用订阅该作业url消息回执,系统会将作业回执消息发送给此地址。
Email地址:为第三方应用所配置的作业邮件回执地址,作业执行完成后,如果第三方应用订阅该作业email消息回执,系统会将作业回执消息发送给此地址。
服务授权数配置:配置第三方应用能够同时调用作业运行的个数,(例如配置为5,当第三方应用授权的作业中已经有5个作业正在执行,那么第三方应用将不能调用执行更多的作业)。
参数:Sequence:第三方应用授权序列号,由管理员添加第三方应用时系统自动创建,也是第三方应用执行webservice方法中的身份识别码,由管理员发放给第三方应用。
jobId:执行作业的标志码,用来识别第三方应用所管理作业的唯一标识。
orderType:第三方应用订阅消息回执服务时的参数,1为邮件回执,2为url回执,3为邮件与url同时回执。
方法调换用:1.Webservice以下所有方法只有当系统对外服务开启后,第三方应用才能调用。
2.系统默认根据第三方应用登录IP地址与管理员配置IP地址进行对比,匹配才可执行服务。
订阅所有授权作业消息监控服务http://服务器地址:8080/UT/soap/resultManager/orderTransResultService?sequence=参数&orderType=参数该方法调用为订阅第三方应用所有授权作业消息回执服务,当第三方应用成功调用此方法后,第三方应用会在管理员配置的相应URL地址或者邮箱收到作业回执消息信息。
Xml返回参数信息,message:服务调用返回信息,state:服务是否调用成功。
短信接口使用说明短信接口简介公司网址:56短信网接口是采用C#.Net开发的Web Service,URL地址为:/WebServiceInterface.asmx支持的接口用户可以通过Web Service接口实现用户登陆,发送短信,密码修改,我们还可以根据不同的需要给客户提供不同的接口功能.接口优势1.与移动,联通,电信运营商合作,快捷,高效,成功率达到99% 以上.2.接入方式可灵活使用,保证客户短信的质量。
3.24小时发送,单条即发即收,群发可能少有延迟。
4.适用于各种软件\系统\平台\网站\OA\CRM\ERP\SCM等使用5.发送内容,手机号,自行设定,可定时发送.6.支持500个字的超长短信,可自定义签名。
7.为您提供多种接口,任何语言均可方便,简单接入.8.提供技术支持,免费接入短信接口。
参数说明1. 发送短信调用方法:int SendNote(string handtels,string _content,string userName,string password,string cid,string _sendtime,string _smsnumber)返回值说明:2.用户登陆调用方法: UserLogin(string userName, string password,string cid)返回值说明:3.修改密码调用方法: EditUserPwd(string username, string userpwd,string newpwd,string cid)4.短信剩余条数调用方法: int ReturnUserFullMoney(string username, string password,string cid)返回值说明:5.接受回复短信调用方法: string NoteBack(string _cid, string _username, string _userpwd, string zid, string返回值说明:Xml回复格式<?xml version="1.0" encoding="GBK" ?><backnotes><backnote>//手机号<back_content>老地方见吧</back_content> //内容<back_zid>12</back_zid> //子号<back_time>2011-6-16 16:38:48</back_time> //回复时间</backnote><backnote>//手机号<back_content>你是说</back_content> //内容<back_zid>12</back_zid> //子号<back_time>2011-6-16 16:38:50</back_time> //回复时间</backnote></backnotes>Text 回复格式回复短信和短信之间是用分号分开(说明:如果回复的内容中出现|或;号,请用其它字符替换,如果不能替换的,请调用xml回复格式)格式:手机号|回复短信的内容|时间;6.调用接口新开用户(此接口只适合代理用户)调用方法:string AddNewUser(string aid, string auserName, string apwd, string nusername, string npwd, string customername, string customertel, string customerqq, string customeremaill, string返回值说明:7.短信充值,此接口只适合代理用户(此接口只适合代理用户)调用方法:string FullMoney(string aid, string aname, string apwd, string userid, string username, string tomoney, string action)返回值说明:。
webservice接口说明文档1、组织结构–部门原始资料增加(一般用在初始化数据时) (2)2、组织结构–部门原始资料更新(紧跟DptAdd函数执行) (2)3、组织结构–部门删除 (2)4、组织结构–部门更新 (3)5、组织结构–单个部门增加 (3)6、组织结构–员工原始资料更新(将服务器临时表里的员工原始资料导入到使用的数据表里) (4)7、组织结构–员工原始资料添加 (4)8、组织结构–人员删除 (5)9、组织结构–人员增加(直接更新到后台数据库) (5)10、组织结构–人员更新 (6)11、OA调用发消息 (7)12、组织结构–增加企业 (8)13、组织结构–编辑企业 (8)14、删除企业 (9)15、企业、部门、员工查询 (9)16、角色权限增加 (10)17、角色权限编辑 (10)18、角色权限删除 (11)注明:所有函数的CRC值默认为calling1、组织结构–部门原始资料增加(一般用在初始化数据时)方法名称DptAdd (String DepartID, String DepartName, String ParentID,, String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2 企业不存在 -2 数据库连接错误2、组织结构–部门原始资料更新(紧跟DptAdd函数执行)方法名称DptAddExe (String EID,String CRC,)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 更新数据时发生错误,2 企业不存在-2 数据库连接错误3、组织结构–部门删除方法名称DptDelete (String DepartID)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 删除成功,1 删除数据发生未知错误,2 部门不存在,3企业不存在-2 数据库连接错误4、组织结构–部门更新方法名称: DptEdit (String DepartID,String DepartName,StringParentID, String EID, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 编辑成功,1 删除数据发生未知错误,2部门不存在,3父部门不存在,4 没有要修改的项目,5 企业不存在-2 数据库连接错误5、组织结构–单个部门增加方法名称: DptAddOne (String DepartID,String DepartName,StringParentID,, String EID, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2父部门不存在,3 企业不存在 4 部门已经存在-2 数据库连接错误6、组织结构–员工原始资料更新(将服务器临时表里的员工原始资料导入到使用的数据表里)方法名称EmpAddExe (String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 更新数据时发生错误,2 企业不存在-2 数据库连接错误7、组织结构–员工原始资料添加(将人员资料插入一条到服务器上的临时表里,一般用在起初数据初始化的时候,将记录先循环插入到临时表里,然后使用DptAddExe 函数更新临时表,将原始人员资料导入到使用的数据表里)方法名称EmpAdd(String ID, String CorporationId, String DepartmentId, String duty, String email, String mobile, String realName , String sex, String workCode,String password, String telphone, String String Fax, String CodeType, String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,-2 数据库连接错误2 部门不存在3 员工已存在4 企业不存在8、组织结构–人员删除方法名称EmpDelete (String ID, String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 删除成功,1 删除数据发生未知错误,2 员工不存在3 企业不存在-2 数据库连接错误9、组织结构–人员增加(直接更新到后台数据库)方法名称EmpAddOne (String ID, String CorporationId, String DepartmentId, Stringduty, String email, String mobile, String realName , String sex, String workCode, String password, String telphone, String String Fax, String CodeType, String CRC) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2部门不存在,3员工已经存在,4 企业不存在-2 数据库连接错误10、组织结构–人员更新方法名称EmpEdit (String ID, String EID, String DepartID, String duty, String email, String mobile, String realName , String sex, String workCode, String password, String telphone, String String Fax,String CodeType, String CRC,String State)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2部门不存在3 员工不存在 4 企业不存在-2 数据库连接错误5没有需要修改的项目 6 角色不存在注释:如果许可为空的字段想变化为空的话,以空格为参数值,password,workCode,realName,sex的修改不能以空格表示为空,因为这2个字段不许可为空,如果参数为空则不会修改11、OA调用发消息方法名称:SendOAMessage(String Sender, String Receiver,String BContent, String Title, String MessageType ,String MessageImport, String EID, String CRC)返回类型: integer返回结果: 0 成功,1 失败,-1 缺少必填参数,2 企业不存在,3发送者不存在,4接受者有不存在, 5 网络错误-2 数据库连接错误12、组织结构–增加企业方法名称:CorpAdd(String EID,String brief, String address, String email, String fax, String fullName,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 增加成功,1 增加数据发生未知错误,2 输入的公司人数超过了系统的许可, 3 企业ID已经存在-2 数据库连接错误13、组织结构–编辑企业方法名称:CorpEdit(String EID, String brief,String address, String email, String fax, String fullName,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 删除数据时发生错误,2企业不存在3 没有要编辑的项目-2 数据库连接错误注释:如果许可为空的字段想变化为空的话,以空格为参数值,对于brief,不修改则为空,如果为空则不修改14、删除企业方法名称: CorpDelete (String EID,String CRC)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数,0 操作成功,1 删除数据时发生错误,2 企业不存在-2 数据库连接错误15、企业、部门、员工查询方法名称: GetIDBool (String GetType,String EID,String ID, String CRC) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误-3 企业不存在 3 企业存在 -4 部门不存在 4 部门存在 -5 员工不存在 5 员工存在 6 查询类型错误注释:GetType 为1时ID 可为空,否则不许可为空,在部门和员工查询时,如果企业不存在,则报部门或者员工不存在16、角色权限增加方法名称UserRole Add(String RoleName, String Rights ,String EID,String CRC,) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误 2 企业不存在 3 角色已存在0成功17、角色权限编辑方法名称UserRoleedit(String RoleName, String Rights ,String EID,String CRC,) 参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误,2修改类型错误,3新角色名称不能为空,4企业不存在,5角色不存在0成功18、角色权限删除方法名称UserRoleDel(String RoleName, String EID,String CRC,)参数说明:返回类型: Integer返回值说明: -1 缺少必填参数, 1 查询数据时发生错误,-2 数据库连接错误 2 企业不存在0成功。
WebService接口文档文档版本号:v9.9.5更新时间:2016年09月28日重要说明本人/本公司在使用本软件过程中,将严格遵守国家相关法律、法规、保证本公司信息发布的安全,并切实做到:(1)建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度,建立健全本公司信息安全责任制度和信息发布的审批制度,严格审查本公司产品所发布信息。
(2)严格遵守《互联网信息服务管理办法》,对用户编辑的信息内容进行把关,保证信息内容的健康、合法。
(3)明确本企业的客户群和客户范围,所有通讯受众必须是自愿且明确同意接受企业服务。
(4)若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任;同时,本人/本公司也应承担若因此给本软件版权方造成的全部损失。
(5)不利用本软件制作、复制、发布、传播含有下列内容的信息:✧反对宪法所确定的基本原则的;✧危害国家安全,泄露国家秘密,颠覆国家政权,破坏国家统一的;✧损坏国家荣誉和利益的;✧煽动民族仇恨、民族歧视,破坏民族团结的;✧破坏国家民族宗教政策,宣扬邪教和封建迷信的;✧散布谣言,扰乱社会秩序,破坏社会稳定的;✧散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的;✧侮辱或者诽谤他人,侵害他人合法权益的;✧含有法律、行政法规禁止的其他内容的;(6)自信息发布六个月内不修改删除信息发送日志内容,日志记录的备份应至少保持6个月以上,在国家机关进行依法查询时,予以提供。
(7)若发现本公司所发布的信息明显属于上述第(5)款所列内容,保证立即停止传输,并向国家有关机关报告。
(8)对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的,应报相关主管部门审核同意后再发布。
(9)对客户的个人信息保密,未经客户同意不得向他人泄漏,但法律规定的除外。
本人/本公司保证:在使用本软件进行信息发布活动中,服从监督和管理;若未做到上述一至八条,本人/本公司愿意承担由此引起的一切法律责任,并接受相应的处罚。
中国电信宽乐通信--短信业务接口规范(修订版 2.0)广州电信分公司增值业务部1概述 (3)1.1接口原则 (3)1.2目标 (3)1.3接口的调用方式 (3)1.4帐号申请 (4)1.5总述 (4)1.6接口定义说明 (6)1.6.1注册接口 (7)1.6.2SendSMS短信相关接口 (9)1.6.3第三方服务器需要实现通用回调函数 (11)2加密规则 (14)3通用失败码 (14)1、概述本文档主要描述了广州电信宽乐通信接口平台对第三方合作商开放业务能力的WebService接口和使用规范。
经运营商分配给使用账号后,第三方合作商能够使用宽乐通信业务平台的通信服务资源,主要有点击拨号、短信收发、多方会议、网络传真功能等服务。
1.1接口原则第三方软件商在进行开发,使用相关接口时,须遵循以下原则:严格按照接口规范文档中所定义的规范格式,进行数据处理对于新增通信服务,将由广州电信制定标准接口,并更新接口协议,通知第三方各软件合作商;1.2目标宽乐通信与第三方软件商接口功能达到如下目标:接口简单便于操作,并能够兼容接口以后扩充;提供对外的开放性,能够具备接入认证功能,保证系统的安全性;接口标准对外可靠和高效;提供解决故障的手段和流程机制,由于面向客户提供的服务将由传统方式中的运营商一种角色,转变成软件合作商和运营商多个角色,因此须提供高效的机制,能够定位故障和解决。
1.3接口的调用方式实现方式:调用Web Service服务,遵循标准的soap协议。
第三方软件产品与宽乐通信业务平台互为客户端和服务端。
第三方软件产品按照各操作规范和文档格式进行数据填充,主动调用宽乐通信业务平台提供的相关Web Service服务。
平台根据应用请求注册的回调处理地址,异步返回回调处理。
1.4帐号申请凡需使用广州电信宽乐通信相关通信资源的的第三方合作商,需至广州电信申请相应的宽乐通信帐号。
该宽乐通信帐号具备相应的业务使用能力。
WebService接口说明文档文档说明本文档主要讲述如何用C Sharp创建一个简单的Web Service接口,并使用Java调用这个Web Service接口。
准备工作系统环境:安装JDK1.6或更新版本开发工具:Microsoft Visual Studio 2012、MyEclipse 10.5、axis2-1.6.2C Sharp服务端1.首先,创建一个Web Service项目。
依次点击:文件—新建—项目,在弹出的新建项目窗口中选择Web下的 空 Web 应用程序。
如下图:2.接下来我们需要创建我们的Web Service接口实现文件。
鼠标右击我们的项目,依次点击:添加—新建项,在弹出窗口中选择Web 服务。
可修改新建项的文件名,注意文件名后缀后.asmx。
如下图:新建完成后我们的项目结构如下:3.打开我们新建的MyService.asmx下的MyService.asmx.cs文件,可以看到其中已经有默认的HelloWorld方法。
我们可以直接运行查看下运行的效果,效果如下图:点击HelloWorld,再点击调用可以看到页面返回:4.接下来我们完善我们的Web Service接口功能。
主要对Web Service接口进行参数类型的测试,文本型、布尔型、数值型、类(Class)等。
新增Add()等运算方法:新增strcat()连接字符串方法:新增GetBool()返回布尔值方法:新增GetTest()返回测试类,并新增Test类运行我们的项目,可以看到我们的结果如下图:点击add方法测试:输入add的参数i和j点击调用按钮,可以看到返回计算结果:5.到此为止我们C Sharp创建的Web Service程序完成。
接下来看Java如何调用我们的Web Service接口。
Java调用Web Service准备对于一个Web Service接口我们当前只知道访问的地址,我们如何用Java去访问接口呢?已知Web Service接口地址:http://localhost:11766/MyService.asmx?WSDLJava调用Web Service的方式有以下1.使用HttpClient2.使用Xfire3.使用axis2本文档示例选择的是axis2,首先到axis2网站下载axis2,网址:/axis2/java/core/download.cgi当前最新版本1.6.2。
亿美软通短信平台SDK4.2.0(WebService版)用户手册作者:北京亿美软件科技有限公司完成日期: 2010-08-16签收人:签收日期:修改情况记录:北京亿美软通科技有限公司地址:北京市朝阳区光华路4号东方梅地亚中心C座20层()网址:手机快捷网址:电话:010- 传真:010-售前咨询:400-810-7255 售后服务:400-779-7255手机中文实名:亿美软通亿美移动商务目录用户手册 ........................................................ 错误!未定义书签。
1亿美软通WEBSERVICE接口开发说明...................................... 错误!未定义书签。
1.1简介 ..................................................................................................................... 错误!未定义书签。
1.2背景 ..................................................................................................................... 错误!未定义书签。
1.3定义 ..................................................................................................................... 错误!未定义书签。
1.4开发流程.............................................................................................................. 错误!未定义书签。
开放式虚拟仿真实验教学系统Web Services业务接口规范说明书1.范围本规范文档主要适用于开放式虚拟仿真实验教学系统和其它业务系统信息数据的接入。
2.术语、定义和缩略语2.1术语、定义2.2缩略语3.接口设计3.1接口公共参数接口服务器通过:http://IP:port/EIP/WebService/ 连接服务器,同时对外提供业务功能接口,接收的参数和返回的参数都用一定的xml格式进行封装。
3.1.1请求参数1.请求类型为String类型<?xml version="1.0" encoding="utf-8" ?><request><header type ="xx01" version="1.0" reqtype="0" userid="user000000000001"></header><param></param></request>2.头部参数体head定义请求参数的头部参数体header格式固定,定义如下:3.请求参数体param定义参数体param中的具体请求参数,根据不同的业务而不同,详见各业务接口。
3.1.2返回参数1.返回类型为String类型<?xml version="1.0" encoding="utf-8"?><response><header type ="XX01" value="XX00" info="成功"></header><result></result></response>2.头部参数体head定义返回参数的头部参数体header格式固定,定义如下:3.返回值参数体result定义参数体result中的具体返回参数,根据不同的业务而不同。
客户接口说明21 接口说明.......................................................................................22 发送接口.......................................................................................2.1 调用接口 ..................................................................................222.2 参数说明 ..................................................................................2.3 请求和响应 ................................................................................332.3.1 SOAP 1.2请求 ........................................................................42.3.2 SOAP 1.2响应 ........................................................................42.3.3 HTTP POST请求 ....................................................................42.3.4 HTTP POST响应 ....................................................................53 余额接口.......................................................................................53.1 调用接口 ..................................................................................53.2 参数说明 ..................................................................................53.3 请求和响应 ................................................................................63.3.1 SOAP 1.2请求 ........................................................................63.3.2 SOAP 1.2响应 ........................................................................73.3.3 HTTP POST请求 ....................................................................73.3.4 HTTP POST响应 ....................................................................84 状态报告接口 ...................................................................................84.1 调用接口 ..................................................................................84.2 参数说明 ..................................................................................84.3 请求和响应 ................................................................................4.3.1 SOAP 1.2请求 ........................................................................994.3.2 SOAP 1.2响应 ........................................................................104.3.3 HTTP POST请求 ....................................................................114.3.4 HTTP POST响应 ....................................................................115 上行回复接口 ...................................................................................115.1 调用接口 ..................................................................................125.2 参数说明 ..................................................................................125.3 请求和响应 ................................................................................125.3.1 SOAP 1.2请求 ........................................................................135.3.2 SOAP 1.2响应 ........................................................................145.3.3 HTTP POST请求 ....................................................................145.3.4 HTTP POST响应 ....................................................................接口说明:客户接口部分提供WebService方式的接口,接口编码方式采用统一的UTF-8,如需HTTP协议接口,请联系客服1 接口说明请求地址是客户接口程序调用时请求的WebService地址,地址是http://客户端地址/SmsWebService.asmx?wsdl入口地址一般不会发生变化,当发生变化的时候,会通知接口用户客户端地址 为域名或 IP:客户端端口2 发送接口2.1调用接口string sendTime, stringstring password, string mobile, string content,SendSms(string userid,string account,extno)2.2参数说明参数名称 含义 说明userid企业id 企业IDaccount 发送用户帐号 用户帐号password 发送帐号密码 用户账号对应的密码mobile 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开content 发送内容 短信的内容,内容需要UTF-8编码 sendTime 定时发送时间为空表示立即发送,定时发送格式2010-10-2409:08:10extno 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。
短信平台WebService接口文档(v2)短信平台WebService接口文档(v2)一、接口地址http://61.135.253.77/SMS_BlueWings/SMS_BlueWingsInfo.a smx?wsdl二、接口说明容大友信的接口分为以下部分:1.用户登陆接口GetUserLogin接口说明:用户登陆接口接口参数:(1)strUserName: 用户帐号名称(2)strUserPass: 用户帐号密码,使用MD5算法加密,把用户密码变成32位的MD5字符串(小写)。
(3)strUserIP: 用户登陆IP地址返回参数:(1)strUserHash: 如果登陆成功,将返回一个32位的Hash字符串,这个字符串用于此后所有接口操作的用户标识。
(以下简称用户唯一标识)GetUserLogout接口说明:用户退出系统接口。
(1)strUserHash: 用户退出的时候,发送这个标识给服务器,作为退出接口操作。
2.短信发送接口(一共有三个)SetMessageBegin接口说明:发送短信前准备接口参数:(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strCount: 用户此次要发送的用户总数量。
返回参数:(1)int 如果成功返回0;SetMessage接口说明:发送短信过程接口参数:(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strTarPhone: 要发送的对方手机号码。
(3)strMessage: 要发送的短信内容。
返回参数:(1)Bool 如果成功返回True; 否则是False;SetMessageEnd接口说明:发送短信过程结束接口参数:(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strPDate: 预约短信时间,如果是要预约短信,在这里加入预约短信的时间。
如果是即时发送短信,填空值返回参数:(1)int如果成功返回0;3.用户信息查询接口GetUserRegInfo接口说明:得到用户的注册信息。
竭诚为您提供优质文档/双击可除webservice接口说明文档模板篇一:项目接口需求及设计说明文档(模板)客户化开发需求规格说明书媒讯集团eas项目ctc与eas接口需求及设计说明书文档作者:创建日期:20xx-05-10确认日期:当前版本:1.0拷贝数量:1审批签字:客户方:实施方:文档控制目录1.概述..............................................................................................41.1读者................................................. ................................................... ..............................................41.2图例................................................. ................................................... ..............................................41.3目的................................................. ................................................... ..............................................4二、业务现状................................................. .............................. ................................................... ...............5三、概要设计................................................. ................................................... (5)3.1接口通讯方................................................... ...............................53.2通讯内容定义................................................. ................................................... ...............................53.3媒讯ctc系统提供接口使用范例................................................. . (53).4金蝶eas提供接口使用范例................................................. ................................................... ......53.5媒讯ctc系统提供接口服务地址................................................. . (73).6金蝶eas提供接口服务地址................................................. ................................................... ......73.7接口需求................................................. ................................................... .......................................7四、详细设................................................... (8)4.1xxeas接口................................................. ................................................... .. (8)1.概述金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。
WebService 接口说明 1下载文档WebService2006-8-5一、接口定义a) SendMessage 批量发送短信方法 (userID)i. public SendState SendMessage(string UserId, string Password, string Msg, stringDestnumbers)ii. 参数说明:UserId 用户Id(晴朗平台识别的用户号码), 49字节以内。
Password 密码, 99字节以内Msg 短信内容, 159字节以内 Destnumbers 目标号码,用分号(;)分隔,在一万条以内。
iii. 返回值public class SendState{public int state;public string WrongNumbers;public string YDGroupId; // 发送到移动的短信的批次号public string LTGroupId; // 发送到联通的短信的批次号}state 0: success2: 失败需要重发4: 内容不合法5: 身份验证错误6: 服务器错误8: 短信数超过可用数12: 该用户不允许使用子用户ID13: 错误的号码格式WrongNumbers 为错误的目标号码,用分号分隔,目前只是按移动和联通进行过滤。
即不属于联通或移动的号码会被放入这里。
YDGroupId, LTGroupId 发送的短信所属的批次号,用于以后查询短信的发送状态。
b) SendMessageWithSub 发送短信时带有子号码 (userID)i. public SendState SendMessageWithSub(string UserId, string SubId, stringPassword, string Msg, string Destnumbers)ii. 参数说明UserId 用户Id(晴朗平台识别的用户号码),49字节以内。
WebService 接口说明 1下载文档WebService2006-8-5一、接口定义a) SendMessage 批量发送短信方法 (userID)i. public SendState SendMessage(string UserId, string Password, string Msg, stringDestnumbers)ii. 参数说明:UserId 用户Id(晴朗平台识别的用户号码), 49字节以内。
Password 密码, 99字节以内Msg 短信内容, 159字节以内 Destnumbers 目标号码,用分号(;)分隔,在一万条以内。
iii. 返回值public class SendState{public int state;public string WrongNumbers;public string YDGroupId; // 发送到移动的短信的批次号public string LTGroupId; // 发送到联通的短信的批次号}state 0: success2: 失败需要重发4: 内容不合法5: 身份验证错误6: 服务器错误8: 短信数超过可用数12: 该用户不允许使用子用户ID13: 错误的号码格式WrongNumbers 为错误的目标号码,用分号分隔,目前只是按移动和联通进行过滤。
即不属于联通或移动的号码会被放入这里。
YDGroupId, LTGroupId 发送的短信所属的批次号,用于以后查询短信的发送状态。
b) SendMessageWithSub 发送短信时带有子号码 (userID)i. public SendState SendMessageWithSub(string UserId, string SubId, stringPassword, string Msg, string Destnumbers)ii. 参数说明UserId 用户Id(晴朗平台识别的用户号码),49字节以内。
SMSAPI调用使用指南(WebService)XX傲融软件技术XX2008年6月一、发送短信函数名称:SendSmsToServerXML参数结构:Soap消息体:<?xml version="1.0" encoding="gb2312"?> <SmsInfo xmlns=".uniproud."xmlns:xsi="/2001/XMLSchema-instance"xsi:schemaLocation=".uniproud. sms_schema.xsd"> <Login><UserID>12345</UserID><Password>abcd123</Password></Login><SendTaskList><SendTask><ClientTaskID>1</ClientTaskID><SmsNumber></SmsNumber></SendTask>……<SendTask><ClientTaskID>1</ClientTaskID><SmsNumber></SmsNumber></SendTask></SendTaskList><SmsOptions><Priority>0</Priority><Content>0</Content></SmsOptions></SmsInfo>表明调用函数SendSmsToServer返回结果XML参数结构:Soap消息体:<?xml version="1.0" encoding="gb2312"?><soap:Envelope xmlns:xsi="/2001/XMLSchema-instance"xmlns:xsd="/2001/XMLSchema"xmlns:soap="/soap/envelope/"><soap:Body><Header><ErrorFlag>int</ErrorFlag><ReturnMessage>string</ReturnMessage></Header><SendSmsToServerResponse><SendSmsToServerResult><JobNo>string</JobNo><TotalNum>int</TotalNum><ValidNum>int</ValidNum></SendSmsToServerResult></SendSmsToServerResponse></soap:Body></soap:Envelope>二、查询发送清单函数名称:QueryResultForSmsTask查询所有未获取的清单注:如果查询条件都不填,即查询所有发送清单;如果有查询条件,条件是”与”的关系。
短信平台WebService接口文档(v2)
一、接口地址
http://61.135.253.77/SMS_BlueWings/SMS_BlueWingsInfo.asmx?wsdl
二、接口说明
容大友信的接口分为以下部分:
1.用户登陆接口
GetUserLogin
接口说明:用户登陆接口
接口参数:
(1)strUserName: 用户帐号名称
(2)strUserPass: 用户帐号密码,使用MD5算法加密,把用户密码变成32位的MD5字符串(小写)。
(3)strUserIP: 用户登陆IP地址
返回参数:
(1)strUserHash: 如果登陆成功,将返回一个32位的Hash字符串,这个字符串用于此后所有接口操作的用户标识。
(以下简称用户唯一标识)
GetUserLogout
接口说明:用户退出系统接口。
(1)strUserHash: 用户退出的时候,发送这个标识给服务器,作为退出接口操作。
2.短信发送接口(一共有三个)
SetMessageBegin
接口说明:发送短信前准备
接口参数:
(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strCount: 用户此次要发送的用户总数量。
返回参数:
(1)int 如果成功返回0;
SetMessage
接口说明:发送短信过程
接口参数:
(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strTarPhone: 要发送的对方手机号码。
(3)strMessage: 要发送的短信内容。
返回参数:
(1)Bool 如果成功返回True; 否则是False;
SetMessageEnd
接口说明:发送短信过程结束
接口参数:
(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strPDate: 预约短信时间,如果是要预约短信,在这里加入预约短信的时间。
如果是即时发送短信,填空值
返回参数:
(1)int如果成功返回0;
3.用户信息查询接口
GetUserRegInfo
接口说明:得到用户的注册信息。
返回是一个DataTable表结构的XML。
接口参数:
(1)strUserHash: 登陆后用户的用户唯一标识。
返回参数:是一个DataTable的表,内容如下。
(1) UserEnterprise 用户的企业名称。
(2) UserFax 用户的传真。
(3) UserAreaCode 用户的邮编
(4) UserAddress 用户的地址
(5) UserAffiliationPeople 用户的法人
(6)UserAffiliationPhone 用户的法人电话
(7) UserAffiliationHandPhone 用户的法人电话手机号码
(8) UserMail 用户的邮箱
(9) ModeInfo 用户的模式,1 为测试用户,2为预付用户,3为
后付用户
GetUserAccount
接口说明:得到2个日期间的发送数据的统计。
接口参数:
(1)strUserHash: 登陆后用户的用户唯一标识。
(2)strUserDate: 日期格式(2007-1-1)
(3)strUserEndDate (2007-1-1)
返回参数:
返回的是DataTableXML格式。
(1)成功发送返回年度发送成功的条数。
(2) 失败发送返回年度发送失败的总条数。
(3) 总发送总共年度发送量。
(4) 月成功发送量
(5) 月失败发送量
(6) 月总发送量
(7) 当天成功量
(8) 当天失败量
(9) 当天总发送量
(10) 发送日期发送日期
GetUserLTResponse
接口说明:得到联通的回复短信。
返回参数:
返回的是DataTableXML格式。
(1)用户手机回复的手机号码
(2) 发送号码短信发送的号码
(3) 短信内容回复短信内容
(4) 回复时间回复短信的时间
GetUserYDResponse
接口说明:得到移动的回复短信。
返回参数:
返回的是DataTableXML格式。
(1)用户手机回复的手机号码
(2) 发送号码短信发送的号码
(3) 短信内容回复短信内容
(4) 回复时间回复短信的时间
GetUserRegInfo
接口说明:得到用户的注册信息。
返回是一个DataTable表结构的XML。
接口参数:
(1) strUserHash: 登陆后用户的用户唯一标识。
返回的是DataTableXML格式
其中,UserMaxCount – UserCurrCount 即是用户余额
扩展部分(推荐)
SetMessageEx
接口说明:发送短信过程扩展
接口参数:
(4)strUserHash: 登陆后用户的用户唯一标识。
(5)strTarPhone: 要发送的对方手机号码。
(6)strMessage: 要发送的短信内容。
返回参数:
(1)string返回错误手机号码的集合
GetUserLTResponseEx
接口说明:得到联通的回复短信扩展
接口参数:
(1)strUserHash登陆后用户的用户唯一标识。
(2)strDate: 查询这个时间后的用户上行信息。
返回参数:
返回的是DataTableXML格式。
(1)用户手机回复的手机号码
(2) 发送号码短信发送的号码
(3) 短信内容回复短信内容
(4) 回复时间回复短信的时间
GetUserYDResponseEx
接口说明:得到移动的回复短信扩展
接口参数:
(3)strUserHash登陆后用户的用户唯一标识。
(4)strDate: 查询这个时间后的用户上行信息。
返回参数:
返回的是DataTableXML格式。
(1)用户手机回复的手机号码
(2) 发送号码短信发送的号码
(3) 短信内容回复短信内容
(4) 回复时间回复短信的时间。