获取在线咨询渠道嵌入代码

获取在线咨询渠道的嵌入代码，可用于嵌入到目标网站以实现在线咨询功能。

请求 URL

GET {base_url}/{api_path}/message_channel/embedcode?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 在线咨询渠道的唯一 ID。
注： 可使用 查询特定消息渠道 接口查询渠道 ID。
email 否 String 要发送嵌入代码的邮箱地址。

系统会向指定邮箱地址发送包含了嵌入代码和代码安装说明的邮件。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
website_domain String 要嵌入在线咨询渠道的网站的域名。
embed_code String 在线咨询渠道的嵌入代码。

示例

请求示例

GET /openapi/v1.0/message_channel/embedcode?access_token=kq3ftCp8VfTjrk1gqW5NW0sijhWE4yiL&id=6&email=demo@yeastar.com HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "website_domain": "www.yeastar.com",
    "embed_code": "<script src=\"https://docs.example.yeastar.com/live_chat.v1.0.0.js?channelNumber=LC00000\"></script>"
}