使用UC APIs

UC APIs允许开发者访问和操作UC下的资源，包括但不限于：查询用户详情、编辑用户和添加会议等操作。本章将叙述如何正确的调用UC API。

开发前须知

序号	注意事项	参考文档
1	在调用UC APIs 前，确保已获取 API 访问凭证，并加入到请求 Header 中。	API访问凭证
2	在调用服务端 API 前，确保你已了解调用频率限制。	调用速率限制
3	查询服务端错误码表，了解排查建议。	错误定义
4	可以使用 Postman 进行接口调试和示例代码查看。	快速开始

UC APIs协议说明

• Protocols： HTTPS
• Host： api.yealink.com
• prefix： open/api
• Version： v2
• Accepts： application/json
• Responds With： application/json

Host 将根据UC服务部署而定，这里的值为示例

请求地址

所有的 API 请求都必须通过 HTTPS 发出。请求的基础 URL 格式为：{{Protocols}}://{{Host}}/{{prefix}}/{{Version}} + 具体API请求地址。

例如：查询用户详情API的请求地址为https：//api.yealink.com/open/api/v2/users/{userId}

请求参数

每次请求 API 时，均需提供 3 个请求头参数，具体如下：

参数	参数类型	数据类型	是否必需	描述
Authorization	Header	String	是	访问凭证。格式为：Bearer [ACCESS TOKEN]
timestamp	Header	String	是	时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
nonce	Header	String	是	随机数，最大长度32位

请求头部示例：

Authorization: Bearer [ACCESS TOKEN]
timestamp: 1568693976264
nonce: 097e0ac619ba41f68f16f1955787feb9

API调用流程说明

应用申请访问凭证和发起请求的流程如下：

1. 第三方应用服务器向UC API服务器发起申请访问 token 请求并且携带Client ID和Client Secret
2. UC API服务器验证Client ID和Client Secret信息是否正确
3. 验证成功后返回访问 token
4. 第三方应用服务器发起业务请求，并且携带访问 token
5. UC API服务器验证是否存在访问令牌，然后验证访问令牌的有效性。
6. 转发请求给UC业务服务器
7. UC业务服务器将处理后的结果返回给UC API服务器
8. UC API服务器将响应结果透传给第三方应用服务器

如果access token 失效，需要重新向UC服务器获取。