Comment récupérer les liens personnalisés dans Zoho

Les liens personnalisés dans Zoho CRM peuvent être récupérés via un endpoint de paramètres dédié qui accepte un paramètre de module et retourne les liens configurés pour ce module.

Pourquoi c'est important

Lors de la création d'intégrations ou de workflows assistés par IA sur Zoho CRM, vous avez souvent besoin d'afficher des liens de navigation directs vers des enregistrements ou des modules spécifiques. Savoir comment interroger l'endpoint de paramètres des liens personnalisés — et comment ces liens sont assemblés et retournés à l'utilisateur final — vous permet d'intégrer des liens contextuels profonds dans des tableaux de bord, des interfaces de chat ou des outils d'automatisation sans coder les URL en dur.

Étape par étape

Étape 1. Envoyez une requête GET vers l'endpoint /settings/custom_links dans Zoho CRM, en passant le nom du module cible comme paramètre m (mappé en interne à module). Il s'agit de l'opération dédiée à la récupération des configurations de liens personnalisés dans la catégorie Paramètres supplémentaires. ^[7]

GET /settings/custom_links?module=<ModuleName>

Étape 2. La signature de la méthode sous-jacente ressemble à ceci — votre couche d'intégration appelle getcustomlinks(m), où m est la chaîne du module (par exemple, "Leads" ou "Contacts"). Le client émet la requête avec {"module": m} comme paramètre de requête. ^[7]

def get_custom_links(self, m: str):
    return self.c.request("GET", "/settings/custom_links", {"module": m})

Étape 3. Une fois que vous disposez du résultat brut de l'API, faites-le passer par la couche de construction des liens. La fonction buildzoholinks accepte le résultat de l'outil, le nom de l'outil, le dictionnaire de paramètres (qui doit contenir une clé "module"), le type d'application et l'identifiant du centre de données (dc). Pour les enregistrements CRM, le modèle d'URL suit https://crm.zoho.{dc}/crm/tab/{Module}/{RecordId}. ^[1]

Étape 4. La valeur dc (centre de données) détermine quel domaine régional est utilisé. Lorsque dc vaut "com", l'URL de base se résout en https://crm.zoho.com ; pour toute autre région, elle devient https://crm.zoho.{dc}. Si votre organisation dispose d'un identifiant d'organisation CRM configuré, le chemin est en outre préfixé par /org{crmorgid}. ^[1]

Étape 5. Après l'exécution de buildzoholinks, chaque entrée de la liste retournée est un dictionnaire avec trois clés : name, url et type. Dans une interface de chat ou d'assistant, celles-ci sont affichées sous forme de liens profonds étiquetés au format 🔗 {name}: {url} et ajoutées au message de l'assistant sous un en-tête « Ouvrir dans Zoho : ». ^{[2] [3]}

Étape 6. Les liens assemblés sont également injectés dans le payload de la réponse API sous la clé "links", aux côtés de sessionid, response et toolresult. Les consommateurs en aval peuvent lire response_data["links"] pour afficher ou traiter les URL indépendamment du texte formaté. ^[5]

Étape 7. Dans les contextes de streaming (par exemple, l'endpoint /api/chat/stream), le même appel buildzoholinks est effectué après l'exécution de chaque action en lecture seule. L'objet de connexion fournit les valeurs dc, crmorgid, deskorgid et desk_portal, avec "com" comme valeur par défaut si le dictionnaire de connexion est absent. ^{[6] [8]}

Erreurs courantes

• Paramètre de module manquant. L'appel getcustomlinks nécessite une chaîne m non vide. Passer un nom de module vide ou incorrect retournera soit aucun résultat, soit une erreur API. Validez toujours le nom du module par rapport à la liste des modules actifs de votre CRM avant d'appeler l'endpoint. ^[7]

• Valeur de centre de données incorrecte. Si dc est laissé à "com" alors que votre organisation se trouve sur un centre de données EU ou IN, chaque lien généré pointera vers le mauvais domaine. Assurez-vous que la valeur dc est extraite de la configuration de connexion stockée plutôt que codée en dur. ^{[1] [6]}

• Confusion entre les liens Desk et CRM. La fonction buildzoholinks se ramifie selon apptype. Si apptype est défini sur "desk" alors que vous souhaitez des liens CRM, les URL de sortie suivront le modèle Desk (https://desk.zoho.{dc}/agent/{portal}/tickets/details/{TicketId}) au lieu du modèle d'onglet CRM. ^[1]

• Liens de repli au lieu de liens d'enregistrement. Lorsqu'aucun identifiant d'enregistrement spécifique ne peut être extrait du résultat de l'outil, la fonction se replie sur des URL de vue liste génériques telles que /tickets, /contacts ou /accounts. Si vous voyez des liens de vue liste au lieu de liens profonds au niveau de l'enregistrement, vérifiez que le résultat de l'outil contient les champs d'identifiant d'enregistrement attendus. ^[4]

Ce qu'il faut vérifier

• Confirmez que le paramètre module passé à /settings/custom_links correspond exactement au nom API du module dans votre organisation Zoho CRM (sensible à la casse). ^[7]
• Vérifiez que la valeur dc dans votre configuration de connexion correspond à la région du centre de données réel de votre organisation afin que toutes les URL générées se résolvent correctement. ^[1]
• Après avoir récupéré les liens, inspectez le tableau "links" dans le payload de la réponse pour vous assurer que chaque entrée contient un name, une url et un type valides avant de les afficher dans votre interface. ^[5]

---

*Beam Help fournit des conseils d'experts indépendants sur les produits Zoho et ne constitue pas le support officiel de Zoho.*