七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线系统服务时间

查询服务时间模板

查询企业可用的服务时间模板列表。接口使用七鱼开放接口签名鉴权,并受开放接口频控限制。

请求参数

名称类型必填描述示例值
appKeystring是企业 AppKey。
timeint64是当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
checksumstring是请求签名,签名规则参考通用说明的数据校验。
checksumAlgorithminteger否签名算法版本,默认 0。

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功。200
messagestring响应信息。成功时该字段通常为空或不返回。success
dataobject[]服务时间模板列表。
└idint64服务时间模板 ID。20001
└namestring服务时间模板名称。默认服务时间
└normalServiceTimeobject[]常规服务时间。
└weekDaysstring[]星期列表。["MONDAY"]
└timeobject[]时间段列表。
└beginHourint32开始小时,0-23。9
└beginMinuteint32开始分钟,0-59。0
└endHourint32结束小时,0-23。18
└endMinuteint32结束分钟,0-59。0
└specialServiceTimeobject[]非常规服务时间。
└dayobject日期范围
└beginDayint64开始日期,毫秒时间戳。1716446400000
└endDayint64结束日期,毫秒时间戳。1716532800000
└timeobject[]时间段列表。
└beginHourint32开始小时,0-23。9
└beginMinuteint32开始分钟,0-59。0
└endHourint32结束小时,0-23。18
└endMinuteint32结束分钟,0-59。0
└remarkstring备注。春节假期
└typeint32类型:1=服务时间段,2=全天不服务。1

错误码

状态码描述
400请求参数格式错误、缺少必要字段或请求体不是合法 JSON。
401鉴权失败、签名错误、AppKey 不存在或 time 超出允许范围。
500服务端处理异常。
8002业务错误码,HTTP 状态码仍为 200:参数错误,常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。
8003业务错误码,HTTP 状态码仍为 200:业务状态错误,例如质检任务状态错误或任务类型不匹配。
8501业务错误码,HTTP 状态码仍为 200:企业不存在。
14001业务错误码,HTTP 状态码仍为 200:AppKey 不存在或无效。
14002业务错误码,HTTP 状态码仍为 200:checksum 签名校验失败。
14003业务错误码,HTTP 状态码仍为 200:time 与服务器时间相差超过允许范围,或时间参数为空。
14004业务错误码,HTTP 状态码仍为 200:请求内容错误,例如请求体格式错误、缺少必填字段或字段值不合法。
14005业务错误码,HTTP 状态码仍为 200:无客服在线。
14006业务错误码,HTTP 状态码仍为 200:访客正在排队。
14008业务错误码,HTTP 状态码仍为 200:IP 白名单限制或 IP 被拦截。
14009业务错误码,HTTP 状态码仍为 200:请求过于频繁。
14010业务错误码,HTTP 状态码仍为 200:留言功能关闭。
14011业务错误码,HTTP 状态码仍为 200:接口未开放或被停用。
14014业务错误码,HTTP 状态码仍为 200:访客处于挂起状态。
14015业务错误码,HTTP 状态码仍为 200:访客正在分流中。
14500业务错误码,HTTP 状态码仍为 200:系统内部错误。
postEndpoint
/openapi/chat/service/time/template
POST
/openapi/chat/service/time/template
curl -X POST "https://qiyukf.com/openapi/chat/service/time/template?appKey=1c088a89de51d0af457616605f28390f&time=1716446400&checksum=e72be4487b6fc03e0f914fc11e4053d771598d93&checksumAlgorithm=0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": 20001,
      "name": "默认服务时间",
      "normalServiceTime": [
        {
          "weekDays": [
            "MONDAY"
          ],
          "time": [
            {
              "beginHour": 9,
              "beginMinute": 0,
              "endHour": 18,
              "endMinute": 0
            }
          ]
        }
      ],
      "specialServiceTime": [
        {
          "day": {
            "beginDay": 1716446400000,
            "endDay": 1716532800000
          },
          "time": [
            {
              "beginHour": 9,
              "beginMinute": 0,
              "endHour": 18,
              "endMinute": 0
            }
          ],
          "remark": "春节假期",
          "type": 1
        }
      ]
    }
  ]
}
空
空
空
{
  "code": 8002,
  "message": "参数错误,常见于请求体 JSON 不合法、缺少必填字段或字段格式不合法。"
}
{
  "code": 8003,
  "message": "业务状态错误,例如质检任务状态错误或任务类型不匹配。"
}
{
  "code": 8501,
  "message": "企业不存在。"
}
{
  "code": 14001,
  "message": "AppKey 不存在或无效。"
}
{
  "code": 14002,
  "message": "checksum 签名校验失败。"
}
{
  "code": 14003,
  "message": "time 与服务器时间相差超过允许范围,或时间参数为空。"
}
{
  "code": 14004,
  "message": "请求内容错误,例如请求体格式错误、缺少必填字段或字段值不合法。"
}
{
  "code": 14005,
  "message": "无客服在线。"
}
{
  "code": 14006,
  "message": "访客正在排队。"
}
{
  "code": 14008,
  "message": "IP 白名单限制或 IP 被拦截。"
}
{
  "code": 14009,
  "message": "请求过于频繁。"
}
{
  "code": 14010,
  "message": "留言功能关闭。"
}
{
  "code": 14011,
  "message": "接口未开放或被停用。"
}
{
  "code": 14014,
  "message": "访客处于挂起状态。"
}
{
  "code": 14015,
  "message": "访客正在分流中。"
}
{
  "code": 14500,
  "message": "系统内部错误。"
}

这篇文档有帮助吗?