分类: 文档

国内/国际短信,API开发文档。

PHP SDK

安装 Uni PHP SDK 使用 Packagist 托管,可从公共 Packagist 仓库 中获得。 使用 Composer 在项目中添加 apistd/uni-sdk 作为依赖: 使用示例 以下示例展示如何使用 Uni PHP SDK 快速调用服务。 发送短信

Java SDK

安装 Uni Java SDK 使用 Maven 托管,可从公共 Maven 仓库 中获得。 在项目中使用以下代码添加 Maven 依赖: 或使用 Gradle: 使用示例 以下示例展示如何使用 Uni Java SDK 快速调用服务。 发送短信

状态报告 (DLR)

短信发送状态报告 (Delivery Receipt, DLR),也称为短信回执消息。是为开发者程序化获取短信发送状态所提供的服务,UniSMS 支持通过 Webhook 主动推送短信状态报告。 设置 本功能为扩展服务,默认不开启。请根据您的实际需求前往控制台「扩展管理-状态报告」进行配置。 设置接收状态报告的 Webhook URL,并指定您需要接收的请求主体数据格式,支持 JSON 或 XML,默认为 JSON。即完成基础配置,准备接入。 接入 UniSMS 将以 POST 方法向您设定的 Webhook URL 发送 HTTP 请求,请求主体以 JSON 格式为例。 Request Body 参数名 类型 描述 示例值 id string 消息标识 b3f6106a6135ad78d6ac3f232bbf1812 status string 发送状态 delivered to string 收件人手机号 (E.164) +8618600001234 regionCode string 国际代码 CN countryCode string 国际电话区号 86 messageCount integer 计费消息总条数 1 price string 消费金额 0.040000…

发送频率限制

为防止短信资源被特定用户过度调用,UniSMS 支持对短信发送频率进行限制,从而屏蔽无用请求有效控制短信发送成本。您可以选择开启并指定针对同一手机号码按分、按时、按天 (自然日) 的限速规则。 设置 本功能为扩展服务,默认不开启。请根据您的实际需求前往控制台「扩展管理-发送频率限制」进行配置。 号码白名单 如果您存在期望不受发送频率限制的手机号码,可以通过号码白名单功能进行设置。请使用 E.164 格式填入号码,多个以英文逗号分隔,最多添加 50 条记录。

IP 限制

UniSMS 支持对接口调用请求的 IP 地址进行限制,以保障您的短信接口调用由可信任的服务器发出。您可以通过设置白名单指定允许访问的 IP 地址,或通过设置黑名单来指定禁止访问的 IP 地址。 设置 本功能为扩展服务,默认不开启。请根据您的实际需求前往控制台「扩展管理-IP 限制」进行配置。 支持填入 IPv4 地址如 111.243.214.169 或 IPv4 网段如 108.160.167.147/24,多个以英文逗号分隔,最多添加 50 条记录。

错误码及描述

错误码 描述 说明 0 Ok 请求成功 101000 Internal 内部错误 101301 NoUpstreamConfigured 未设置有效的上游通道。请检查是否开启了专家模式并未完成通道配置,你可以切换至融合模式快速地解决该问题 101303 NoUpstreamAvailable 所有上游通道失败,表示该请求没有可提供服务的上游 104001 MissingParams 缺少参数 104002 InvalidParams 无效的参数 104003 RestrictedParams 受限的参数 104110 MissingAccessKeyId 缺少 AccessKeyId 104111 InvalidAccessKeyId 错误的 AccessKeyId 104201 InvalidSignature 错误的签名。请参考 API 通用说明 生成请求签名 104202 InvalidSignatureTimestamp 无效的签名时间戳。请检查传入的值是否为有效的 UNIX 时间戳,可接受与服务器时间差为 10 分钟 105001 Unauthorized 未授权 105100 IpRestricted 请求 IP 受限。请检查是否启用 IP 限制扩展服务,并确保请求服务器 IP 与配置相符…