GET /v1/flows/{id}/runs/{runId}
GET
/v1/flows/{id}/runs/{runId}
const url = 'https://seu-endereco-da-api/v1/flows/example/runs/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/flows/example/runs/example \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler fluxos (flows:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
runId
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
contactId
required
string
contactName
required
string
conversationId
required
string
source
required
string
status
required
string
result
required
string
startedAt
required
string format: date-time
updatedAt
required
string format: date-time
lastError
required
string
steps
required
Array<object>
object
nodeId
required
string
nodeType
required
string
handle
required
Saída tomada; nula quando o bloco parou ali
string
outcome
required
string
reason
required
string
at
required
string format: date-time
messageIds
required
Array<string>
messages
required
Array<object>
object
id
required
string
nodeId
required
Bloco que criou a mensagem
string
preview
required
string
channelId
required
string
channel
required
object
name
required
O nome que o cliente deu ao canal na plataforma
string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required
O numero ou @ da conta no provedor
string
accountName
required
O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite
string
removed
required
O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu
boolean
status
required
string
statusReason
required
string
errorCode
required
string
errorReason
required
Mensagem original do provedor, como veio
string
errorProvider
required
Dono do codigo de erro, quando o codigo veio do provedor
string
reasonText
required
Explicacao em portugues do dicionario de motivos; nula quando o codigo e desconhecido
string
createdAt
required
string format: date-time
formAnswers
required
Respostas do formulário que a execução recebeu, por nome da pergunta
object
key
additional properties
string
Example
{ "result": "concluida", "steps": [ { "outcome": "passou" } ], "messages": [ { "errorProvider": "meta" } ]}