通用短信平台HTTP接口使用说明V1.0.4

通 用 短 信 平 台 HTTP 接 口 使 用 版 本 历 史 版 本 号 作 者 修 改 日 期 修 改 内 容 1.0.1 Darren 2013 年 4 月 15 日 1. 修 改 本 文 档 排 版 样 式 ; 2. 增 加 获 取 状 态 报 告 方 法 1. 修 改 原 来 第 6 条 插 件 功 能 为 短 信 回 复 推 送 ; 2. 特 别 : 原 插 件 功 能 中 获 取 回 复 后 再 次 1.0.2 Darren 2013 年 7 月 26 日 回 复 短 信 平 台 会 自 动 状 回 复 信 息 下 发 到 回 复 手 机 的 功 能 已 取 消 3. 增 加 第 7 条 状 态 报 告 推 送 功 能 1. 发 送 短 信 增 加 流 水 号 (linkid) 参 数, 用 于 一 对 一 匹 对 短 信 回 复 和 状 态 报 告 ; 2. 增 加 urlencode 转 码 方 式 提 交 接 口 短 信 回 复 接 口 和 账 户 余 额 查 询, 用 于 短 信 内 容 中 有 换 行 空 格 等 特 殊 字 符 时 发 送 时 使 用 ; 1.0.3 Darren 2014 年 10 月 13 日 3. 增 加 没 有 可 获 取 的 短 信 回 复 ( :150) 和 没 有 可 获 取 的 状 态 报 告 ( :160) 时 ; 4. 增 加 敏 感 字 查 询 接 口 5. 增 加 手 机 号 码 排 重 功 能, 单 次 提 交 中 若 有 重 复 手 机 号 码, 接 口 将 自 动 过 滤 删 除 重 复 手 机 号 码 1.0.4 Darren 2014 年 12 月 11 日 1. 增 加 点 点 通 ( 个 性 化 ) 短 信 提 交 接 口 ; 2. 增 加 接 口 用 途 描 述

目 录 上 海 悠 逸 信 息 技 术 有 限 公 司 通 用 短 信 平 台 HTTP 接 口 使 用... 1 版 本 历 史... 1 1. 前 言... 3 2. GET 方 式 提 交 短 信... 3 3. POST 方 式 提 交 短 信... 4 4. 点 点 通 ( 个 性 化 ) 短 信 发 送... 5 5. 查 询 余 额... 7 6. 敏 感 字 查 询... 8 7. 主 动 获 取 回 复... 9 8. 主 动 获 取 状 态 报 告... 10 9. 短 信 回 复 推 送... 11 10. 状 态 报 告 推 送... 11 11. 技 术 支 持... 12

1. 前 言 上 海 悠 逸 信 息 技 术 有 限 公 司 本 接 口 使 用 规 定 了 通 用 短 信 平 台 客 户 接 入 的 参 数 类 型 和 定 义, 目 前 为 1.0.4 版 本, 是 在 原 来 1.0.0 版 本 的 基 础 上 进 行 修 订 而 成 根 据 业 务 的 发 展, 接 口 规 范 中 的 功 能 和 参 数 将 会 做 进 一 步 的 调 整 和 增 加 本 接 口 规 范 采 用 GB2312 编 码 方 式 ( 即 接 口 只 接 收 GB2312 编 码 的 信 息, 接 口 接 口 获 取 的 短 信 回 复 状 态 报 告 均 为 GB2312 编 码 ) 2. GET 方 式 提 交 短 信 类 型 :GET 范 围 : 全 部 用 户 : http://www.smsadmin.cn/smsmarketing/wwwroot/api/get_send/ 普 通 方 式 提 交 http://www.smsadmin.cn/smsmarketing/wwwroot/api/get_send_md5/ 参 数 pwd 的 值 采 用 md5 方 式 32 位 的 加 密 http://www.smsadmin.cn/smsmarketing/wwwroot/api/get_send_urldecode/ 参 数 msg 的 值 进 行 url 编 码 uid= 用 户 ID pwd= 密 码 mobile= 手 机 号 msg= 短 信 内 容 dtime= 时 间 ( 时 间 为 空 为 立 即 发 送, 格 式 :0000-00-00 00:00:00) linkid= 流 水 号 ( 数 字 字 母 数 字 字 母 组 合, 最 大 长 度 为 32 位, 不 得 重 复 ) : 备 注 0 发 送 成 功!; 短 信 提 交 成 功

