返回接口目录
课程学习/Bearer

Search course sections

Search published course video sections by subject, literal keyword, or literal course tag query. The server returns factual section candidates and a stable contentRef; the local Agent decides whether one fits the learner.

Endpoint

POST/api/v1/agent/capabilities/ielts_courses_search_sections

请求参数

字段类型必填说明
courseIdnumberOptional exact course id returned by the learning route.
limitnumberMaximum number of exact course sections to return.
pagenumberResult page. Use nextPage from the preceding search.
searchstringOptional course, section, or video keyword.
subject | listening | reading | speaking | writing | grammarOptional IELTS subject filter.
tagQueriesunknown[]Literal course labels or user-mentioned learning terms used to match course tags.

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_courses_search_sections' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"limit":4,"page":1,"search":"","subject":"","tagQueries":[]}'

请求结构

{
  "type": "object",
  "properties": {
    "courseId": {
      "description": "Optional exact course id returned by the learning route.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "default": 4,
      "description": "Maximum number of exact course sections to return.",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "page": {
      "default": 1,
      "description": "Result page. Use nextPage from the preceding search.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "search": {
      "default": "",
      "description": "Optional course, section, or video keyword.",
      "type": "string"
    },
    "subject": {
      "default": "",
      "description": "Optional IELTS subject filter.",
      "type": "string",
      "enum": [
        "",
        "listening",
        "reading",
        "speaking",
        "writing",
        "grammar"
      ]
    },
    "tagQueries": {
      "default": [],
      "description": "Literal course labels or user-mentioned learning terms used to match course tags.",
      "maxItems": 6,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      }
    }
  },
  "required": [
    "limit",
    "page",
    "search",
    "subject",
    "tagQueries"
  ],
  "additionalProperties": false
}

统一响应

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

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

错误码

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