Contacts

Como o nome sugere, os contactos são uma parte essencial do Protocolo — a razão pela qual o protocolo existe é para que possa ter conversas seguras com os seus contactos. Nesta página, vamos nos aprofundar nos diferentes endpoints de contato que você pode usar para gerenciar contatos programaticamente. Veremos como consultar, criar, atualizar e excluir contatos.

The contact model

O modelo de contacto contém todas as informações sobre os seus contactos, tais como o respetivo nome de utilizador, avatar e número de telefone. Ele também contém uma referência à conversa entre você e o contato e informações sobre quando eles estiveram ativos pela última vez no protocolo.

Properties

  • Name
    id
    Type
    string
    Description

    Identificador único do contacto.

  • Name
    username
    Type
    string
    Description

    O nome de utilizador do contacto.

  • Name
    phone_number
    Type
    string
    Description

    O número de telefone do contacto.

  • Name
    avatar_url
    Type
    string
    Description

    O URL da imagem do avatar para o contacto.

  • Name
    display_name
    Type
    string
    Description

    O nome de apresentação do contacto na lista de contactos. Por padrão, este é apenas o nome de utilizador.

  • Name
    conversation_id
    Type
    string
    Description

    Identificador único para a conversa associada ao contacto.

  • Name
    last_active_at
    Type
    timestamp
    Description

    Data e hora de quando o contacto esteve activo pela última vez na plataforma.

  • Name
    created_at
    Type
    timestamp
    Description

    Carimbo de data / hora de quando o contato foi criado.