2 余 额 不 足!; 账 户 余 额 不 足, 请 联 系 业 务 员 充 值 1 用 户 名 或 密 码 错 误!; 用 户 名 或 用 户 密 码 错 误 3 超 过 发 送 最 大 量 100 条 ; 超 过 接 口 处 理 上 限 4 此 用 户 不 允 许 发 送!; 此 用 户 ID 不 可 用 5 手 机 号 或 发 送 信 息 不 能 为 空! 手 机 号 或 短 信 内 容 为 空 7 超 过 XX 个 字, 请 修 改 后 发 送! 短 信 长 度 超 长 8 用 户 已 冻 结, 请 联 系 客 服 人 员! 用 户 ID 被 冻 结 : pwd 是 密 码 参 数, 加 密 方 法 采 用 的 是 md5 方 式 32 位 的 字 符 串, 如 果 采 用 md5 加 密, 需 采 用 第 二 个 手 机 号 mobile 参 数 二 个 号 码 之 间 用 ; 英 文 分 号 区 分, 未 尾 不 需 要 加 ; 英 文 分 号, 支 持 最 多 手 机 号 100 个 7 超 过 XX 个 字, 请 修 改 后 发 送!, 其 中 XX 是 代 表 此 通 道 目 前 支 持 的 最 大 字 数, 一 个 英 文 字 符 和 汉 字 占 相 同 字 数 参 数 GET 变 量, 是 采 用 提 交 模 式 为 GET 方 式, 变 量 是 跟 随 在 栏 上 的 例 如 :?uid=id&pwd= 密 码 &mobile= 手 机 号 &msg= 短 信 内 容 &dtime= 时 间 & linked= 流 水 号 3. POST 方 式 提 交 短 信 类 型 :POST 范 围 : 全 部 用 户 : http://www.smsadmin.cn/smsmarketing/wwwroot/api/post_send/ 普 通 方 式 提 交 http://www.smsadmin.cn/smsmarketing/wwwroot/api/post_send_md5/ 参 数 pwd 的 值 采 用 md5 方 式 32 位 的 加 密 http://www.smsadmin.cn/smsmarketing/wwwroot/api/post_send_urldecode/ 参 数 uid 和 msg 的 值 进 行 url 编 码

uid= 用 户 ID pwd= 密 码 mobile= 手 机 号 msg= 短 信 内 容 dtime= 时 间 ( 时 间 为 空 为 立 即 发 送, 格 式 :0000-00-00 00:00:00) linkid= 流 水 号 ( 数 字 字 母 数 字 字 母 组 合, 最 大 长 度 为 32 位, 不 得 重 复 ) : 备 注 0 发 送 成 功!; 短 信 提 交 成 功 2 余 额 不 足!; 账 户 余 额 不 足, 请 联 系 业 务 员 充 值 1 用 户 名 或 密 码 错 误!; 用 户 名 或 用 户 密 码 错 误 3 超 过 发 送 最 大 量 1000 条 ; 超 过 接 口 处 理 上 限 4 此 用 户 不 允 许 发 送!; 此 用 户 ID 不 可 用 5 手 机 号 或 发 送 信 息 不 能 为 空! 手 机 号 或 短 信 内 容 为 空 7 超 过 XX 个 字, 请 修 改 后 发 送! 短 信 长 度 超 长 8 用 户 已 冻 结, 请 联 系 客 服 人 员! 用 户 ID 被 冻 结 : pwd 是 密 码 参 数, 加 密 方 法 采 用 的 是 md5 方 式 32 位 的 字 符 串, 如 果 采 用 md5 加 密, 需 采 用 第 二 个 手 机 号 mobile 参 数 二 个 号 码 之 间 用 ; 英 文 分 号 区 分, 未 尾 不 需 要 加 ; 英 文 分 号, 支 持 最 多 手 机 号 1000 个 7 超 过 XX 个 字, 请 修 改 后 发 送!, 其 中 XX 是 代 表 此 通 道 目 前 支 持 的 最 大 字 数, 一 个 英 文 字 符 和 汉 字 占 相 同 字 数 参 数 POST 变 量, 是 采 用 提 交 模 式 为 POST 方 式, 变 量 是 隐 藏 的 类 型 4. 点 点 通 ( 个 性 化 ) 短 信 发 送 类 型 :POST 范 围 : 全 部 用 户

