Saltar para o conteúdo

Profiles

As caras que você e o seu negócio mostram.

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

Os Perfis têm seis métodos públicos para os próprios perfis: listar, criar, alterar, arquivar, restaurar e eliminar. Mais um define a que perfis pertence um item, e três pertencem ao Phone e tratam das regras de atendimento e da identidade comercial de um perfil. Cada método atua em nome da conta cuja chave de API utiliza.

Escolher um plano de Perfis, convidar um membro, escolher o assistente de um perfil e associar um número 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_account_profile \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","profile_name":"Support","account_type":"business"}'
const res = await fetch('https://xuda.ai/cpi/create_account_profile', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    profile_name: 'Support',
    account_type: 'business',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/create_account_profile',
    json={
        'api_key': 'YOUR_API_KEY',
        'profile_name': 'Support',
        'account_type': 'business',
    },
)

Um pedido recusado responde com um code negativo e explica o motivo em data. Todos os métodos aceitam também um workspace_id opcional, para atuar num espaço de trabalho seu que não seja o principal.

Ler perfis

get_account_profiles lista os perfis do espaço de trabalho, dos alterados mais recentemente para os mais antigos.

  • _id ou profile_id devolve um só perfil.
  • filter_type restringe a lista: archived para perfis arquivados, shared para perfis partilhados consigo, favorites para os marcados com o coração. Se for omitido, lista todos os perfis ativos.
  • account_type restringe por tipo: personal, business ou virtual.
  • folder_id lista uma pasta do dashboard, ou __none__ para os perfis que não estão em nenhuma pasta. search, limit, skip e bookmark paginam e pesquisam a lista.

Criar um perfil

create_account_profile recebe um profile_name e um account_type, e opcionalmente um profile_signature (a descrição), uma imagem e um avatar, e um email_account_id para associar uma caixa de correio ligada.

  • Um perfil virtual recebe também virtual_character, a descrição a partir da qual o seu retrato é desenhado, e virtual_traits, uma escolha para cada um de idade, género, etnia e aspeto. É recusado, a menos que o plano de Perfis do espaço de trabalho inclua perfis virtuais (Starter e superiores) ou a conta tenha uma subscrição paga, e que a conta tenha sido verificada.
  • Um perfil pessoal de uma conta pessoal, ou um perfil comercial de uma conta comercial, começa com a imagem e o avatar da própria conta quando não envia nenhum.
  • Um espaço de trabalho que já tenha tantos perfis quantos o seu plano permite recusa um novo com code -62 e reason plan_cap. Mantém os perfis que tem. O perfil principal com que uma conta ou um espaço de trabalho começa nunca é recusado.

Alterar um perfil

update_account_profile recebe o _id do perfil e qualquer um dos campos que quer alterar: o nome, a descrição, a imagem e o avatar, email_account_id, account_type, a personagem e os traços virtuais, e registered_apps e registered_mini_apps, que decidem os módulos que ganham um separador em cada contacto do perfil (registered_apps é a lista completa e ordenada).

  • Passar um perfil a virtual exige as mesmas condições que criar um.
  • Um perfil que foi partilhado consigo é uma cópia: o seu proprietário organiza a respetiva tela, por isso uma alteração a canvas nele é recusada.

Arquivar, restaurar e eliminar

  • archive_account_profile recebe profile_id e move o perfil para Arquivado. O perfil principal é recusado. Se o perfil era o que estava em uso nesse espaço de trabalho, o espaço de trabalho volta ao seu perfil principal.
  • unarchive_account_profile devolve um perfil arquivado. Volta a contar para o limite do plano, por isso um espaço de trabalho cheio recusa-o. Um perfil que veio com uma partilha de equipa não pode ser restaurado desta forma.
  • delete_account_profile elimina definitivamente um perfil arquivado, juntamente com as conversas que dele dependem. Aceita apenas um perfil arquivado: arquive primeiro, depois elimine.
Eliminar não pode ser desfeito

Um perfil eliminado com delete_account_profile desaparece, tal como as conversas associadas a ele. O arquivo é o passo a usar quando só quer pôr um perfil de lado.

Definir a que perfis pertence um item

update_entity_account_profiles recebe o _id do item e uma lista account_profiles não vazia, e define a que perfis esse item pertence. Funciona num contacto, numa conversa, num assistente de IA, num agente de IA e numa mini-aplicação, e recusa qualquer outro tipo de item.

A linha telefónica de um perfil

Três métodos do Phone recebem um perfil. Estão listados com os restantes métodos do Phone, e um perfil é a forma como encontram o seu número.

Que tal está este guia?

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