/ximalaya/sounds/comments

POST /api/ximalaya/sounds/comments

Price: 10 credits

List listener comments left on one Ximalaya sound, with their replies

How to use it

Comments are attached to a single episode, not to the show, so judging a whole album from them means sampling several episodes. An episode nobody has commented on and a sound id that does not exist both come back as an empty list, so confirm the sound itself before reporting silence. Only the newest stretch of a busy episode's thread is served, so a very old comment may be unreachable however large a count you ask for.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• sound string required — Sound id, or a sound link of the form /sound/{id} (examples: "334053571", "https://www.ximalaya.com/sound/917481054"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 1500)

Response

• @type string (default: "XimalayaSoundComment")
• id integer required
• url string nullable
• text string nullable
• user_id integer nullable
• nickname string nullable
• user_url string nullable
• image string nullable
• attachment string nullable
• anchor_grade integer nullable
• like_count integer nullable
• reply_count integer nullable
• created_at integer nullable
• replies array (default: [])
  • @type string (default: "XimalayaSoundCommentReply")
  • id integer required
  • text string nullable
  • user_id integer nullable
  • nickname string nullable
  • user_url string nullable
  • image string nullable
  • like_count integer nullable
  • parent_id integer nullable
  • parent_user_id integer nullable
  • parent_nickname string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.