: http://www.smsadmin.cn/smsmarketing/wwwroot/api/post_send_ddt/ 参 数 pwd 的 值 采 用 md5 方 式 32 位 的 加 密 ; 参 数 params 和 msg 的 值 进 行 url 编 码 序 号 参 数 1 uid 用 户 ID 2 pwd 用 户 ID 密 码 3 msg 短 信 模 板 其 中 的 变 量 用 {value( 变 量 序 号 )} 来 替 代 例 如 : {value0}, 您 本 次 的 注 册 验 证 码 {value1}, 在 {value2} 分 钟 内 输 入 有 效 签 名 内 容, 该 短 信 中 具 有 三 个 变 量 参 数 变 量 标 识 符 号 不 能 重 复 4 params 点 点 通 ( 个 性 化 ) 短 信 的 参 数 组 单 次 提 交 参 数 组 的 数 目 不 能 超 过 1000 个 每 一 组 参 数 之 间 用 英 文 ; 间 隔 每 一 组 参 数 内 部 用 英 文, 间 隔, 其 中 第 一 个 参 数 为 手 机 号 码, 第 二 个 参 数 为 模 板 中 第 一 个 变 量, 第 三 个 参 数 为 模 板 中 第 二 个 变 量, 以 此 类 推 例 如 : "13712345678,123456,10;13745678910,4567,20;13714782356,7891 2,30" 表 明 提 交 了 三 个 变 量 组, 其 中 手 机 号 码 分 别 为 :13712345678 13745678910 和 13714782356 模 板 变 量 分 别 为 : 您 本 次 的 注 册 验 证 码 123456, 在 10 分 钟 内 输 入 有 效 签 名 内 容 ; 您 本 次 的 注 册 验 证 码 4567, 在 20 分 钟 内 输 入 有 效 签 名 内 容 ; 您 本 次 的 注 册 验 证 码 78912, 在 30 分 钟 内 输 入 有 效 签 名 内 容 格 式 不 符 的 参 数, 系 统 自 动 过 滤 掉 5 dtime 定 时 发 送 时 间 ( 时 间 为 空 为 立 即 发 送, 格 式 :0000-00-00 00:00:00) 6 linkid 流 水 号 ( 数 字 字 母 数 字 字 母 组 合, 最 大 长 度 为 32 位, 不 得 重 复 )

: 备 注 0 发 送 成 功!; 短 信 提 交 成 功 2 余 额 不 足!; 账 户 余 额 不 足, 请 联 系 业 务 员 充 值 1 用 户 名 或 密 码 错 误!; 用 户 名 或 用 户 密 码 错 误 3 超 过 发 送 最 大 量 1000 条 ; 超 过 接 口 处 理 上 限 4 此 用 户 不 允 许 发 送!; 此 用 户 ID 不 可 用 5 手 机 号 或 发 送 信 息 不 能 为 空! 手 机 号 或 短 信 内 容 为 空 7 超 过 XX 个 字, 请 修 改 后 发 送! 短 信 长 度 超 长 8 用 户 已 冻 结, 请 联 系 客 服 人 员! 用 户 ID 被 冻 结 : pwd 是 密 码 参 数, 加 密 方 法 采 用 的 是 md5 方 式 32 位 的 字 符 串, 如 果 采 用 md5 加 密 params 是 参 数 组, 二 个 参 数 组 之 间 用 英 文 分 号 ; 区 分, 未 尾 不 需 要 加 ; 英 文 分 号, 支 持 最 多 1000 个 参 数 记 录 7 超 过 XX 个 字, 请 修 改 后 发 送!, 其 中 XX 是 代 表 此 通 道 目 前 支 持 的 最 大 字 数, 一 个 英 文 字 符 和 汉 字 占 相 同 字 数 参 数 POST 变 量, 是 采 用 提 交 模 式 为 POST 方 式, 变 量 是 隐 藏 的 类 型 5. 查 询 余 额 类 型 :GET 范 围 : 全 部 用 户 : http://www.smsadmin.cn/smsmarketing/wwwroot/api/user_info/ 普 通 方 式 查 询 http://www.smsadmin.cn/smsmarketing/wwwroot/api/user_info_urldecode/ 参 数 uid 的 值 进 行 url 编 码

