ConversationActivityClient Class
Client for managing activities in a Teams conversation.
Initialize the conversation activity client.
Constructor
ConversationActivityClient(service_url: str, http_client: Client | None = None, api_client_settings: ApiClientSettings | None = None, scope_factory: Callable[[str | None, AgenticIdentity | None], ConversationActivityClient] | None = None)
Parameters
| Name | Description |
|---|---|
|
service_url
Required
|
The base URL for the Teams service |
|
http_client
|
Optional HTTP client to use. If not provided, a new one will be created. Default value: None
|
|
api_client_settings
|
Optional API client settings. Default value: None
|
|
scope_factory
|
Default value: None
|
Methods
| create |
Create a new activity in a conversation. |
| create_targeted |
Create a new targeted activity in a conversation. Targeted activities are only visible to the specified recipient. Warning Preview This API is in preview and may change in the future. Diagnostic: ExperimentalTeamsTargeted |
| delete |
Delete an activity from a conversation. |
| delete_targeted |
Delete a targeted activity from a conversation. Warning Preview This API is in preview and may change in the future. Diagnostic: ExperimentalTeamsTargeted |
| get_members |
Get the members associated with an activity. |
| reply |
Reply to an activity in a conversation. |
| update |
Update an existing activity in a conversation. |
| update_targeted |
Update an existing targeted activity in a conversation. Warning Preview This API is in preview and may change in the future. Diagnostic: ExperimentalTeamsTargeted |
create
Create a new activity in a conversation.
async create(conversation_id: str, activity: MessageActivityInput | MessageReactionActivityInput | TypingActivityInput, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> SentActivity
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity
Required
|
The activity to create |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
The created activity |
create_targeted
Create a new targeted activity in a conversation.
Targeted activities are only visible to the specified recipient.
Warning
Preview
This API is in preview and may change in the future.
Diagnostic: ExperimentalTeamsTargeted
async create_targeted(conversation_id: str, activity: MessageActivityInput | MessageReactionActivityInput | TypingActivityInput, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> SentActivity
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity
Required
|
The activity to create |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
The created activity |
delete
Delete an activity from a conversation.
async delete(conversation_id: str, activity_id: str, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> None
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity to delete |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
delete_targeted
Delete a targeted activity from a conversation.
Warning
Preview
This API is in preview and may change in the future.
Diagnostic: ExperimentalTeamsTargeted
async delete_targeted(conversation_id: str, activity_id: str, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> None
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity to delete |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
get_members
Get the members associated with an activity.
async get_members(conversation_id: str, activity_id: str, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> List[TeamsChannelAccount]
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
List of TeamsChannelAccount objects representing the activity members |
reply
Reply to an activity in a conversation.
async reply(conversation_id: str, activity_id: str, activity: MessageActivityInput | MessageReactionActivityInput | TypingActivityInput, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> SentActivity
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity to reply to |
|
activity
Required
|
The reply activity |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
The created reply activity |
update
Update an existing activity in a conversation.
async update(conversation_id: str, activity_id: str, activity: MessageActivityInput | MessageReactionActivityInput | TypingActivityInput, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> SentActivity
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity to update |
|
activity
Required
|
The updated activity data |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
The updated activity |
update_targeted
Update an existing targeted activity in a conversation.
Warning
Preview
This API is in preview and may change in the future.
Diagnostic: ExperimentalTeamsTargeted
async update_targeted(conversation_id: str, activity_id: str, activity: MessageActivityInput | MessageReactionActivityInput | TypingActivityInput, *, service_url: str | None = None, agentic_identity: AgenticIdentity | None = None) -> SentActivity
Parameters
| Name | Description |
|---|---|
|
conversation_id
Required
|
The ID of the conversation |
|
activity_id
Required
|
The ID of the activity to update |
|
activity
Required
|
The updated activity data |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_url
|
Default value: None
|
|
agentic_identity
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
The updated activity |