ConversationClient class

Package:

@microsoft/teams.api

Constructors

ConversationClient(string, Client | ClientOptions, Partial<ApiClientSettings>)

Properties

http
serviceUrl

Methods

activities(string)
addReaction(string, string, MessageReactionType)	Add a reaction to an activity in a conversation.
create(CreateConversationParams)
createActivity(string, ActivityParams)
createActivity(string, DeprecatedInputActivity)	Create an activity in a conversation.
createReplyChainActivity(string, string, ActivityParams)	Create an activity inside a reply chain (thread). Posts to /v3/conversations/{conversationId}/replyChains/{id}.
createTargetedActivity(string, ActivityParams)
createTargetedActivity(string, DeprecatedInputActivity)	Create a targeted activity in a conversation.
createTargetedReplyChainActivity(string, string, ActivityParams)	Create an activity inside a reply chain (thread) that is visible only to the specified recipient. Takes the same arguments as createReplyChainActivity.
deleteActivity(string, string)	Delete an activity in a conversation.
deleteReaction(string, string, MessageReactionType)	Delete a reaction from an activity in a conversation.
deleteTargetedActivity(string, string)	Delete a targeted activity in a conversation.
get(GetConversationsParams)
getActivityMembers(string, string)	Get the members of an activity in a conversation.
getMemberById(string, string)	Get a member of a conversation by id.
getMembers(string)	Get the members of a conversation.
getPagedMembers(string, number, string)	Get paged members of a conversation.
members(string)
replyToActivity(string, string, ActivityParams)
replyToActivity(string, string, DeprecatedInputActivity)	Reply to an activity in a conversation.
updateActivity(string, string, ActivityParams)
updateActivity(string, string, DeprecatedInputActivity)	Update an activity in a conversation.
updateTargetedActivity(string, string, ActivityParams)
updateTargetedActivity(string, string, DeprecatedInputActivity)	Update a targeted activity in a conversation.

Constructor Details

ConversationClient(string, Client | ClientOptions, Partial<ApiClientSettings>)

new ConversationClient(serviceUrl: string, options?: Client | ClientOptions, apiClientSettings?: Partial<ApiClientSettings>)

Parameters

serviceUrl

string

options

Client | ClientOptions

apiClientSettings

Partial<ApiClientSettings>

Property Details

http

Client http

Property Value

Client

serviceUrl

serviceUrl: string

Property Value

string

Method Details

activities(string)

Warning

This API is now deprecated.

Use the flattened activity methods on ConversationClient instead (e.g. conversations.createActivity(conversationId, ...)). This grouped accessor will be removed in a future release.

function activities(conversationId: string): IConversationActivityOperations

Parameters

conversationId

string

Returns

IConversationActivityOperations

addReaction(string, string, MessageReactionType)

Add a reaction to an activity in a conversation.

function addReaction(conversationId: string, activityId: string, reactionType: MessageReactionType): Promise<void>

Parameters

conversationId

string

activityId

string

reactionType

MessageReactionType

Returns

Promise<void>

create(CreateConversationParams)

function create(params: CreateConversationParams): Promise<ConversationResource>

Parameters

params

CreateConversationParams

Returns

Promise<ConversationResource>

createActivity(string, ActivityParams)

