企业信使运营管理平台API接口调用说明.docx
企业信使运营管理平台AP1.接口说明客户接口说明I第一:发送接口21.1恳求地址2参数说明2返回值3其次节余颠及已发送成查询接口32.1恳求地址3参数说明4返回值4第三章非法关键词查询43.1恩来地址4参数说明返回值笫四格状态报告接口54.1恳求地址参数说明5返回值6错误返回值状态报告恳求错误返回格式及对应值6接11说明:客户接口局加供应Ur1.方式的接11,依据客户需求可以供应相应接II,接口编码方式采纳统一的UTF-8接11账户请登录我们网站注册:接”账户必需贴英文格式不支持中文名!企业ID在登录系统后查仔我的信总!第一章发送接口1.1恳求地址恳求地址是客户按口程序调用时恳求的Uri地址,来熟的是POS1.接口.地址是入11地址一般不会发生改变,当发生改变的时候,会通知接11用户参数说明参数名称含义说明userid企业k1.企业IDaccount发送用户帐号用户帐号,由系统管理员password发送帐号密码用户煤号对应的密码mobi1.e全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开content发送内容短信的内容scndTimc定时发送时间为空表示马上发送.定时发送格式2021/62409:08:10action发送任务吩咐设置为固定的:SCndChcXkgnICnt是否检查内容包含非法关犍字当设置为I时表示须要检吏,欣认0为不检杳例如:action=scnd<Suscrid=12<8raccount=账号&pass*Ord=密码nwbi1.c=.contcnt=内容AscndTimc=Achcckcontcnt=I返回值在接收到客户端发送的恳求后返回以Xm1.的方武返回处理结果.格式为:<?xm1.version=*I.0menc<xiing=Mu(f-8"?><rc1.umsms><rctumstatus>status<.'re1.umstatus>返回状态值:胜利返回SUCCCJiJi失败返付1:Eai1.d<messagc>mcssagc<'mcssagc>返I可信息:Er我<remainpoint>remairoint<remainpoint>-返回余额<task1.D>task1.D<aask!D>返回本次任务的序列ID<succcssCounts>succcssCounts<successCounts>胜利短信数:当胜利后返I可提交胜利短信数<.'rc1.umsms>返回信息提示说明ok提交胜利用户名或密码不能为空提交的用户名或密码为空发送内容包含刈注入字符包含sq1.注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符:农示检查到不允许发送的非法字符对不起,您当前要发送的附大于您当前余额当支付方式为预付费是,检查到账户余额块乏其他错误其他数据件操作方面的错误其次章余额及已发送查询接口2.1恳求地址总求地址是客户接I程序调用的时候总求的ur1.地址,采纳的是post接1-1,地址是参数说明叁数名称含义说明userid企业id企业IDaccount用户帐号用户帐号由系统管理员password帐号密码用户账号对应的密码action任务名称设沼为固定的:overage例如:ac1.H>n=ovcragc<fcuserid=12accoun1.=1.;*Jpassw>rd=ffi¾返回值<?xm1.version=*1.0,'encoding=,uif-8"?><rc1.umsms><rctumstatus>status<rctumstats>返回状态值:胜利返回SiICCCSS失败返叵hEai1.d<mcssagc>mcssagc<,mcssagc>返I可信息提示:七下&<a>,inf>payinfo<payinfb>返回支付方式后付费,预付费<ovcrage>overage<ovcrage>返回U.发送条数VSCndRMaI>scndTouk/SCndTotaI>返回总1点数当支付方式为预付费是返回总充值点数<rc(umsm>返I可信息提示说明返回空查询胜利将返网相应的支付方式、账户运用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误第三章非法关键词查询3.1恳求地址恳求地址是客户接【1程序附用的时帔恳求的Ur1.地址,采纳的是PaM接II,地址是参数说明叁数名称含义说明userid企业id企业IDaccount用户帐号用户帐号由系统管理员password帐号密码用户账号对应的密码action任务名称设湿为固定的:Checkkeywondconcent依测发送内容须要发送的内容例如:acion=checkkeyword&userid=12&accoiint二账J&p淋SWOnJ=南码二内容返回值<?xm1.version="1.0"cncoding=*u1.f-8"?><re(umsms><message>message<.«mcssage>一返回信息提示:虬卜衣<rctumsms>返回信息提示说明用户名或密码不能为空提交的用户名或密玛为空用户名或密码错误表示用户名或密码错误包含非法字符检查出耒包含非法关键词未包含非法字符未检杳出非法关键词第四章状态报告接口4.1恳求地址恳求地址是客户接口程序调用的时候恳求的UrI地址,米纳的是PoS1.接口,地址是入“地址一般不会发生改变,当发生改变的时候,会通知接口用户参数说明叁数名称含义说明Iuserid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设St为固定的:query例如:action=qucryuscrid=12account=号&password=密码返回值<?Xm1.vcrsion="i.O*'CnCOding="11f8”?>VrC1.UmSms><statusbox>Vmobi1.C>0<nbi1.e>对应的手机号码<taskid>1212<taskid>同一批任务ID<status>1.(KAtatus>状态报告10:发送胜利,20:发送失败<receivetime>2021-12O222:12:11<receivetime>接收时间<s1.atusbx><statusbox><11>obi1.c>I<mobi1.c><(askid>121.2<taskid><status>20<s1.a1.us><rcceivctmc>2O21-12-<)222:12:11<'rcccvctimc><statusbox><re(umsms>错误返回值一状态报告恳求错误返回格式及对应值<7x1.version=*1.0-cnc<iing="utf-8"?><retumsms><crrors1.a1.us><crror>1.<crror>描误码<rcmark>JI户名或密码不能为空<rcmark>错误描述<errorsatus><Zrc1.umsms>1:用户名或密码不能为空2:用户名或密码错误3:该用户不允许杳石状态报告4:参数不正确第五章上行接口5.1 恳求地址恳求地址是客户接口程序调用的时候恳求的Ur1.地址,米纳的是PoS1.接口,地址是入“地址般不会发生改变,当发生改变的时候,会通知接口用户5.2 参数说明弁数名称含义说明userid企业id企业IDaccount用户帐号用户帐号,由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的:query例如:ac1.in=quer>,Auserid=12accoun1.=<S&password=5.3 返回值<?xm1.version=*I.Omencoding='*u1.f-8,?>VnnUESms><ca1.1.box><nobi1.e><mobi1.e>-一对应的手机号码<(askid>1212<taskid>同一批任务IDVccmIent>你好我小须要<Aru11un1.>J1.行内容<roceivctime>2021-12-0222:12:11<rcccivctimc>接收时间UCaHbox)<ca1.1.bx><mobi1.c>1<mobi1.c><1.askid>1212<,taskid><voncm>你好,本次活动路途是怎么的<x>mc11><receivetime>2O21-12-0222:12:1KZreceivetimo<ca1.1.box><rc<umsms>5.4错误返回值一回复恳求错误返回格式及对应值<?Xm1.vcrsion="1.(cncoding=Mutf-8"?><rctumsrns><corstatus><error>1.<error>错误码Vremark>用户名或密码不能为空Vremark>错误描述<corstatus><rc(umsm>I:用户名或密码不能为空2:用户名或密码错误3:该用户不允许看看状态报告4:参数不正确接11账户请登录我们网站注册-J/接11账户必箭是英文格式不支持中文名!