TriggerChatFlow - Chat App Message Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Você pode chamar esta operação para acionar uma versão publicada de um fluxo que possui um gatilho manual. Você também pode acionar o fluxo a partir da página Gerenciamento de Campanhas de Marketing se o fluxo estiver associado a uma campanha de marketing.
Antes de chamar esta operação, certifique-se de que o fluxo possui um gatilho manual e está publicado.
Se um fluxo com gatilho manual não tiver uma versão publicada, você deve publicá-lo. Em Chat Flow, você pode clicar no nome do fluxo para abrir o canvas e publicar a versão. Alternativamente, você pode chamar a API OnlineFlowVersion para publicar a versão.
Se o seu fluxo contiver componentes que geram custos, como envio de mensagens ou invocações de funções, certifique-se de que você compreende os métodos de cobrança e os preços desses produtos antes de acionar o fluxo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cams:TriggerChatFlow

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FlowCode	string	Sim	O código do fluxo. Visualize o código do fluxo na página Flow Editor.	9ccc41**************************
Data	object	Não	Os parâmetros de entrada em formato chave-valor. As chaves devem corresponder à política de parâmetros de entrada configurada no nó inicial do fluxo. Para visualizar os nomes das variáveis no nó inicial, acesse o Flow Editor, clique no nome do fluxo e abra o canvas de orquestração.	{ "my_biz_data_0": "hi", "my_biz_data_1": "1024" }
Uuid	string	Não	Um ID único personalizado para o evento, utilizado para garantir idempotência. Não inclua semântica de negócio no ID. Após o fluxo ser acionado, você pode recuperar este parâmetro de dentro do fluxo.	c68622e6-5f0d-c8a4-af41-e949c2a7580e
OutId	string	Não	Um número de série personalizado de um sistema externo. Utilize este parâmetro para associar o acionamento a um processo de negócio externo. Após o fluxo ser acionado, você pode recuperar este parâmetro de dentro do fluxo.	8d4acf7e-e360-eb83-6d74-fcf9c4538fda
ClaimTimeMillis	integer	Não	A hora em que o evento ocorre. Este é o momento em que o fluxo é acionado e normalmente é a hora em que a solicitação é criada. Este é um timestamp UNIX em milissegundos.	1731502129000
DiscardTimeMillis	integer	Não	A hora em que o evento expira. Se você especificar este parâmetro, o acionamento será cancelado se a solicitação não for processada antes dessa hora. Este é um timestamp UNIX em milissegundos.	1731502729000

Nenhum.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AccessDeniedDetail	string	Detalhes sobre o erro de acesso negado.	None
RequestId	string	O ID da solicitação.	90E63D28-E31D-1EB2-8939-A94866411B2O
Message	string	A mensagem de erro.	None
Data	object	Os dados retornados.
Code	string	O código de status.	OK
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Message": "None",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.