Pular para o conteúdo

GET /v1/flows/{id}/runs/{runId}

GET
/v1/flows/{id}/runs/{runId}
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).

id
required
string
runId
required
string
Media typeapplication/json
object
id
required
string
contactId
required
string
contactName
required
string
nullable
conversationId
required
string
nullable
source
required
string
status
required
string
result
required
string
Allowed values: concluida presa falhou em_andamento
startedAt
required
string format: date-time
updatedAt
required
string format: date-time
lastError
required
string
nullable
steps
required
Array<object>
object
nodeId
required
string
nodeType
required
string
handle
required

Saída tomada; nula quando o bloco parou ali

string
nullable
outcome
required
string
Allowed values: passou esperando falhou encerrou
reason
required
string
nullable
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
nullable
accountName
required

O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite

string
nullable
removed
required

O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu

boolean
status
required
string
nullable
statusReason
required
string
nullable
errorCode
required
string
nullable
errorReason
required

Mensagem original do provedor, como veio

string
nullable
errorProvider
required

Dono do codigo de erro, quando o codigo veio do provedor

string
nullable
Allowed values: meta telegram
reasonText
required

Explicacao em portugues do dicionario de motivos; nula quando o codigo e desconhecido

string
nullable
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"
}
]
}