---
title: "REST API"
description: "REST API 是一种 Web 接口，它把消息、联系人、模板等资源暴露在 URL 上，让程序通过标准 HTTP 方法（POST、GET、PATCH、DELETE）创建、读取、更新和删除这些资源，通常以 JSON 交换数据。"
canonical: "https://omnichannels.ai/zh/glossary/rest-api/"
language: "zh"
updated: "2026-10-10"
publisher: "BroadNet Technologies"
brand: "OmniChannels.ai"
---

# REST API

Canonical: https://omnichannels.ai/zh/glossary/rest-api/
Language: zh
Publisher: OmniChannels.ai by BroadNet Technologies

**定义:** REST API 是一种 Web 接口，它把消息、联系人、模板等资源暴露在 URL 上，让程序通过标准 HTTP 方法（POST、GET、PATCH、DELETE）创建、读取、更新和删除这些资源，通常以 JSON 交换数据。

REST（representational state transfer）是 Roy Fielding 在 2000 年提出的一种架构风格。在实践中，消息类 REST API 意味着发送一个经过认证的 HTTPS 请求（例如带 JSON 请求体的 POST /messages），并收到包含 ID 和状态的 JSON 响应。HTTP 状态码表示结果：2xx 表示成功，4xx 表示客户端错误（如号码无效或缺少授权），5xx 表示服务器错误。

常见模式：在 Authorization 头中使用 bearer token 认证，用幂等键避免重试时重复发送，列表分页，带 retry-after 头的速率限制，以及用于送达报告等异步结果的 webhook。

REST 适合大多数集成场景：CRM、电商平台和后台系统。对于超大规模短信，运营商和聚合商通常改用保持长连接的 SMPP。

OpenAPI 规范以机器可读的方式描述接口端点，客户端 SDK、文档和测试都可据此生成。

OmniChannels.ai 在 https://api.broadnet.me 提供 REST/JSON API，采用 bearer token 认证，附带 OpenAPI 3.1 规范和 TypeScript SDK。

## 示例

```
向 https://api.broadnet.me/… 发送 POST 请求，带 "Authorization: Bearer <token>" 请求头和 JSON 请求体；响应返回一个消息 ID。
```

## 资料来源

- [Fielding, Architectural Styles and the Design of Network-based Software Architectures, ch. 5 (REST)](https://ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm)
- [RFC 9110: HTTP Semantics (IETF)](https://datatracker.ietf.org/doc/html/rfc9110)