Skip to main content

Channels Data Model

COTChannel

Description​

Channels are the workspace where users can interact with workflows, surveys, bots, and other users. Channels exist within either regular or workflow groups.

Sample JSON​

{
    "_id" : "6127d4d58ae12fc65e0a1ee0",
    "__v" : 0,
    "bots" : [
        "6127d4e62b2c8b1d073fa35a", 
        "6127d4ec8ae7617c3fc5583a"
        ],
    "company" : "6127d4f60690186a424492d1",
    "createdAt" : "2021-08-24T03:06:57.019Z",
    "group" : "6127d4ff8ef33cc66adc0c38",
    "groupOwnerIds" : [ 
        "6127d5050f901439615a55b3", 
        "6127d5203350c801ce880a62"
    ],
    "image" : {
        "small": "https://cotalker-us-files.s3.amazonaws.com/certificationworld/image/6127d53288c2199d5f896c67/small/update-multiplechoice-subproperty.png",
        "square": "https://cotalker-us-files.s3.amazonaws.com/certificationworld/image/6127d53ab60b7c04a51e5153/square/update-multiplechoice-subproperty.png",
        "original": "https://cotalker-us-files.s3.amazonaws.com/certificationworld/image/6127d54044219124dca4d97a/original/update-multiplechoice-subproperty.png"
    },
    "isActive" : true,
    "isDirect" : false,
    "isPrivate" : true,
    "lastMessage": {
        "content": "Jane Doe: Here's the report!",
        "date": "2021-07-05T20:56:13.232Z",
        "sender": "6127d54bff638c40c90e3fc8",
        "contentType": "text/plain"
    },
    "modifiedAt" : "2021-08-24T03:06:57.019Z",
    "nameCode" : "team_chat",
    "nameDisplay" : "Team Chat",
    "overrideName" : true,
    "pinned" : [
        "6127d5d4e55cccfb28e6d966"
    ],
    "propertyIds" : [ 
        "6127d5e33fa7d912eea24f22"
    ],
    "search": [
            "team",
            "chat",
            "teamchat"
    ],
    "settings" : {
        "write" : "all",
        "writeUserIds" : [
            "6127d64e411cf3db278a958a"
        ]
    },
    "userIds" : [ 
        "6127d5050f901439615a55b3", 
        "6127d5203350c801ce880a62",
        "61246250e415b1bb58070a20", 
        "61246250e415b149d3070a1a"
    ],
    "videoCall": {
        "start": {
            "any": false,
            "permissions": [
                "web-access"
            ]
        },
        "isActive": true,
        "publishVideo": [
            "web-access"
        ],
        "publishAudio": [
            "web-access"
        ]
    }
}

Fields​

FieldDescriptionTypeNotes
_idChannel ID numberObjectId<COTChannel>
__vDocument versionnumberCannot be modified and should never be used.
botsArray with the IDs of the bots assigned to the channelObjectId<COTBot>[ ]Bot Data Model
companyCompany ID numberObjectId<COTCompany>Channel Data Model
createdAtChannel creation dateISODateYYYY-MM-DDTHH:mm:ss.SSSZ
groupThe channel's group ID numberObjectId<COTGroup>Group Data Model
groupOwnerIdsArray of user ID numbers, including creator and initial usersObjectId<COTUser>[ ]User Data Model
imageChannel avatarobject
image.smallSmall image size stringURL
image.squareSquare shaped avatarstringURL
image.original Original image sizestringURL
isActiveIndicates if the channel is still active or if it has been deactivatedboolean
isDirectIndicates if the channel is a chat of direct messages between two users.boolean
isPrivateboolean
lastMessageDisplays the last message sent in the channelobject
lastMessage.contentMessage textstring
lastMessage.dateThe date the message was sentISODateYYYY-MM-DDTHH:mm:ss.SSSZ
lastMessage.senderThe user ID of the message senderObjectId<COTUser>User Data Model
lastMessage.contentTypeContent types include text, survey or multimedia filesstring
 modifiedAtIndicates the last time channel settings were modifiedISODateYYYY-MM-DDTHH:mm:ss.SSSZ
nameCodeThe channel's unique identification namestringMaximum 60 characters; only lowercase letters, numbers, and underscores allowed; must be unique.
nameDisplayThe channel name users will see in the platformstring 
overrideNameIndicates if the display name is overridden by the channel's first elementsbooleanFalse indicates the name has been overridden; true indicates that the manually added display name is being used
pinnedIndicates if the channel is pinned to the group panelObjectIdAn empty array indicates the channel is not pinned
propertyIdsAn array of element/property IDs associated with the channelObjectId<COTProperty>[ ]Element Data Property
searchArray of keywords for search enginestring[ ]Automatically generated
settingsobject
settings.writeIndicates if users can write messages in the channelstringOptions are all or none
userIdsArray of the IDs of the users in the channelObjectId<COTUser>[ ]
videoCallEnables users to start video calls within the channelobject
videoCall.startIndicates if permissions are required to initiate a video callobject
videoCall.start.anyIndicates if any user within the channel can initiate a video callbooleanIf true, no permissions are needed
 videoCall.start.permissionsArray of permissions needed to initiate a video callstring[ ]If video.start.any is false, permissions must be indicated
videoCall.isActiveIndicates if the video calls can be initiated within the channelbooleanIf true, calls are permitted
videoCall.publishVideoIndicates permissions needed to use the videostring[ ]
videoCall.publishAudioIndicates permissions needed to use the audiostring[ ]

Deprecated Elements​

The following deprecated items might still be found in the model:

FieldDescriptionTypeNotes
actionButtonAdds a button with links to the channel workspacearrayDEPRECATED
archiveIndicates if a channel has been archivedstring[ ]DEPRECATED
autocompleteAutocompletes type input; for system use onlyobject[ ]DEPRECATED
groupNumber DEPRECATED
infoobjectDEPRECATED
lightProperty[ ]DEPRECATED
settings.displaystringDEPRECATED
settings.readstringDEPRECATED
settings.readUserIdsObjectId[ ]DEPRECATED
systemPinnedbooleanDEPRECATED
videoCall.durationArray of allowed times for video callsnumber[ ]DEPRECATED
visibilityobjectDEPRECATED

Additional Resources​

Help​