掌骏传媒-短信接口说明

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