/ximalaya/sounds

POST /api/ximalaya/sounds

Price: 1 credit

Get a Ximalaya sound (a single audio episode) by id or sound link, with its parent album

How to use it

Album, sound and anchor ids share one numeric range on Ximalaya and the source cannot tell them apart, so an album or anchor id passed here resolves to an unrelated sound under a normal 200 - pass the /sound/{id} link whenever you have it and a wrong-type value is rejected instead of silently answered. The parent album arrives with the sound, so no second call is needed for the show it belongs to.

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)

Response

• @type string (default: "XimalayaSound")
• id integer required
• url string required
• track_title string nullable
• description string nullable
• image string nullable
• video_image string nullable
• duration integer nullable
• anchor_id integer nullable
• anchor_url string nullable
• play_count integer nullable
• like_count integer nullable
• comment_count integer nullable
• position_in_album integer nullable
• price number nullable
• discounted_price number nullable
• is_paid boolean nullable
• is_video boolean nullable
• created_at integer nullable
• updated_at integer nullable
• album object nullable
  • @type string (default: "XimalayaSoundAlbum")
  • id integer required
  • url string required
  • album_title string nullable
  • description string nullable
  • image string nullable
  • category_id integer nullable
  • category_title string nullable
  • play_count integer nullable
  • subscribe_count integer nullable
  • track_count integer nullable
  • is_paid boolean 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 — No sound exists with this id. 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.