Pular para o conteúdo

GET /v1/sequences/{id}/enrollments/{enrollmentId}/steps

GET
/v1/sequences/{id}/enrollments/{enrollmentId}/steps
curl --request GET \
--url https://seu-endereco-da-api/v1/sequences/example/enrollments/example/steps \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler sequências (sequences:read).

id
required
string
enrollmentId
required
string
Media typeapplication/json
object
items
required
Array<object>
object
step
required
number
flowId
required
string
flowName
required
string
nullable
runId
required
string
result
required
string
Allowed values: concluida presa falhou em_andamento
startedAt
required
string format: date-time
message
required

Mensagem que decidiu o resultado do passo: a que falhou, senao a presa, senao a mais recente

object
status
required
string
nullable
statusReason
required

Motivo da mensagem presa, como o numero esta desconectado

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

Example

{
"items": [
{
"result": "concluida",
"message": {
"errorProvider": "meta"
}
}
]
}