企业信使运营管理平台API接口调用说明.doc

.企业信使运营管理平台API接口说明客户接口说明1第一章 发送接口21.1 请求地址21.2参数说明21.3返回值3第二章 余额及已发送量查询接口32.1 请求地址32.2参数说明42.3返回值4第三章 非法关键词查询43.1 请求地址43.2参数说明53.3返回值5第四章 状态报告接口54.1 请求地址54.2参数说明54.3返回值64.4错误返回值状态报告请求错误返回格式及对应值6接口说明：客户接口部分提供http url方式的接口，根据客户需求可以提供相应接口，接口编码方式采用统一的UTF-8接口账户请登录我们网站注册 接口账户必须是英文格式 不支持中文名！企业ID 在登录系统后查看 我的信息！第一章 发送接口1.1 请求地址请求地址是客户接口程序调用时请求的url地址，采用的是http post 接口，地址是/sms.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户1.2参数说明/sms.aspx?action=send参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号，由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开 content发送内容短信的内容sendTime定时发送时间为空表示立即发送，定时发送格式2010-10-24 09:08:10action发送任务命令设置为固定的:sendcheckcontent是否检查内容包含非法关键字当设置为1时表示需要检查，默认0为不检查例如：action=send&userid=12&account=账号&password=密码&mobile15265260972&content=内容&sendTime=&checkcontent=11.3返回值在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。格式为：status - 返回状态值：成功返回Success 失败返回：Faildmessage - 返回信息：见下表 remainpoint - 返回余额taskID - 返回本次任务的序列IDsuccessCounts -成功短信数：当成功后返回提交成功短信数返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符：表示检查到不允许发送的非法字符对不起，您当前要发送的量大于您当前余额当支付方式为预付费是，检查到账户余额不足其他错误其他数据库操作方面的错误第二章 余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是/sms.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户2.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：overage例如：action=overage&userid=12&account=账号&password=密码2.3返回值status-返回状态值：成功返回Success 失败返回：Faildmessage-返回信息提示：见下表payinfo-返回支付方式 后付费，预付费overage-返回已发送条数sendTotal-返回总点数 当支付方式为预付费是返回总充值点数返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误第三章 非法关键词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是/sms.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户3.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：checkkeywordcontent检测发送内容需要发送的内容例如：action=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值message-返回信息提示：见下表返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词未包含非法字符未检查出非法关键词第四章 状态报告接口4.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是/statusApi.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户4.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：query例如：action=query&userid=12&account=账号&password=密码4.3返回值 186639311060-对应的手机号码1212-同一批任务ID10-状态报告-10：发送成功，20：发送失败2011-12-02 22:12:11-接收时间1866393110611212202011-12-02 22:12:114.4错误返回值状态报告请求错误返回格式及对应值 1-错误码用户名或密码不能为空-错误描述1：用户名或密码不能为空2：用户名或密码错误3：该用户不允许查看状态报告4：参数不正确第五章 上行接口5.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是/callApi.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户5.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：query例如：action=query&userid=12&account=账号&password=密码5.3返回值对应的手机号码1212-同一批任务ID你好，我不需要-上行内容2011-12-02 22:12:11-接收时间1866393110611212你好，本次活动路线是怎么的2011-