Get a Channel

Get a Channel

Parameter

Accessible via URL https://api.channel.io/open/v4/channel and HTTP GET

📘

This method accepts application/json

Example

GET https://api.channel.io/open/v4/channel

Response

Returns a Channel object

{
  "channel": {
    "id": "string",
    "name": "string",
    "homepageUrl": "string",
    "description": "string",
    "country": "string",
    "createdAt": 1624414658462,
    "domain": "string",
    "color": "string",
    "userInfoUrl": "string",
    "timeZone": "string",
    "inOperation": true,
    "operationTimeScheduling": true,
    "operationTimeRanges": {
      "timeRanges": [
        {
          "dayOfWeeks": [
            "mon"
          ],
          "from": 0,
          "to": 0
        }
      ]
    },
    "trafficSource": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "phoneNumber": "string",
    "avatar": {
      "bucket": "string",
      "key": "string",
      "width": 0,
      "height": 0
    },
    "billAccountId": "string",
    "servicePlan": "xsmall",
    "operationFeature": true,
    "mktFeature": true,
    "whiteLabelFeature": true,
    "billingPeriod": "yearly",
    "billingDay": 0,
    "stopRenewal": true,
    "mau": 0,
    "enableTexting": true,
    "enableEmail": true,
    "state": "waiting",
    "bizGrade": "AA",
    "trialBeginDate": "2021-06-23",
    "trialEndDate": "2021-06-23",
    "blockReplyingAfterClosed": true,
    "blockReplyingAfterClosedTime": {
      "seconds": 0,
      "nano": 0,
      "units": [
        {
          "dateBased": true,
          "timeBased": true,
          "durationEstimated": true
        }
      ],
      "zero": true,
      "negative": true
    },
    "defaultPluginId": "string",
    "expectedResponseDelay": "instant",
    "awayOption": "active",
    "sourceSurvey": {
      "additionalProp1": {},
      "additionalProp2": {},
      "additionalProp3": {}
    },
    "bizCategory": "string",
    "staffs": 0,
    "appCommerceId": "string",
    "appCommerceType": "string",
    "enableMemberHash": true,
    "memberHashSalt": "string",
    "defaultEmailDomainId": "string",
    "blocked": true,
    "working": true,
    "avatarUrl": "string",
    "nextOperatingAt": 1624414658485,
    "initial": "string",
    "textColor": "string",
    "trial": true,
    "utcOffset": "string",
    "systemDomain": "string",
    "subscription": {
      "billingPeriod": "yearly",
      "servicePlan": "xsmall",
      "operationFeature": true,
      "mktFeature": true,
      "whiteLabelFeature": true
    }
  },
  "manager": {
    "id": "string",
    "channelId": "string",
    "accountId": "string",
    "username": "string",
    "name": "string",
    "description": "string",
    "email": "string",
    "mobileNumber": "string",
    "role": "owner",
    "removed": true,
    "createdAt": 1624414655822,
    "defaultGroupWatch": "all",
    "defaultDirectChatWatch": "all",
    "defaultUserChatWatch": "all",
    "operatorScore": 0,
    "touchScore": 0,
    "avatar": {
      "bucket": "string",
      "key": "string",
      "width": 0,
      "height": 0
    },
    "operatorEmailReminder": true,
    "operator": true,
    "operatorScheduling": true,
    "operatorTimeRanges": {
      "timeRanges": [
        {
          "dayOfWeeks": [
            "mon"
          ],
          "from": 0,
          "to": 0
        }
      ]
    },
    "avatarUrl": "string",
    "managerId": "string"
  },
  "managerBadge": {
    "id": "string",
    "teamChatAlert": 0,
    "teamChatUnread": 0,
    "userChatAlert": 0,
    "userChatUnread": 0,
    "teamChatThreadAlert": 0,
    "teamChatThreadUnread": 0,
    "updatedAt": 1624414649744,
    "version": 0,
    "alert": 0,
    "unread": 0,
    "managerId": "string"
  }
}