1、广州掌骏网络技术有限公司掌骏传媒-短信接口说明掌骏传媒-短信接口说明 .1第一章 发送接口 .21.1 请求地址 .21.2 参数说明 .21.3 返回值 .2第二章 余额及已发送量查询接口 .32.1 请求地址 .32.2 参数说明 .32.3 返回值 .4第三章 非法关键词查询 .43.1 请求地址 .43.2 参数说明 .43.3 返回值 .5第四章 状态报告接口 .54.1 请求地址 .54.2 参数说明 .54.3 返回值 .54.4 错误返回值 状态报告请求错误返回格式及对应值 .6第五章 上行接口 .75.1 请求地址 .75.2 参数说明 .75.3 返回值 .75.4 错误返
2、回值 回复请求错误返回格式及对应值 .8第六章 密码修改接口 .86.1 请求地址 .86.2 参数说明 .86.3 返回值 .9广州掌骏网络技术有限公司接口说明：客户接口部分提供 http url 方式的接口，根据客户需求可以提供相应接口。第一章 发送接口1.1 请求地址请求地址是客户接口程序调用时请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/v2sms.aspx 对应 UTF-8http:/120.77.14.55:8888/v2smsGBK.aspx 对应 GB2312入口地址一般不会发生变化，当发生变化的时候，会通知接口
3、用户1.2 参数说明http:/120.77.14.55:8888/v2sms.aspxhttp:/120.77.14.55:8888/v2smsGBK.aspx参数名称 含义 说明userid 企业 id 企业 IDtimestamp 时间戳 系统当前时间字符串，年月日时分秒，例如：20120701231212sign 签名 使用 账号+密码+时间戳 生成 MD5 字符串作为签名。MD5 生成 32 位，且需要小写例如：账号是 test 密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名，生成的签名为5cc689
4、82f55ac74348e3d819f868fbe1其他参数没错的话，提示错误的时候检查加密结果对不对。mobile 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开 content 发送内容 短信的内容，内容需要 UTF-8 编码sendTime 定时发送时间 为空表示立即发送，定时发送格式 2010-10-24 09:08:10action 发送任务命令 设置为固定的:sendextno 扩展子号 请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多10 位数。例如：action=send&userid=12×tamp=20120701231
5、212&sign 广州掌骏网络技术有限公司=5cc68982f55ac74348e3d819f868fbe1&mobile=15023239810,13527576163&content=内容&sendTime=&extno=1.3 返回值在接收到客户端发送的 http 请求后，返回以 xml 的方式返回处理结果。格式为：status - 返回状态值：成功返回 Success 失败返回：Faildmessage - 返回信息：见下表remainpoint - 返回余额taskID - 返回本次任务的序列 IDsuccessCounts -成功短信数：当成功后返回提交成功短信数返回信息提示 说明
6、ok 提交成功用户名或密码不能为空 提交的用户名或密码为空发送内容包含 sql 注入字符 包含 sql 注入字符用户名或密码错误 表示用户名或密码错误短信号码不能为空 提交的被叫号码为空短信内容不能为空 发送内容为空包含非法字符： 表示检查到不允许发送的非法字符对不起，您当前要发送的量大于您当前余额 当支付方式为预付费是，检查到账户余额不足其他错误 其他数据库操作方面的错误附加：如果提交返回签名错误，检查 content 值是否是：【签名】+内容。否则，检查 sgin值加密结果跟在线 md5 加密对比下是否一致。注 1：提交成功，才是正常提交。正确调用接口，不管提交成功失败接口都返回一个xml
7、。注 2：使用不同编码格式的接口，要注意编码格式。注 3：taskID 生成规则，就是经过特殊处理的数字，唯一的 ID，8 位。注 4：一次提交最多 4000 个号码。广州掌骏网络技术有限公司第二章 余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/v2sms.aspxhttp:/120.77.14.55:8888/v2smsGBK.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户2.2 参数说明参数名称 含义 说明userid 企业 id 企业
8、 IDtimestamp 时间戳 系统当前时间字符串，年月日时分秒，例如：20120701231212sign 签名 使用 账号 +密码+时间戳 生成 MD5 字符串作为签名。MD5 生成 32 位，且需要小写例如：账号是 test 密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名，生成的签名为5cc68982f55ac74348e3d819f868fbe1action 任务名称 设置为固定的：overage例如：action=overage&userid=12×tamp=20120701231212&
9、sign =5cc68982f55ac74348e3d819f868fbe12.3 返回值status-返回状态值：成功返回 Sucess (注意：此处是Sucess，和其它接口返回的 Success 不同)失败返回：Faildmessage-返回信息提示：见下表payinfo-返回支付方式 后付费，预付费overage-返回余额sendTotal-返回总点数 当支付方式为预付费是返回总充值点数广州掌骏网络技术有限公司返回信息提示 说明返回空 查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空 提交的用户名或密码为空用户名或密码错误 表示用户名或密码错误第三章 非法关键
10、词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/v2sms.aspxhttp:/120.77.14.55:8888/v2smsGBK.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户3.2 参数说明参数名称 含义 说明userid 企业 id 企业 IDtimestamp 时间戳 系统当前时间字符串，年月日时分秒，例如：20120701231212sign 签名 使用 账号 +密码+时间戳 生成 MD5 字符串作为签名。MD5 生成 32 位，且需要小写例如：
11、账号是 test 密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名，生成的签名为5cc68982f55ac74348e3d819f868fbe1action 任务名称 设置为固定的：checkkeywordcontent 检测发送内容 需要发送的内容例如：action=checkkeyword&userid=12×tamp=20120701231212&sign =5cc68982f55ac74348e3d819f868fbe1&content=内容广州掌骏网络技术有限公司3.3 返回值message-
12、返回信息提示：见下表返回信息提示 说明用户名或密码不能为空 提交的用户名或密码为空用户名或密码错误 表示用户名或密码错误包含非法字符 检查出来包含非法关键词没有包含屏蔽词 未检查出非法关键词第四章 状态报告接口4.1 请求地址请求地址是客户接口程序调用的时候请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/v2statusApi.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户注意：相同的状态报告，只能获取一次。4.2 参数说明参数名称 含义 说明userid 企业 id 企业 IDtimestamp 时间戳 系统
13、当前时间字符串，年月日时分秒，例如：20120701231212sign 签名 使用 账号 +密码+时间戳 生成 MD5 字符串作为签名。MD5 生成 32 位，且需要小写例如：账号是 test 密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名，生成的签名为5cc68982f55ac74348e3d819f868fbe1广州掌骏网络技术有限公司statusNum 每次取得号码数 必须为数字，默认 4000，可不填action 任务名称 设置为固定的：query例如：action=query&userid=12&t
14、imestamp=20120701231212&sign =5cc68982f55ac74348e3d819f868fbe14.3 返回值15023239810-对应的手机号码1212-同一批任务 ID10-状态报告-10：发送成功，20：发送失败2011-12-02 22:12:11-接收时间DELIVRD-上级网关返回值，不同网关返回值不同，仅作为参考01-子号，即自定义扩展号150232398111212202011-12-02 22:12:112注：不能按日期来查 只能接收到当时的上行数据 查过一遍，接口就不会再返回了查询的数据都是分批返回。 每一批的上限是，一个包为限。一般 4000
15、 个号码左右。4.4 错误返回值状态报告请求错误返回格式及对应值1-错误码广州掌骏网络技术有限公司用户名或密码不能为空-错误描述1：用户名或密码不能为空2：用户名或密码错误3：该用户不允许查看状态报告4：参数不正确第五章 上行接口5.1 请求地址请求地址是客户接口程序调用的时候请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/v2callApi.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户注意：相同的上行回复，只能获取一次。5.2 参数说明参数名称 含义 说明userid 企业 id 企业 IDtimestam
16、p 时间戳 系统当前时间字符串，年月日时分秒，例如：20120701231212sign 签名 使用 账号 +密码+时间戳 生成 MD5 字符串作为签名。MD5 生成 32 位，且需要小写例如：账号是 test 密码是 mima时间戳是 20120701231212就需要用 testmima20120701231212来生成 MD5 的签名，生成的签名为5cc68982f55ac74348e3d819f868fbe1action 任务名称 设置为固定的：query例如：广州掌骏网络技术有限公司action=query&userid=12×tamp=20120701231212&sig
17、n =5cc68982f55ac74348e3d819f868fbe15.3 返回值15023239810-对应的手机号码1212-同一批任务 ID你好，我不需要- 上行内容2011-12-02 22:12:11-接收时间01-子号，即自定义扩展号150232398111212你好，本次活动路线是怎么的2011-12-02 22:12:11015.4 错误返回值回复请求错误返回格式及对应值1-错误码用户名或密码不能为空-错误描述1：用户名或密码不能为空2：用户名或密码错误3：该用户不允许查看状态报告4：参数不正确广州掌骏网络技术有限公司第六章 密码修改接口6.1 请求地址请求地址是客户接口程序
18、调用的时候请求的 url 地址，采用的是 http post 接口，地址是http:/120.77.14.55:8888/sms.aspxhttp:/120.77.14.55:8888/smsGBK.aspx入口地址一般不会发生变化，当发生变化的时候，会通知接口用户6.2 参数说明参数名称 含义 说明userid 企业 id 企业 IDaccount 用户帐号 用户帐号，由系统管理员password 帐号密码 用户账号对应的密码action 任务名称 设置为固定的：changespwdnewpwd 新密码renewpwd 确认密码 确认密码是将新密码再次输入例如：action= changespwd&userid=12&account=账号&password=密码&newpwd= 新密码&renewpwd=新密码
