Profiles
Les visages que vous et votre entreprise montrez.
Profils propose six méthodes publiques pour les profils eux-mêmes : lister, créer, modifier, archiver, restaurer et supprimer. Une méthode de plus définit les profils auxquels appartient un élément, et trois relèvent de Téléphone et couvrent les règles de réponse et l'identité professionnelle d'un profil. Chacune agit pour le compte dont vous utilisez la clé API.
Choisir un forfait Profils, inviter un membre, choisir l'assistant d'un profil et associer un numéro n'ont aujourd'hui aucune méthode publique. Cela se fait dans le tableau de bord.
Envoyez une requête à une méthode avec votre clé :
Une requête refusée renvoie un code négatif et en donne la raison dans data. Chaque méthode accepte aussi un workspace_id facultatif, pour agir dans un espace de travail dont vous êtes propriétaire autre que votre espace principal.
Lire les profils
get_account_profiles liste les profils de l'espace de travail, du plus récemment modifié au plus ancien.
_idouprofile_idrenvoie un seul profil.filter_typerestreint la liste :archivedpour les profils archivés,sharedpour les profils partagés avec vous,favoritespour ceux marqués d'un cœur. Sans ce paramètre, la liste contient tous les profils actifs.account_typerestreint par type :personal,businessouvirtual.folder_idliste un dossier du tableau de bord, ou__none__pour les profils sans dossier.search,limit,skipetbookmarkpaginent et filtrent la liste.
Créer un profil
create_account_profile prend un profile_name et un account_type, et facultativement un profile_signature (la description), une image et un avatar, ainsi qu'un email_account_id pour associer une boîte mail connectée.
- Un profil virtuel accepte aussi
virtual_character, la description à partir de laquelle son portrait est dessiné, etvirtual_traits, un choix pour chacun de l'âge, du genre, de l'origine ethnique et de l'apparence. Il est refusé si le forfait Profils de l'espace de travail n'inclut pas les profils virtuels (Starter et supérieurs) ou si le compte n'a pas d'abonnement payant, et tant que le compte n'a pas été vérifié. - Un profil personnel d'un compte personnel, ou un profil professionnel d'un compte professionnel, démarre avec l'image et l'avatar du compte si vous n'en envoyez pas.
- Un espace de travail qui contient déjà autant de profils que son forfait le permet refuse un nouveau profil avec
code-62 etreasonplan_cap. Il conserve les profils qu'il a. Le profil principal avec lequel un compte ou un espace de travail démarre n'est jamais refusé.
Modifier un profil
update_account_profile prend l'_id du profil et tous les champs que vous voulez modifier : le nom, la description, l'image et l'avatar, email_account_id, account_type, le personnage et les traits virtuels, ainsi que registered_apps et registered_mini_apps, qui déterminent les modules qui obtiennent un onglet sur chaque contact du profil (registered_apps est la liste ordonnée complète).
- Passer un profil en virtuel demande les mêmes conditions que d'en créer un.
- Un profil qui a été partagé avec vous est une copie : son propriétaire organise son canevas, donc une modification de
canvassur ce profil est refusée.
Archiver, restaurer et supprimer
archive_account_profileprendprofile_idet déplace le profil dans Archivé. Le profil principal est refusé. Si le profil était celui utilisé dans cet espace de travail, l'espace de travail revient à son profil principal.unarchive_account_profileramène un profil archivé. Il compte de nouveau dans la limite du forfait, donc un espace de travail plein le refuse. Un profil arrivé avec un partage d'équipe ne peut pas être restauré de cette façon.delete_account_profilesupprime définitivement un profil archivé, ainsi que les conversations qui en dépendent. Il n'accepte qu'un profil archivé : archivez d'abord, puis supprimez.
Un profil supprimé avec delete_account_profile est perdu, tout comme les conversations qui lui sont associées. Archiver est l'étape à utiliser quand vous voulez seulement écarter un profil.
Définir les profils auxquels appartient un élément
update_entity_account_profiles prend l'_id de l'élément et une liste account_profiles non vide, et définit les profils auxquels cet élément appartient. Elle fonctionne sur un contact, une conversation, un assistant IA, un agent IA et une mini-app, et refuse tout autre type d'élément.
La ligne téléphonique d'un profil
Trois méthodes de Téléphone prennent un profil. Elles sont listées avec les autres méthodes de Téléphone, et un profil est le moyen de retrouver son numéro.
get_profile_answering_ruleslit les règles de réponse d'une ligne (horaires d'ouverture, délai de sonnerie, qui est appelé, transfert, messagerie vocale et enregistrement) et ce que le forfait actuel permet.update_profile_answering_rulesles enregistre. Un réglage que le forfait n'inclut pas est refusé au lieu d'être ignoré.update_profile_business_identityenregistre l'identité professionnelle sur le profil qui sera propriétaire du numéro.