conversations_open

POST /conversations.open

Copy endpoint

https://slack.com/api

Opens or resumes a direct message or multi-person direct message.

Parameters

header Header Parameters

Name	Type
`token` Authentication token. Requires scope: `conversations:write`	string

Request Body

application/x-www-form-urlencoded

{ channel?: string;return_im?: boolean;users?: string; }

Responses

200 application/json

Typical success response

{
already_open?: boolean;
channel: (

ObjsConversation

type ObjsConversation = ({
accepted_user?: DefsUserId;
connected_team_ids?: DefsWorkspaceId[];
conversation_host_id?: DefsWorkspaceId;
created: number;
creator: DefsUserId;
display_counts?: { display_counts: number;guest_counts: number; };
enterprise_id?: DefsEnterpriseId;
has_pins?: boolean;
id: DefsChannel;
internal_team_ids?: DefsTeam[];
is_archived: boolean;
is_channel: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_general: boolean;
is_global_shared?: boolean;
is_group: boolean;
is_im: boolean;
is_member?: boolean;
is_moved?: number;
is_mpim: false;
is_non_threadable?: boolean;
is_open?: boolean;
is_org_default?: boolean;
is_org_mandatory?: boolean;
is_org_shared: boolean;
is_pending_ext_shared?: boolean;
is_private: boolean;
is_read_only?: boolean;
is_shared: boolean;
is_starred?: boolean;
is_thread_only?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
members?: DefsUserId[];
name: string;
name_normalized: string;
num_members?: number;
parent_conversation?: (DefsChannel | null)[];
pending_connected_team_ids?: DefsTeam[];
pending_shared?: DefsTeam[];
pin_count?: number;
previous_names?: DefsChannelName[];
priority?: number;
purpose: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
shared_team_ids?: DefsTeam[];
shares?: {
accepted_user?: DefsUserId;
is_active: boolean;
team: ObjsTeam;
user: DefsUserId;
}[];
timezone_count?: number;
topic: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
unlinked?: number;
unread_count?: number;
unread_count_display?: number;
use_case?: string;
user?: DefsUserId;
version?: number;
} | {
accepted_user?: DefsUserId;
connected_team_ids?: DefsTeam[];
conversation_host_id?: DefsWorkspaceId;
created: number;
creator: DefsUserId;
display_counts?: { display_counts: number;guest_counts: number; };
id: DefsChannel;
internal_team_ids?: DefsTeam[];
is_archived: boolean;
is_channel: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_general: boolean;
is_group: boolean;
is_im: boolean;
is_member?: boolean;
is_moved?: number;
is_mpim: true;
is_non_threadable?: boolean;
is_open?: boolean;
is_org_shared: boolean;
is_pending_ext_shared?: boolean;
is_private: boolean;
is_read_only?: boolean;
is_shared: boolean;
is_starred?: boolean;
is_thread_only?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
members?: DefsUserId[];
name: string;
name_normalized: string;
num_members?: number;
parent_conversation?: (DefsChannel | null)[];
pending_connected_team_ids?: DefsTeam[];
pending_shared?: DefsTeam[];
pin_count?: number;
previous_names?: DefsChannelName[];
priority?: number;
purpose: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
shared_team_ids?: DefsTeam[];
shares?: {
accepted_user?: DefsUserId;
is_active: boolean;
team: ObjsTeam;
user: DefsUserId;
}[];
timezone_count?: number;
topic: { creator: DefsTopicPurposeCreator;last_set: number;value: string; };
unlinked?: number;
unread_count?: number;
unread_count_display?: number;
user?: DefsUserId;
version?: number;
} | {
created: number;
has_pins?: boolean;
id: DefsDmId;
is_archived?: boolean;
is_ext_shared?: boolean;
is_frozen?: boolean;
is_im: boolean;
is_open?: boolean;
is_org_shared: boolean;
is_shared?: boolean;
is_starred?: boolean;
is_user_deleted?: boolean;
last_read?: DefsTs;
latest?: (ObjsMessage | null)[];
parent_conversation?: (DefsChannel | null)[];
pin_count?: number;
priority: number;
shares?: {
date_create: number;
id: DefsTeam;
is_active: boolean;
name: string;
team: ObjsTeam;
}[];
unread_count?: number;
unread_count_display?: number;
user: DefsUserId;
version?: number;
})[]

| {
created?: string;
id:

DefsDmId

type DefsDmId = string

;
is_im?: boolean;
is_open?: boolean;
last_read?:

DefsTs

type DefsTs = `${string}.${string}`

;
latest?:

ObjsMessage

interface ObjsMessage {
attachments?: {
fallback?: string;
id: number;
image_bytes?: number;
image_height?: number;
image_url?: string;
image_width?: number;
}[];
blocks?: Blocks;
bot_id?: (DefsBotId | null)[];
bot_profile?: ObjsBotProfile;
client_msg_id?: string;
comment?: ObjsComment;
display_as_bot?: boolean;
file?: ObjsFile;
files?: ObjsFile[];
icons?: { emoji?: string;image_64?: string; };
inviter?: DefsUserId;
is_delayed_message?: boolean;
is_intro?: boolean;
is_starred?: boolean;
last_read?: DefsTs;
latest_reply?: DefsTs;
name?: string;
old_name?: string;
parent_user_id?: DefsUserId;
permalink?: string;
pinned_to?: DefsChannel[];
purpose?: string;
reactions?: ObjsReaction[];
reply_count?: number;
reply_users?: DefsUserId[];
reply_users_count?: number;
source_team?: DefsWorkspaceId;
subscribed?: boolean;
subtype?: string;
team?: DefsWorkspaceId;
text: string;
thread_ts?: DefsTs;
topic?: string;
ts: DefsTs;
type: string;
unread_count?: number;
upload?: boolean;
user?: DefsUserId;
user_profile?: ObjsUserProfileShort;
user_team?: DefsWorkspaceId;
username?: string;
}

;
unread_count?: number;
unread_count_display?: number;
user?:

DefsUserId

type DefsUserId = string

;
})[];
no_op?: boolean;
ok:

DefsOkTrue

type DefsOkTrue = true

;
}

default application/json

Typical error response

{ callstack?: string;error: "method_not_supported_for_channel_type" | "user_not_found" | "user_not_visible" | "user_disabled" | "users_list_not_supplied" | "not_enough_users" | "too_many_users" | "invalid_user_combination" | "not_authed" | "invalid_auth" | "account_inactive" | "invalid_arg_name" | "invalid_array_arg" | "invalid_charset" | "invalid_form_data" | "invalid_post_type" | "missing_post_type" | "team_added_to_org" | "invalid_json" | "json_not_object" | "request_timeout" | "upgrade_required" | "channel_not_found";ok:

DefsOkFalse

type DefsOkFalse = false

; }