Create a channel

POST /api/v1/forward/channels Creates a channel instance for an external messaging platform. The channel receives inbound IM messages and sends replies through the configured provider.

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT>`
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	Optional idempotency key for unsafe requests.

Body parameters

Parameter	Type	Required	Description
`identity_id`	string	Yes	Forward Identity ID. Must belong to the caller and be enabled.
`template_id`	string	Yes	Forward Template ID used when the channel creates sessions.
`channel_type`	string	Yes	Channel type. Currently supports `wechat`, `wecom`, `feishu`, and `dingtalk`.
`name`	string	No	Channel display name.
`channel_config.credentials`	object	Conditional	Channel runtime credentials. QR authorization channels may omit it. Direct credential channels use provider-specific fields: `feishu` uses `app_id`/`app_secret`, `dingtalk` uses `client_id`/`client_secret`, and `wecom` uses `bot_id`/`secret`. Credentials are not returned in plaintext.
`channel_config.response_options`	object	No	Reply visibility settings.

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/channels' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "identity_id": "idn_019eabc123",
    "template_id": "tmpl_support",
    "channel_type": "feishu",
    "name": "Support Feishu channel",
    "channel_config": {
      "credentials": {
        "app_id": "...",
        "app_secret": "..."
      },
      "response_options": {
        "include_tool_calls": false,
        "include_thinking": false
      }
    }
  }'

Example response

HTTP 201 Created

{
  "id": "channel_019eabc123",
  "type": "channel",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "channel_type": "feishu",
  "name": "Support Feishu channel",
  "enabled": true,
  "binding_status": "bound",
  "channel_config": {
    "response_options": {
      "include_tool_calls": false,
      "include_thinking": false
    }
  },
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

Response fields

Field	Type	Description
`id`	string	Channel ID. Example prefix is `channel_`.
`type`	string	Always `channel`.
`identity_id`	string	Bound Forward Identity ID.
`template_id`	string	Bound Forward Template ID.
`channel_type`	string	External channel type.
`enabled`	boolean	Manual enable or disable switch.
`binding_status`	string	`unbound`, `bound`, or `expired`.
`channel_config.response_options`	object	Reply visibility settings.

Error codes

HTTP	Type	Trigger
400	`invalid_request_error`	Channel type is unsupported.
400	`invalid_request_error`	Required credentials are missing.
401	`authentication_error`	PAT is invalid or expired.
403	`permission_error`	Channel quota exceeded.
404	`not_found_error`	Template does not exist or is not visible.
404	`not_found_error`	Identity does not exist or is not visible.
409	`conflict_error`	Identity is disabled.
409	`conflict_error`	Credential validation conflict.
502	`api_error`	Channel service unavailable.

Notes

New channels default to enabled=true.
A channel can process inbound messages only when enabled=true and binding_status="bound".
To pause inbound processing temporarily, prefer Update Channel with enabled=false.

Create a channel

Headers

Body parameters

Example request

Example response

Response fields

Error codes

Notes

Create channel QR session

List channels

​Headers

​Body parameters

​Example request

​Example response

​Response fields

​Error codes

​Notes

​Related

Create channel QR session

List channels

Headers

Body parameters

Example request

Example response

Response fields

Error codes

Notes

Related