All Products
Search
Document Center

Qoder CN Series:List channels

Last Updated:Jul 15, 2026

List external IM channels with filters and cursor pagination.

Request headers

Header

Required

Description

Authorization

Yes

Bearer <PAT>

Query parameters

Parameter

Type

Required

Default

Description

channel_type

string

No

-

Filter by wechat, qq, wecom, feishu, or dingtalk.

enabled

boolean

No

-

Filter by manual enable state.

binding_status

string

No

-

Filter by unbound, bound, or expired.

identity_id

string

No

-

Filter by Forward Identity ID.

template_id

string

No

-

Filter by Forward Template ID.

limit

integer

No

20

Items per page. Maximum 100.

after_id

string

No

-

Cursor for records after the given Channel ID.

before_id

string

No

-

Cursor for records before the given Channel ID.

Example request

curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/channels?identity_id=idn_019eabc123&limit=20' \
  -H "Authorization: Bearer $QODER_PAT"

Example response

HTTP 200 OK

{
  "data": [
    {
      "id": "ci_019eabc123",
      "type": "channel",
      "identity_id": "idn_019eabc123",
      "template_id": "tmpl_support",
      "channel_type": "feishu",
      "name": "Support Feishu channel",
      "enabled": true,
      "binding_status": "bound",
      "created_at": "2026-06-18T10:00:00Z",
      "updated_at": "2026-06-18T10:00:00Z"
    }
  ],
  "first_id": "ci_019eabc123",
  "last_id": "ci_019eabc123",
  "has_more": false
}

Response fields

Field

Type

Description

data

array

Channel objects on the current page.

first_id

string|null

ID of the first Channel on this page.

last_id

string|null

ID of the last Channel on this page.

has_more

boolean

Whether more records remain.

Errors

HTTP

Type

Code

Trigger

400

invalid_request_error

invalid_pagination

Pagination parameters are invalid.

400

invalid_request_error

channel_type_unsupported

Channel type filter is unsupported.

401

TOKEN_INVALID

PAT invalid or expired.

Notes

  • after_id and before_id are mutually exclusive.

  • Channels are returned only inside the caller's account boundary.