Contatos
As pessoas e empresas com quem trabalha.
Os Contatos não têm um microserviço próprio. Os seus métodos públicos pertencem ao microserviço account, que também contém os Perfis, e ao microserviço team para os pedidos de amizade. Cada método atua em nome da conta cuja chave de API utiliza.
Grupos, etiquetas, campos personalizados, Mantenha contacto, a verificação de duplicados, a importação e a escolha de um plano não têm hoje método público. Isso faz-se no dashboard.
Envie um pedido a um método com a sua chave:
Um pedido recusado responde com um code negativo e explica o motivo em data. A maioria dos métodos abaixo aceita também um workspace_id opcional, para atuar num espaço de trabalho seu que não seja o principal.
Ler contactos
get_contacts lista os contactos.
_idoucontact_iddevolve um só contacto.searchfiltra a lista por um texto de pesquisa, enamepor um nome.filter_typerestringe a lista, por exemplo aarchived,shared,pinned,favoritesouonline. Se for omitido, lista os contactos ativos juntamente com os pedidos de ligação que estão a aguardar.with_requestsdefinido comotrueacrescenta também os pedidos pendentes, enviados e recebidos, a uma lista filtrada.taglista os contactos que têm uma determinada etiqueta,folder_idlista uma pasta (envie__none__para os contactos que não estão em nenhuma pasta) egroup_idlista os membros de um grupo de contactos.profile_idlê os contactos de outro perfil seu.limit,skipebookmarkpaginam a lista.
Adicionar um contacto
create_contact adiciona uma pessoa à mão. Recebe name e email, que são obrigatórios, e opcionalmente phone, company, job_title e account_type definido como personal ou business, o que poupa a um modelo o trabalho de adivinhar.
- O email é a chave da agenda. Enviar um que já tem devolve o contacto existente em vez de uma segunda cópia.
sourceregista de onde veio o contacto,manualquando não envia nenhum, econtexté uma linha que aparece na atividade do contacto.profile_idarquiva o contacto sob outro perfil seu.- Ninguém é questionado e não é enviado nenhum email. É o mesmo que Adicionar sem convite no dashboard.
Para importar uma lista a partir de código, chame-o uma vez por pessoa.
Pedidos de amizade
add_contact_memberenvia um pedido a outro utilizador do Xuda, encontrado poraccess_emailou porto_uid.get_contact_memberslista os seus pedidos e ligações, cada um com o cartão da outra pessoa.stataceita um estado de pedido, ou vários, para listar.unfriend_contactrecebe umcontact_ide termina a ligação. O contacto continua na sua agenda.
Organizar um contacto
Cada um destes recebe um contact_id.
favorite_contacteunfavorite_contactdefinem e retiram o coração, que é o que a opção Favoritos do Filtro lista.pin_contacteunpin_contactfixam um contacto e retiram a fixação.set_not_contactmove um remetente da lista para Não contactos, para os alertas de um banco, os recibos de uma loja ou um endereço no-reply. O correio dele continua a ser lido como antes.unset_not_contactdevolve-o e mantém-no lá.not_spam_contactmarca um contacto como não sendo spam e confia no seu endereço.set_deep_research_contactativa a pesquisa aprofundada para um contacto, eunset_deep_research_contactdesativa-a e apaga o que ela guardou.generate_contact_avatarapaga as imagens de um contacto e desenha um novo avatar. Não está disponível em contas gratuitas.
Arquivar e eliminar
archive_contactmove um contacto para Arquivado.unarchive_contactdevolve-o.delete_contactelimina um contacto. No dashboard só um contacto arquivado pode ser eliminado, por isso arquive primeiro.
Um contacto eliminado com delete_contact desaparece. O arquivo é o passo a usar quando só quer pôr um contacto de lado.