返回接口目录
词汇/BearerWrite

Record built-in vocabulary review

Record one review result for an enabled licensed built-in vocabulary entry.

Endpoint

POST/api/v1/agent/capabilities/ielts_vocabulary_builtin_record_review

请求参数

字段类型必填说明
entryIdstringBuilt-in word id.
ratingagain | hard | goodReview rating for spaced repetition.
responseMsnumberOptional answer latency in milliseconds.
setIdcore | listening | readingBuilt-in wordbook id.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_vocabulary_builtin_record_review' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"entryId":"<entryId>","rating":"again","setId":"core"}'

请求结构

{
  "type": "object",
  "properties": {
    "entryId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "Built-in word id."
    },
    "rating": {
      "type": "string",
      "enum": [
        "again",
        "hard",
        "good"
      ],
      "description": "Review rating for spaced repetition."
    },
    "responseMs": {
      "description": "Optional answer latency in milliseconds.",
      "type": "integer",
      "minimum": 0,
      "maximum": 300000
    },
    "setId": {
      "default": "core",
      "description": "Built-in wordbook id.",
      "type": "string",
      "enum": [
        "core",
        "listening",
        "reading"
      ]
    }
  },
  "required": [
    "entryId",
    "rating",
    "setId"
  ],
  "additionalProperties": false
}

统一响应

接口结果位于 data;code 为 0 表示调用成功。

{
  "code": 0,
  "data": {},
  "message": "ok"
}

错误码

40040001请求参数不符合接口契约
40140101缺少或使用了无效的访问令牌
40340301访问令牌不包含接口所需权限
40440401接口或目标资源不存在