Cloopen REST API是什么？如何使用它？

1、

简介：Cloopen REST API是一种基于HTTP协议的API，用于实现多种云通讯功能。

接口类型：主要包括子账户管理、短信发送、双向回拨、语音验证码、话单下载以及创建电话会议等操作。

2、请求地址和格式

Base URL：https://app.cloopen.com:8883/2013-12-26（生产环境）或https://sandboxapp.cloopen.com:8883/2013-12-26（测试环境）。

URL格式：主帐号请求格式为 /Accounts/{accountSid}/{func}/{funcdes}?sig={SigParameter}；子帐号请求格式为 /SubAccounts/{subAccountSid}/{func}/{funcdes}?sig={SigParameter}。

3、统一请求包头

Content-Type：指定请求体的格式，如application/xml或application/json。

Accept：指定希望返回的数据格式，如application/xml或application/json。

Content-Length：请求体的长度。

SigParameter：验证参数，通过MD5加密生成（账户Id + 账户授权令牌 + 时间戳）。

Authorization：使用Base64编码生成的验证信息（账户Id + 冒号 + 时间戳）。

4、数据报文格式

支持格式：XML和JSON两种主流格式。

请求示例：

     <request>
       <!-请求内容 -->
     </request>

响应示例：

     {
       "status": "success",
       "message": "请求成功"
     }

5、主要功能

子账户管理：创建、查询和管理子账户。

短信服务：发送模板短信和通知短信。

语音服务：双向回拨、语音验证码。

IVR外呼：配置和发起IVR外呼。

会议管理：创建和管理电话会议。

座席管理：管理和监控座席状态。

6、错误代码

常见错误代码：包括无效账户、无效请求、服务器错误等。

错误示例：

     {
       "status": "error",
       "message": "账户无效"
     }

7、常见问题与解答

Q1：如何生成SigParameter？

A1：SigParameter是通过MD5加密生成的，公式为账户Id + 账户授权令牌 + 当前系统时间戳，md5("账户Id" + "授权令牌" + "20240102120000")。

Q2：如何刷新配置中的值？

A2：在发送短信前，调用SmsFactory.refresh(SupplierType.CLOOPEN)方法进行配置刷新。

Cloopen REST API提供了丰富的云通讯功能，通过简单的HTTP请求即可实现复杂的通讯需求，开发者可以根据具体需求选择合适的接口和参数，快速集成到自己的应用中。

小伙伴们，上文介绍了“cloopen rest api”的内容，你了解清楚吗？希望对你有所帮助，任何问题可以给我留言，让我们下期再见吧。