{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Direct Message Details
This handler enables you to request details of the direct messages channel denoted by the given user ID. If the direct message channel exist for the current user, it is returned with detail information that can be used to access messages using the messages request API.
If the direct message channel does not yet exists between the current user and the given user ID, it will be created. Direct message channels have to be left by both member users before they are removed.
GET /teams/directmessages/<userID> and POST /teams/directmessages/<userID>
Returns the details of the direct message channel for the current and the given user.
Note: A POST
request is required first to create the channel if it does not exist yet. No data is required. The data can always be retrieved using GET
.
{ "channelId": "<ID of the channel>", "teamId": "<ID of the team>", "displayName": "<Name of the channel>", "description": "A description of the channel", }
RESPONSE Fields | Value Type | Description |
---|---|---|
channelId | String | The GUID of the channel, used for details and further operations |
teamId | String | The GUID of the team this channel is associated with |
displayName | String | The display name value of the channel, as displayed in the interface |
description | String | A description of the channel |
Example Request
# Request # Use user:password for authorization GET /api/cowork/teams/directmessages/7tga14nykz3vgehra094nz418 HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK { "channelId": "3y8kdto0lnx3ig3mshwvrb9x7", "teamId": "coworkdirectmessages00000", "displayName": "Hansi Hartmann", "description": "", }