npm 包 bulutfon 使用教程

阅读时长 5 分钟读完

在前端开发中,有很多第三方的库和工具都可以大大提高开发的效率和质量。其中,npm 是一个非常重要的包管理工具,可以帮助我们轻松地安装和管理各种库和工具。而 bulutfon 这个 npm 包则是一个用于与 Bulutfon 联系中心 API 进行交互的库,让我们可以轻松地开发出与手机号码、呼叫、短信、IVR 等相关的应用。

在使用 bulutfon 前,需要先了解一些基础知识和流程。下面是详细的使用教程:

1. 安装

首先,我们需要在项目中安装 bulutfon 包。可以使用 npm 命令进行安装:

也可以使用 yarn 命令进行安装:

安装完成后,我们就可以开始使用 bulutfon 包。

2. 初始化

在使用 bulutfon 包之前,我们需要先进行初始化设置,包括设置账户信息、应用信息等。可以使用以下命令进行初始化:

其中,accessToken 和 organization 都是必填参数。accessToken 是我们在 Bulutfon 官网创建应用时生成的 API 访问密钥,organization 是我们所属的组织名称。

3. 使用 API

初始化完成后,我们就可以使用 bulutfon 包中提供的 API 函数进行各种操作了。下面介绍几个常用的 API:

获取手机号码

-- -------------------- ---- -------
----- - -------- - - --------------------

----- ------ - --- ----------
  ------------ --------------------
  ------------- --------------------
---

------------------------------------------------ -- -
  ----------------------
---------------- -- -
  ---------------------
---

其中,PHONE_NUMBER 是需要获取的手机号码。

发送短信

-- -------------------- ---- -------
----- - -------- - - --------------------

----- ------ - --- ----------
  ------------ --------------------
  ------------- --------------------
---

----------------
  --------- ---------------
  ----- ---------------
  ----------- -------------
------------------ -- -
  ----------------------
---------------- -- -
  ---------------------
---

其中,receiver 是短信接收人的手机号码,text 是短信内容,originator 是短信发送人的名称。

发起呼叫

-- -------------------- ---- -------
----- - -------- - - --------------------

----- ------ - --- ----------
  ------------ --------------------
  ------------- --------------------
---

-------------
  --------- ---------------
  ------------ --------------
------------------ -- -
  ----------------------
---------------- -- -
  ---------------------
---

其中,receiver 是呼叫接收人的手机号码,scenario_id 是要执行的 IVR 场景的 ID。

获取呼叫状态

-- -------------------- ---- -------
----- - -------- - - --------------------

----- ------ - --- ----------
  ------------ --------------------
  ------------- --------------------
---

----------------------------------------------- -- -
  ----------------------
---------------- -- -
  ---------------------
---

其中,CALL_ID 是要获取状态的呼叫 ID。

4. 总结

通过本教程的学习,我们了解了如何在前端中使用 bulutfon 包进行与 Bulutfon 联系中心 API 的交互。在使用之前,我们需要通过初始化设置正确的账户信息和应用信息,然后可以使用提供的各种 API 函数进行操作。具体 API 的使用可以参考官方文档。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c8dccdc64669dde54d0

纠错
反馈