WeChat Channels collection list API

Collections (playlists) of a WeChat Channels account

POST/v1/wechat_channels/collections/list

Use the WeChat Channels collection list API to read public WeChat Channels collections. Collections (playlists) of a WeChat Channels account.

Request

Send your API key as a Bearer token. Replace YOUR_API_KEY with a key from your console.

curl -X POST "https://xtikapi.com/v1/wechat_channels/collections/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"1234567890"}'

Parameters

NameTypeRequired
idstringrequired
rawstringoptional

Response fields

data holds the fields exactly as the platform sends them, and meta.normalized is false. meta still carries the request ID and what was billed.

    Example response

    A sample payload that shows the shape. Values are made up.

    {
      "example": true,
      "data": {
        "note": "Fields as the platform sends them."
      },
      "meta": {
        "request_id": "example",
        "endpoint": "wechat_channels.collections.list",
        "normalized": false,
        "unavailable": [],
        "billing": {
          "charged": true,
          "amount": 0.02,
          "balance": 4.98
        }
      }
    }

    Error codes

    Errors are not billed. Retry the ones marked yes. More in the API quickstart.

    CodeHTTPRetryMeaning
    unauthorized401noAPI key is missing, invalid, or revoked.
    rate_limited429yesToo many requests.
    invalid_params422noRequest parameters are invalid.
    price_exceeds_max402noThis call costs more than X-Max-Price.
    insufficient_balance402noBalance is too low for this call.
    key_limit_reached402noThis API key has reached its spend limit.
    idempotency_conflict409noThis Idempotency-Key was already used with different parameters.
    idempotency_in_progress409yesA request with this Idempotency-Key is still running.
    response_too_large409noThe response is too large to store for a safe retry.
    upstream_error502yesThe data provider returned an error. You were not charged.
    upstream_timeout504yesThe data provider timed out. You were not charged.
    internal_error500yesSomething went wrong on our side. You were not charged.
    not_found404noNo such endpoint.

    More WeChat Channels APIs

    Questions

    What does the WeChat Channels collection list API return?

    A record object with the fields listed on this page. Missing provider fields are named in meta.unavailable.

    When is the WeChat Channels collection list API billed?

    This call costs $0.02 when the provider returns HTTP 200. An empty result is billed. Errors and timeouts are not billed.

    What do I do if the provider returns an error?

    The response has charged set to false. Read the error code and retry if the error says retry is true. Your balance is unchanged.

    Where is this resource on another platform?

    Use the links on this page for the same resource and action on other platforms. Change the platform word in the path.