Saltar para o conteúdo

Contatos

As pessoas e empresas com quem trabalha.

Abrir Contatos
Verificado com o painel em 20 de novembro de 2026

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:

curl -s https://xuda.ai/cpi/create_contact \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","name":"Dana Levi","email":"[email protected]","company":"Levi Studio"}'
const res = await fetch('https://xuda.ai/cpi/create_contact', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    name: 'Dana Levi',
    email: '[email protected]',
    company: 'Levi Studio',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/create_contact',
    json={
        'api_key': 'YOUR_API_KEY',
        'name': 'Dana Levi',
        'email': '[email protected]',
        'company': 'Levi Studio',
    },
)

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.

  • _id ou contact_id devolve um só contacto.
  • search filtra a lista por um texto de pesquisa, e name por um nome.
  • filter_type restringe a lista, por exemplo a archived, shared, pinned, favorites ou online. Se for omitido, lista os contactos ativos juntamente com os pedidos de ligação que estão a aguardar.
  • with_requests definido como true acrescenta também os pedidos pendentes, enviados e recebidos, a uma lista filtrada.
  • tag lista os contactos que têm uma determinada etiqueta, folder_id lista uma pasta (envie __none__ para os contactos que não estão em nenhuma pasta) e group_id lista os membros de um grupo de contactos.
  • profile_id lê os contactos de outro perfil seu. limit, skip e bookmark paginam 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.
  • source regista de onde veio o contacto, manual quando não envia nenhum, e context é uma linha que aparece na atividade do contacto.
  • profile_id arquiva 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_member envia um pedido a outro utilizador do Xuda, encontrado por access_email ou por to_uid.
  • get_contact_members lista os seus pedidos e ligações, cada um com o cartão da outra pessoa. stat aceita um estado de pedido, ou vários, para listar.
  • unfriend_contact recebe um contact_id e termina a ligação. O contacto continua na sua agenda.

Organizar um contacto

Cada um destes recebe um contact_id.

Arquivar e eliminar

Eliminar não pode ser desfeito

Um contacto eliminado com delete_contact desaparece. O arquivo é o passo a usar quando só quer pôr um contacto de lado.

Que tal está este guia?

Última atualização em 16 de novembro de 2026