Canvas Tools

Canvas Create Conversation

Utilisez Canvas Create Conversation avec Canvas Tools via Aident Loadout. Vérifiez les entrées, sorties, la configuration, le tarif et le risque avant exécution.

Action d'écritureNiveau de risque 2 sur 5Connexion par clé APIAction gratuite

Utiliser Canvas Create Conversation

Description du fournisseur

Use to send messages in Canvas by creating a new conversation or adding to an existing one; an existing conversation with the same recipients (and matching scope/filter, if specified) may be reused unless `force_new` is true.

App propriétaire

Canvas Tools

Entrées requises

bodyObligatoirestring

The content of the message to be sent.

modestring

Determines whether messages will be created/sent synchronously or asynchronously. 'sync' means the action waits for completion, 'async' means it returns immediately. Defaults to 'sync'.

scopestring

Filters conversations by a specific scope (e.g., 'unread', 'starred', 'archived') to potentially reuse an existing conversation matching this scope and other filter criteria. Affects which conversation is returned or updated if not forcing new.

filterarray

Array of conversation IDs or user IDs. Used with `scope` and `filter_mode` to find an existing conversation to reuse. If a match is found and `force_new` is not true, that conversation is used/updated instead of creating a new one.

subjectstring

The subject of the conversation. Maximum length is 255 characters.

force_newboolean

If true, forces the creation of a new conversation, even if an existing private conversation with the same recipients, scope, and filters is found. If false or not provided, an existing matching conversation may be reused.

recipientsObligatoirearray

Array of recipient IDs. User IDs are numeric strings. Course/group IDs are strings prefixed with 'course_' or 'group_' respectively, followed by the ID (e.g., 'course_123', 'group_456').

filter_modestring

Specifies how the `filter` criteria are combined ('and', 'or'). Used in conjunction with `scope` and `filter` to identify an existing conversation for reuse. 'default' typically implies 'and'.

context_codestring

The course or group ID that provides context for this conversation (e.g., 'course_123', 'group_456'). This associates the conversation with a specific course or group.

attachment_idsarray

Array of attachment IDs from the sender's conversation attachments folder. These are IDs of files previously uploaded by the sender.

media_comment_idstring

Media comment ID of an audio or video file to be associated with this message. This ID refers to a media object previously created.

group_conversationboolean

If true, a single group conversation is created with all recipients. If false or not provided, individual private conversations will be created with each recipient. Ignored if `force_new` is true and a new conversation is created.

Canvas Create Conversation

Description du fournisseur

App propriétaire

Entrées requises

Sortie observable

Configuration et approbation

Tarifs et limites

Skills qui utilisent cette Action

Source officielle