简介

这是Zendesk聊天API的参考文档，也称为实时聊天API。亚博

亚博Zendesk聊天是一个实时聊天解决方案，帮助企业增加销售转换通过吸引重要的线索在他们的网站。我们的目标是帮助这些企业使用Zendesk Chat API(以下简称“API”)来自动化和增强他们对Zende亚博sk Chat的客户支持。

如果你使用Postman，你可以将Chat Public API端点作为一个集合导入到Postman应用程序中，然后尝试不同的请求来了解API是如何工作的。点击以下按钮开始:

如果你不使用邮差，你可以在网站上注册一个免费账户邮递员的网站下载应用程序。

端点使用请求的HTTP方法和部分资源标识符进行记录。例子:

             
              得到/api/v2/聊天

预谋https://www.zopim.com到资源标识符以获取完整的端点URL。例子:

             
              https：//www．zopim．com/api/v2/聊天

有关文档中使用的语法和样式约定的更多信息，请参见文档约定在通用API介绍中。

这个API是一个只支持ssl的API，无论您如何配置您的帐户。您必须是Zendesk Ch亚博at用户才能进行API请求。

如果您在Zendesk支持中创建了Zen亚博desk聊天帐户，则必须使用OAuth访问令牌进行身份验证。看到OAuth访问令牌．

如果你有一个不是在Zendesk支持中创建的独立聊天帐户，你可以使用用户名和密码凭据的基本身份验证，或者OAuth访问令牌。亚博

如果您不确定您拥有的聊天帐户类型，请参见确定Zendesk聊天帐户版本亚博．

只有当您的聊天帐户不是在Zendesk支持中创建时，您才能使用基本身份验证。亚博

请使用以下的身份验证格式，连同你的电邮地址及密码:

{email_address}:{密码}

例子:

             
              旋度https://www.zopim.com/api/v2/agents/me＼- u(电子邮件保护): password123

Zend亚博esk Chat API支持OAuth授权流。看到OAuth身份验证．在请求中，在授权头中指定访问令牌，如下所示:

授权:持有者{access_token}

例子:

             
              旋度https://www.zopim.com/api/v2/agents/me＼- h“授权:持有人gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo”

有关使用api所需的身份验证的详细信息，请参见安全性和身份验证．

聊天API中的每个端点的速率限制为每分钟200个请求。响应包括头，指示帐户的当前速率限制和当前分钟内剩余的请求数:

             
              X-RateLimit：200X-RateLimit-剩下的：199

如果超过速率限制，Zendesk Chat将响应HTTP 42亚博9太多请求响应代码和详细说明速率限制启动原因的正文。

聊天API的请求路径不指定帐户子域，如支持、帮助中心或对话API。路径使用https://www.zopim.com使用资源标识符。例子:

             
              旋度https://www.zopim.com/api/v2/chats＼- h“授权:持有人gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo”

有关请求的一般信息，请参见请求在通用API介绍中。

有关API返回的HTTP状态码的信息，请参见响应格式在通用API介绍中。