function createActivity(conversationId: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

params

ActivityParams

Returns

Promise<Resource>

createActivity(string, DeprecatedInputActivity)

Warning

This API is now deprecated.

Use MessageActivityInput or TypingActivityInput instead.

Create an activity in a conversation.

function createActivity(conversationId: string, params: DeprecatedInputActivity): Promise<Resource>

Parameters

conversationId

string

params

DeprecatedInputActivity

Returns

Promise<Resource>

createReplyChainActivity(string, string, ActivityParams)

Create an activity inside a reply chain (thread).

Posts to /v3/conversations/{conversationId}/replyChains/{id}.

function createReplyChainActivity(conversationId: string, id: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

the id of the chat or channel: channelData.chat.id or channelData.channel.id, not conversation.id.

id

string

the id of the message at the root of the reply chain: channelData.replyChain.id

params

ActivityParams

the activity to send

Returns

Promise<Resource>

createTargetedActivity(string, ActivityParams)

function createTargetedActivity(conversationId: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

params

ActivityParams

Returns

Promise<Resource>

createTargetedActivity(string, DeprecatedInputActivity)

Warning

This API is now deprecated.

Use MessageActivityInput or TypingActivityInput instead.

Create a targeted activity in a conversation.

function createTargetedActivity(conversationId: string, params: DeprecatedInputActivity): Promise<Resource>

Parameters

conversationId

string

params

DeprecatedInputActivity

Returns

Promise<Resource>

createTargetedReplyChainActivity(string, string, ActivityParams)

Create an activity inside a reply chain (thread) that is visible only to the specified recipient.

Takes the same arguments as createReplyChainActivity.

function createTargetedReplyChainActivity(conversationId: string, id: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

the id of the chat or channel: channelData.chat.id or channelData.channel.id, not conversation.id.

id

string

the id of the message at the root of the reply chain: channelData.replyChain.id

params

ActivityParams

the activity to send

Returns

Promise<Resource>

deleteActivity(string, string)

Delete an activity in a conversation.

function deleteActivity(conversationId: string, id: string): Promise<void>

Parameters

conversationId

string

id

string

Returns

Promise<void>

deleteReaction(string, string, MessageReactionType)

Delete a reaction from an activity in a conversation.

function deleteReaction(conversationId: string, activityId: string, reactionType: MessageReactionType): Promise<void>

Parameters

conversationId

string

activityId

string

reactionType

MessageReactionType

Returns

Promise<void>

deleteTargetedActivity(string, string)

Delete a targeted activity in a conversation.

function deleteTargetedActivity(conversationId: string, id: string): Promise<void>

Parameters

conversationId

string

id

string

Returns

Promise<void>

get(GetConversationsParams)

Warning

This API is now deprecated.

This will be removed by end of summer 2026.

function get(params: GetConversationsParams): Promise<GetConversationsResponse>

Parameters

params

GetConversationsParams

Returns

Promise<GetConversationsResponse>

getActivityMembers(string, string)

Get the members of an activity in a conversation.

function getActivityMembers(conversationId: string, id: string): Promise<TeamsChannelAccount[]>

Parameters

conversationId

string

id

string

Returns

Promise<TeamsChannelAccount[]>

getMemberById(string, string)

Get a member of a conversation by id.

function getMemberById(conversationId: string, id: string): Promise<TeamsChannelAccount>

Parameters

conversationId

string

id

string

Returns

Promise<TeamsChannelAccount>

getMembers(string)

Get the members of a conversation.

function getMembers(conversationId: string): Promise<TeamsChannelAccount[]>

Parameters

conversationId

string

Returns

Promise<TeamsChannelAccount[]>

getPagedMembers(string, number, string)

Get paged members of a conversation.

function getPagedMembers(conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>

Parameters

conversationId

string

pageSize

number

continuationToken

string

Returns

Promise<PagedMembersResult>

members(string)

Warning

This API is now deprecated.

Use the flattened member methods on ConversationClient instead (e.g. conversations.getMembers(conversationId)). This grouped accessor will be removed in a future release.

function members(conversationId: string): { delete: (id: string) => Promise<void>, get: () => Promise<TeamsChannelAccount[]>, getById: (id: string) => Promise<TeamsChannelAccount>, getPaged: (pageSize?: number, continuationToken?: string) => Promise<PagedMembersResult> }

Parameters

conversationId

string

Returns

{ delete: (id: string) => Promise<void>, get: () => Promise<TeamsChannelAccount[]>, getById: (id: string) => Promise<TeamsChannelAccount>, getPaged: (pageSize?: number, continuationToken?: string) => Promise<PagedMembersResult> }

replyToActivity(string, string, ActivityParams)

function replyToActivity(conversationId: string, id: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

id

string

params

ActivityParams

Returns

Promise<Resource>

replyToActivity(string, string, DeprecatedInputActivity)

Warning

This API is now deprecated.

Use MessageActivityInput or TypingActivityInput instead.

Reply to an activity in a conversation.

function replyToActivity(conversationId: string, id: string, params: DeprecatedInputActivity): Promise<Resource>

Parameters

conversationId

string

id

string

params

DeprecatedInputActivity

Returns

Promise<Resource>

updateActivity(string, string, ActivityParams)

function updateActivity(conversationId: string, id: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

id

string

params

ActivityParams

Returns

Promise<Resource>

updateActivity(string, string, DeprecatedInputActivity)

Warning

This API is now deprecated.

Use MessageActivityInput or TypingActivityInput instead.

Update an activity in a conversation.

function updateActivity(conversationId: string, id: string, params: DeprecatedInputActivity): Promise<Resource>

Parameters

conversationId

string

id

string

params

DeprecatedInputActivity

Returns

Promise<Resource>

updateTargetedActivity(string, string, ActivityParams)

function updateTargetedActivity(conversationId: string, id: string, params: ActivityParams): Promise<Resource>

Parameters

conversationId

string

id

string

params

ActivityParams

Returns

Promise<Resource>

updateTargetedActivity(string, string, DeprecatedInputActivity)

Warning

This API is now deprecated.

Use MessageActivityInput or TypingActivityInput instead.

Update a targeted activity in a conversation.

function updateTargetedActivity(conversationId: string, id: string, params: DeprecatedInputActivity): Promise<Resource>

Parameters

conversationId

string

id

string

params

DeprecatedInputActivity

Returns

Promise<Resource>