网站接入文档#

功能简介#

待客的网站功能可以让开发者在自己的网站上快速拥有“意见反馈”或“联系我们”的功能。

大致的使用流程是:

  1. 开发者在网站上放一个表单,包含名字、Email和正文
  2. 用户填写表单并提交
  3. 开发者登入待客后台即可看到用户提交的问题,我们称之为工单
  4. 开发者在此回复工单,待客会把回复的内容作为Email发回给用户

快速上手指南#

要使用此功能,开发者只需要:

  1. 在自己的网站上制作一个表单,比如“意见反馈”。在制作此表单时,请参考下面的参数设置
  2. 待客的协助下设置好邮箱地址(给用户发送邮件时使用)

表单的参数设置#

提交表单的请求中,至少要携带以下的参数,分别是:

参数 说明 必须与否
email 用户的邮箱,客服在后台回复的信息将会转化成邮件,寄送到这个邮箱 必须
description 问题描述 必须
token 于待客后台的"设置"->"Apps"->"App Id"中获取,用以验证身份 必须
back_to 用户提交表单以后返回的链接,如不设置我们将使用原先提交表单的网址作为返回链接 可选
user_id 标识用户,可选
tags 工单标签,是一个字符串数组,可选
content_type 表示传入的问题描述的文本类型,值为text/plain或者text/html,默认值为text/html,可选
<form action="https://getdaike.com/webforms" method="post">
  <div class='form-group'>
    <label for="email">Email</label>
    <input type="text" name="email" id="email" class="form-control" />
  </div>
  <div class='form-group'>
    <label for="description">Description</label>
    <input type="text" name="description" id="description" class="form-control" />
  </div>
  <input type="hidden" name="token" id="token" value="YOUR_TOKEN_HERE" />
  <input type="hidden" name="back_to" id="back_to" value="https://getdaike.com" />
  <input type="submit" name="commit" value="submit" class="btn btn-default" data-disable-with="submit" />
</form>

自定义数据#

如果你想在工单中附带一些信息,比如用户资料和订单信息等等,你可以在表单中增加需要的字段。比如这样:

<!-- 自定义的字段 -->
<div class='form-group'>
  <input type="hidden" name="desc" id="desc" value="i am a game" class="form-control" />
</div>
<div class='form-group'>
  <label for="level">Custom Prop</label>
  <input type="text" name="level" id="level" class="form-control" value="4" />
</div>

在后台查看此工单时,可以看到这些数据。如下图:

后台中的工单自定义数据

对于自定义数据字段的值,请确保是个扁平格式的,比如单纯的字符串或者数字,对于嵌套形式的值目前不支持,比如是个数组或者哈希。 如下代码,传的自定义数据形如{"person": {"name": "NAME_YOU_INPUT", "hobby": "HOBBY_YOU_INPUT"}},是非法的:

<div class="form-group">
  <label for="person_name">Name</label>
  <input class="form-control" type="text" name="person[name]" id="person_name">
</div>
<div class="form-group">
  <label for="person_hobby">Hobby</label>
  <input class="form-control" type="text" name="person[hobby]" id="person_hobby">
</div>

错误验证#

除了验证你后台有配置转发邮箱和必要的emaildescriptiontoken字段外,对于其他自定义的字段,待客将不做验证。 建议开发者在网页上做好参数验证和用户提示。