Get a Channel
Get a Channel
Parameter
Accessible via URL https://api.channel.io/open/v5/channel
and HTTP GET
This method accepts
application/json
Example
GET https://api.channel.io/open/v5/channel
Response
Returns a Channel object
{
"channel": {
"id": "string",
"name": "string",
"homepageUrl": "string",
"description": "string",
"nameDescI18nMap": {
"additionalProp1": {
"name": "string",
"description": "string"
},
"additionalProp2": {
"name": "string",
"description": "string"
},
"additionalProp3": {
"name": "string",
"description": "string"
}
},
"botName": "string",
"welcomeMessage": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatType": "string",
"chatId": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"form": {
"inputs": [
{
"value": {},
"readOnly": true,
"type": "text",
"label": "string",
"dataType": "string",
"bindingKey": "string"
}
],
"submittedAt": 1656032153409,
"type": "string"
}
},
"welcomeMessageI18nMap": {
"additionalProp1": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatType": "string",
"chatId": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"form": {
"inputs": [
{
"value": {},
"readOnly": true,
"type": "text",
"label": "string",
"dataType": "string",
"bindingKey": "string"
}
],
"submittedAt": 1656032153409,
"type": "string"
}
},
"additionalProp2": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatType": "string",
"chatId": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"form": {
"inputs": [
{
"value": {},
"readOnly": true,
"type": "text",
"label": "string",
"dataType": "string",
"bindingKey": "string"
}
],
"submittedAt": 1656032153409,
"type": "string"
}
},
"additionalProp3": {
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatType": "string",
"chatId": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"form": {
"inputs": [
{
"value": {},
"readOnly": true,
"type": "text",
"label": "string",
"dataType": "string",
"bindingKey": "string"
}
],
"submittedAt": 1656032153409,
"type": "string"
}
}
},
"country": "string",
"createdAt": 1656032153414,
"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,
"followUpTexting": true,
"followUpEmail": true,
"followUpAskName": true,
"followUpMandatory": true,
"state": "waiting",
"bizGrade": "AA",
"trialBeginDate": "2022-06-24",
"trialEndDate": "2022-06-24",
"blockReplyingAfterClosed": true,
"blockReplyingAfterClosedTime": {
"seconds": 0,
"nano": 0,
"negative": true,
"zero": true,
"units": [
{
"dateBased": true,
"timeBased": true,
"durationEstimated": 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",
"enableMfa": true,
"hideAppMessenger": true,
"working": true,
"avatarUrl": "string",
"blocked": true,
"systemDomain": "string",
"borderColor": "string",
"bright": true,
"utcOffset": "string",
"nextOperatingAt": 1656032153412,
"trial": true,
"textColor": "string",
"subscription": {
"billingPeriod": "yearly",
"servicePlan": "xsmall",
"operationFeature": true,
"mktFeature": true,
"whiteLabelFeature": true
},
"gradientColor": "string",
"initial": "string",
"usingFollowUp": true
},
"manager": {
"id": "string",
"channelId": "string",
"accountId": "string",
"name": "string",
"description": "string",
"showDescriptionToFront": true,
"nameDescI18nMap": {
"additionalProp1": {
"name": "string",
"description": "string"
},
"additionalProp2": {
"name": "string",
"description": "string"
},
"additionalProp3": {
"name": "string",
"description": "string"
}
},
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"email": "string",
"showEmailToFront": true,
"mobileNumber": "string",
"showMobileNumberToFront": true,
"role": "owner",
"removed": true,
"createdAt": 1656032151480,
"displayAsChannel": true,
"defaultGroupWatch": "all",
"defaultDirectChatWatch": "all",
"defaultUserChatWatch": "all",
"chatAlertSound": "none",
"showPrivateMessagePreview": true,
"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
}
]
},
"defaultAllMentionImportant": true,
"userMessageImportant": true,
"autoAssignCapacity": 0,
"statusEmoji": "string",
"statusText": "string",
"statusClearAt": 1656032151487,
"doNotDisturbClearAt": 1656032151487,
"doNotDisturb": true,
"avatarUrl": "string",
"managerId": "string",
"emailForFront": "string",
"mobileNumberForFront": "string"
},
"managerBadge": {
"id": "string",
"teamChatAlert": 0,
"teamChatUnread": 0,
"userChatAlert": 0,
"userChatUnread": 0,
"teamChatThreadAlert": 0,
"teamChatThreadUnread": 0,
"updatedAt": 1656032147009,
"version": 0,
"alert": 0,
"unread": 0,
"managerId": "string"
}
}
Updated about 1 year ago