← InicioFleetPay / Schema

Convite

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

documentostringObligatorio

Documento invitado, solo dígitos.

telefonestringOpcional

Móvil normalizado. Ausente cuando el transportista ya había sido invitado.

statusstringObligatorio

convite_enviado — se envió el mensaje. ja_convidada — ya existía una invitación y no se envió nada nuevo. registrado_envio_pendente — se registró la invitación, pero falló el envío del mensaje; FleetPay vuelve a enviarlo, por lo que no debe repetir la solicitud.

"convite_enviado" · "ja_convidada" · "registrado_envio_pendente"

convidada_emstringOpcional

Cuándo se registró la invitación.

proximo_passostringObligatorio

Texto que describe lo que ocurre a continuación.

Definición JSON Original (Descripciones en Portugués)

{
  "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."
    }
  }
}