Channels

As the name suggests, channels are a core part of klink.cloud — the very reason klink.cloud exists is so you can have secure conversations with your channels. On this page, we'll dive into the different channel endpoints you can use to manage channels programmatically. We'll look at how to query channels.

The Channel Model

The channel model contains all the information about your channel lists.

Properties

Name
id
Type
string
Description
Unique identifier for the channel.
Name
name
Type
string
Description
Name of the channel
Name
type
Type
string
Description
Name of the channel type
Name
brandName
Type
string
Description
Name of the channel brand.

GETapi/v1/channels

List all channel

This endpoint allows you to retrieve a paginated list of all your channel. By default, a maximum of ten channel are shown per page.

Optional attributes

Name
keyword
Type
string
Description
Search the channels by keywords. You cannot search with a substring. For example, a channel "Kyaw Kyaw" can be looked up using "kyaw", "Kya", "yaw" and "aw".

Request

GET

/api/v1/channels

curl -G https://api.klink.cloud/api/v1/channels \
  -H "Authorization: Bearer {token}" \
  -d keyword={your_keyword_here}

Response

{
  "requestId": "557520e4-7197-4d56-8a24-ee8c2782d6e4",
  "page": 1,
  "pageSize": 10,
  "lastPage": 8,
  "total": 73
    "data":[
      {
      "id": "f6154dda-bd9a-4d03-8a77-ff3421070009",
      "createdAt": "2025-03-02T16:42:53.796Z",
      "updatedAt": "2025-03-02T16:42:54.078Z",
      "deletedAt": null,
      "name": "K-Link BSS UAT DEMO KURO",
      "type": "line",
      "brandName": "K-Link BSS UAT DEMO KURO"
    },
    {
      "id": ...............
    }
  ]
}