Profiles
As caras que você e o seu negócio mostram.
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:
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.
_idouprofile_iddevolve um só perfil.filter_typerestringe a lista:archivedpara perfis arquivados,sharedpara perfis partilhados consigo,favoritespara os marcados com o coração. Se for omitido, lista todos os perfis ativos.account_typerestringe por tipo:personal,businessouvirtual.folder_idlista uma pasta do dashboard, ou__none__para os perfis que não estão em nenhuma pasta.search,limit,skipebookmarkpaginam 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, evirtual_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 ereasonplan_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
canvasnele é recusada.
Arquivar, restaurar e eliminar
archive_account_profilerecebeprofile_ide 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_profiledevolve 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_profileelimina definitivamente um perfil arquivado, juntamente com as conversas que dele dependem. Aceita apenas um perfil arquivado: arquive primeiro, depois elimine.
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.
get_profile_answering_ruleslê as regras de atendimento de uma linha (horário comercial, tempo limite de toque, quem recebe a chamada, reencaminhamento, correio de voz e gravação) e o que o plano atual permite.update_profile_answering_rulesguarda-as. Uma definição que o plano não inclui é recusada em vez de ser ignorada.update_profile_business_identityguarda a identidade comercial no perfil que será o titular do número.