← InícioFleetPay / Schema

Convite

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

documentostringObrigatório

O documento convidado, somente digitos.

telefonestringOpcional

O celular normalizado. Ausente quando a transportadora ja havia sido convidada.

statusstringObrigatório

convite_enviado — a mensagem saiu. ja_convidada — ja existia convite e nada novo foi enviado. registrado_envio_pendente — o convite ficou registrado mas o envio da mensagem falhou; a FleetPay reenvia, nao repita a chamada.

"convite_enviado" · "ja_convidada" · "registrado_envio_pendente"

convidada_emstringOpcional

Quando o convite foi registrado.

proximo_passostringObrigatório

Em texto, o que acontece a seguir.

Definição JSON Completa

{
  "type": "object",
  "required": [
    "documento",
    "status",
    "proximo_passo"
  ],
  "properties": {
    "documento": {
      "type": "string",
      "description": "O documento convidado, somente digitos."
    },
    "telefone": {
      "type": "string",
      "description": "O celular normalizado. Ausente quando a transportadora ja havia sido convidada."
    },
    "status": {
      "type": "string",
      "enum": [
        "convite_enviado",
        "ja_convidada",
        "registrado_envio_pendente"
      ],
      "description": "`convite_enviado` — a mensagem saiu. `ja_convidada` — ja existia convite e nada novo foi enviado. `registrado_envio_pendente` — o convite ficou registrado mas o envio da mensagem falhou; a FleetPay reenvia, nao repita a chamada."
    },
    "convidada_em": {
      "type": "string",
      "description": "Quando o convite foi registrado."
    },
    "proximo_passo": {
      "type": "string",
      "description": "Em texto, o que acontece a seguir."
    }
  }
}