API 文档

概述

云客服 API 基于 REST 架构，支持 JSON 格式的请求和响应。所有 API 请求需要通过 HTTPS 发送，并使用 API Key 进行身份验证。

基础信息

• API 地址 - https://yun800.com/api/v1
• 认证方式 - API Key (在个人设置中获取)
• 请求格式 - application/json
• 响应格式 - JSON

认证

在请求 Header 中添加您的 API Key：

Authorization: Bearer YOUR_API_KEY

主要接口

• 会话接口 - 创建、获取、更新、关闭会话
• 消息接口 - 发送消息、获取消息历史
• 联系人接口 - 创建、更新、查询联系人
• 工单接口 - 创建、分配、处理工单
• 统计接口 - 获取各种统计数据

示例请求

获取会话列表：

GET /api/v1/conversations
Authorization: Bearer YOUR_API_KEY

发送消息：

POST /api/v1/messages
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "conversation_id": "123",
  "content": "您好，请问有什么可以帮助您？"
}

错误码

• 400 - 请求参数错误
• 401 - API Key 无效或已过期
• 403 - 无权限访问该资源
• 404 - 资源不存在
• 429 - 请求过于频繁，请稍后再试
• 500 - 服务器内部错误