: uid= 用 户 ID pwd= 密 码 备 注 用 户 ID=uid 账 户 余 额 查 询 成 功 剩 余 资 费 =XXX 1 用 户 名 或 密 码 错 误!; 用 户 名 或 密 码 错 误 : 其 中 用 户 ID 和 密 码 是 您 在 通 用 短 信 平 台 中 的 帐 号 信 息 6. 敏 感 字 查 询 类 型 :GET 范 围 : 全 部 用 户 : http://www.smsadmin.cn/smsmarketing/wwwroot/api/mgz/ uid= 用 户 ID pwd= 密 码 msg= 短 信 内 容 返 值 : 敏 感 字 : 敏 感 字 1; 敏 感 字 2; 敏 感 字 3; 不 含 敏 感 字 备 注 短 信 内 容 中 含 用 敏 感 字 短 信 内 容 中 没 有 敏 感 字 1 用 户 名 或 密 码 错 误!; 用 户 名 或 密 码 错 误 : 其 中 用 户 ID 和 密 码 是 您 在 通 用 短 信 平 台 中 的 帐 号 信 息

7. 主 动 获 取 回 复 上 海 悠 逸 信 息 技 术 有 限 公 司 类 型 :GET 范 围 : 全 部 用 户 ( 需 通 道 支 持 ) : http://www.smsadmin.cn/smsmarketing/wwwroot/api/reve/ 普 通 方 式 返 回 短 信 回 复 信 息 http://www.smsadmin.cn/smsmarketing/wwwroot/api/reve_urlencode/ 对 返 回 的 回 复 内 容 进 行 url 解 编 uid= 用 户 ID pwd= 密 码 返 值 : 备 注 手 机 号 1/ 日 期 1/ 流 水 号 1/ 回 复 内 容 1/ 子 码 1 \n 获 取 回 复 成 功 手 机 号 2/ 日 期 2/ 流 水 号 2/ 回 复 内 容 2/ 子 码 2 \n 手 机 号 3/ 日 期 3/ 流 水 号 3/ 回 复 内 容 3/ 子 码 3 \n. 手 机 号 20/ 日 期 20/ 流 水 号 20/ 回 复 内 容 20/ 子 码 20 \n 1 用 户 名 或 密 码 错 误!; 用 户 名 或 密 码 错 误 150 当 前 账 户 无 可 获 取 的 用 户 上 行 信 息 : 其 中 用 户 ID 和 密 码 是 您 在 通 用 短 信 平 台 中 的 帐 号 信 息 主 动 获 取 的 短 信 回 复 信 息, 取 过 一 次 后, 就 不 能 再 取 了, 流 水 号 是 您 在 提 交 短 信 时 linkid 参 数 提 交 的 值, 若 提 交 短 信 时 linkid 参 数 值 为 空 时, 系 统 自 动 生 成 流 水 号, 有 可 能 有 值, 有 可 能 为 空

