接口说明

• 查询类接口使用 GET 请求，创建类使用 POST 请求，修改、动作类使用 PUT 请求。
• 在本系统中，PATCH 请求与 PUT 请求等价，但在更新部分内容时，为了语义明确，推荐使用 PATCH。
• 必选参数一般以粗体标出。
• HTTP 返回状态码 200 为正常，其它为错误。
• HTTP 默认返回 JSON 格式信息。
• 可以配置使用 HTTP Basic 验证，或不验证。
• 接口分为同步模式和异步模式。缺省为同步模式。
  • 异步模式：在该模式下，发送 HTTP API 请求将生成一个后台任务(Background Job)并立即返回结果（包含 Background Job UUID）。这种模式执行速度快，但不知道是否执行成功。
  • 同步模式：在该模式下，HTTP 请求会阻塞，直到命令执行成功或失败后才返回，超时时间默认是 60 秒。
• 示例中由于排版限制，太长的命令行后面使用“\”续行符号，表示紧接着的下一行内容应该位于同一行。与典型的 UNIX 续行符兼容，可以直接 Copy & Paste。

REST API 按照标准的 REST 访问方式设计，即，URL 是一个资源，对资源可以有 POST、PUT、GET、DELETE 等四种动作，分别对应数据库里的 CURD 操作。“一些”资源一般是以复数表示的，如：

GET /api/channels

单个资源则以单数表示，如：

GET /api/channels/$uuid

关于这一部分，可以参考 API 文档部分。

外呼使用 JSON-RPC 实现，参见：

• http://www.jsonrpc.org/specification
• http://wiki.geekdream.com/Specification/json-rpc_2.0.html

关于 cURL 和 JSON-RPC 的更多说明见附件。