概述

• 在应用开发过程中，由于业务特性需要服务器API协同使用，因此云信即时通信提供了账号管理、用户名片管理、好友管理、静音管理、黑名单管理、消息管理、会话功能、群组功能、聊天室功能、广播消息管理、系统通知管理API，企业可以使用这些API，根据实际需要开发应用。
• 在应用开发对接过程中，该平台主要可以调用各种接口请求参数和返回数据的情况，供开发人员和测试人员测试 API 使用情况。

API 调试

调用前准备

• 已在云信控制台创建应用，并已开通服务，获取App Key 和 App Secret。详情请参见创建应用和获取 App key 。
• 应用服务端调用 API 向云信 IM 服务端发起的请求需遵循固定的请求结构和请求方式。具体内容参见API调用方式。

调试方式

ApiFox支持两种方式进行接口调试，具体参见以下内容：

方式一：未登录Apifox平台进行调试（推荐）

• 未登录ApiFox平台情况下，不能执行前置脚本，导致无法自动生成部分请求头信息（Checksum等），因此需要按如下方式进行参数设置。
• 选择去设置环境变量，设置AppKey，Nonce， CurTime，CheckSum字段，CheckSum字段签算代码参见官方样例，由于安全原因CheckSum有5分钟有效期，调试过程中注意该参数有效周期，参加下图：

• 设置完成后直接点击发送，即可调试相关接口

方式二：登录Apifox平台后进行调试

• 点击Run in Apifox，既进入Apifox平台， 需要相关账号登录
• 该方式调试需要为项目团队成员，因此可以点击左侧克隆项目，克隆一份项目到自己的名下
  :::highlight red 📌
  Note：该方式不能保证两个工程内容持续一致，官方接口有所调整或变更不能及时同步，增加问题排查时间
  :::
• 该方式可以执行前置脚本，按如下图配置AppKey， AppSecret，调用API时可以自动根据AppKey， AppSecret自动签算相关请求头内容。

:::highlight red 📌
Note：
1，由于是在第三方平台进行在线接口调试，信息会保存在三方平台，因此生产环境不建议使用该方式进行调试，相关数据Appkey，AppSecret为应用私密信息，请妥善保管该信息，减少私密信息暴露。
2，应尽量选取方式一调试，或仅仅测试环境采用该方式进行调试
:::

注意事项

:::highlight red 📌
由于ApiFox平台限制，部分接口请求参数和请求模式与官网文档不一致，实际参数以官方文档为准，ApiFox只作为测试调试使用。
样例： long类型需要配置为Integer
:::