回 复 信 息 最 多 返 回 20 条, 如 果 超 过 20 条, 需 多 次 轮 询 回 复 调 用, 轮 询 间 隔 为 5 秒 8. 主 动 获 取 状 态 报 告 类 型 :GET 范 围 : 全 部 用 户 ( 需 通 道 支 持 ) : http://www.smsadmin.cn/smsmarketing/wwwroot/api/report/ uid=id pwd= 密 码 返 值 : 手 机 号 1/ 日 期 1/ 流 水 号 1/ 状 态 值 1/ 子 码 1 \n 获 取 状 态 报 告 成 功 备 注 手 机 号 2/ 日 期 2/ 流 水 号 2/ 状 态 值 2/ 子 码 2 \n 手 机 号 3/ 日 期 3/ 流 水 号 3/ 状 态 值 3/ 子 码 3 \n. 手 机 号 20/ 日 期 20/ 流 水 号 20/ 状 态 值 20/ 子 码 20 \n 1 用 户 名 或 密 码 错 误!; 用 户 名 或 密 码 错 误 160 当 前 账 户 无 可 获 取 的 状 态 报 告 : 其 中 用 户 ID 和 密 码 是 您 在 通 用 短 信 平 台 中 的 帐 号 信 息 主 动 获 取 的 状 态 报 告, 取 过 一 次 后, 就 不 能 再 取 了, 流 水 号 流 水 号 是 您 在 提 交 短 信 时 linkid 参 数 提 交 的 值, 若 提 交 短 信 时 linkid 参 数 值 为 空 时, 系 统 自 动 生 成 流 水 号, 有 可 能 有 值, 有 可 能 为 空 状 态 报 告 信 息 最 多 返 回 20 条, 如 果 超 过 20 条, 需 多 次 轮 询 接 口 调 用, 轮 询 间 隔 5 秒

9. 短 信 回 复 推 送 上 海 悠 逸 信 息 技 术 有 限 公 司 类 型 :POST 范 围 : 全 部 用 户 ( 需 通 道 支 持, 联 系 客 服 人 员 进 行 设 置 ) 方 式 : 被 动 获 取 短 信 回 复 : 需 提 供 服 务 器 接 收 URL 端 口 只 支 持 80 端 口 被 动 获 取 短 信 回 复 信 息 Class=mo SmsName=ID Mobile= 手 机 号 Message= 回 复 信 息 例 子 : http://pushurl?class=mo&smsname=id&mobile=13802102102&message=test 其 中,pushUrl 为 用 户 启 动 的 服 务 : 传 递 原 理 当 系 统 接 收 到 运 营 商 返 回 的 信 息 后, 会 立 即 传 送 到 用 户 提 供 的 URL 上 面, 由 用 户 端 进 行 逻 辑 处 理 由 于 用 户 服 务 器 链 接 不 成 功, 我 方 不 再 传 递 这 时 间 段 的 返 回 信 息 10. 状 态 报 告 推 送 类 型 :POST 范 围 : 全 部 用 户 ( 需 通 道 支 持, 联 系 客 服 人 员 进 行 设 置 ) 方 式 : 被 动 获 取 短 信 状 态 报 告 : 需 提 供 服 务 器 接 收 URL 端 口 只 支 持 80 端 口

被 动 获 取 状 态 报 告 信 息 Class=rpt SmsName=ID Mobile= 手 机 号 Report= 状 态 值 例 子 : http://pushurl?class=rpt&smsname=id&mobile=13802102102&report= DELIVRD 其 中,pushUrl 为 用 户 启 动 的 服 务 : 传 递 原 理 当 系 统 接 收 到 运 营 商 返 回 的 信 息 后, 会 立 即 传 送 到 用 户 提 供 的 URL 上 面, 由 用 户 端 进 行 逻 辑 处 理 由 于 用 户 服 务 器 链 接 不 成 功, 我 方 不 再 传 递 这 时 间 段 的 返 回 信 息 状 态 报 告 有 延 时 的 可 能, 一 般 正 常 情 况 下 在 5-10 分 种, 也 可 能 要 2-5 小 时 11. 技 术 支 持 技 术 支 持 QQ:2355716091 技 术 支 持 电 话 :021-51029000-803 技 术 支 持 邮 箱 :support.youe@youe.com 接 口 实 例 下 载 :http://www.sms.com.cn/sms/api.php