Centre d'aideIntégrations

Pour: Administrateurs

Trouvez les étuis avec une clé de hub

Répertoriez les dossiers de votre plateforme, ouverts ou fermés, recherchez-les par identifiant de balise ou par titre, et retrouvez l'identifiant d'un dossier dans votre propre logiciel.

Dans cet article7 sections

Avant de commencer

Cette page décrit les appels que fait une clé de hub pour trouver des cas spécifiques. Les parcours sont indiqués sous https://prd-api-app.caseactive.com/v1/<hub id>.

Appels

AppelCe que cela fait
GET /casesAffiche les affaires ouvertes ou fermées de votre centre de traitement.
GET /cases/searchRecherchez les cas en fonction de l’identifiant de la catégorie ou du titre.
GET /whoamiLise les paramètres de votre hub, comme les types de cas et les pages de données associées.
GET /rolesListe des rôles de votre hub.
GET /stagesListe les étapes de votre hub.
GET /schemasLisez les informations concernant votre utilisateur, ainsi que les champs personnalisés de l’utilisateur.

La clé “hub” fonctionne comme votre assistant virtuelAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel.. Elle est présente dans chaque cas, ce qui permet à ces appels de atteindre tous les cas gérés par votre hub. Les deux exemples de cas inclus montrent cela de manière concrète.

Une clé de hub ne peut pas créer de cas : POST /cases renvoie le code 403 pour HostCreateCaseNotEnabledException. Pour créer des cas à partir de votre logiciel, utilisez une clé de gestion ; voir Créer et mettre à jour les cas avec une clé de gestion.

Liste des cas

ParamètreCe que cela faitRequisDéfaut
status1 pour les affaires ouvertes, 0 pour les affaires closes.Non.1
limitCombien de cas peuvent être stockés par une page, jusqu’à 1000.Non.20
start_keyLe startKey de la page précédenteNon.Première page
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
        "title": "Jane Sample auto accident",
        "team": {
          "cu-7e6d5c4b3a2f10": "role::bots",
          "cu-4f1c2a9e8b7d60": "role::clients",
          "cu-9d8c7b6a5f4e30": "role::staff"
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1"
  }
}
  • Les cas sont classés par ordre de ID du tagID de l'étiquette Une étiquette permanente que vous attribuez à un boîtier, telle que rear-end-2026, également appelée ID de référence et utilisée dans les importations., de Z à A, et non par date.
  • case_ref_id est l’ID de votre hub. Il s’agit de deux points et puis l’ID de la balise de la pièce.
  • team attribue à chaque personne concernée par l’affaire sa rôleRôle Un ensemble d'autorisations qui détermine ce qu'une personne peut voir et faire sur un dossier, qu'il s'agisse de membres du personnel ou de clients.. Il n’y a pas de noms pour ces personnes. Pour obtenir les noms des personnes concernées, consultez l’équipe de l’affaire ; voir également Lecture et mise à jour des détails de l’affaire avec une clé de hub.
  • Bien que de nombreux cas restent à traiter, cette page contient également les valeurs nextLink, qui représentent l’adresse complète de la page suivante, ainsi que les valeurs startKey. Appelons nextLink, ou envoyons startKey en tant que start_key, jusqu’à ce qu’une page nous renvoie des données sans ces éléments.
  • Les cas qui sont supprimés ne sont pas inclus dans le tableau. Ainsi, une page peut contenir moins de limit cas, tout en ayant encore des cas en attente d’être traités. Il convient de se baser sur le nombre indiqué par nextLink, et non sur le nombre de cas réellement présents.
  • Le titre et l’état d’un cas peuvent varier de quelques secondes à l’autre.

Recherche de cas

GET /cases/search correspond aux mots présents n’importe où dans l’ID des balises d’une phrase. Il peut également être utilisé à partir du début d’un mot dans le titre de la phrase. Ce format permet de corriger de petits erreurs de frappe. Il ne cherche pas les descriptions des éléments concernés.

ParamètreCe que cela faitRequisDéfaut
queryLes mots à rechercher : envoyez * pour chaque cas.Oui.—
status1 pour les affaires ouvertes, 0 pour les affaires closes.Non.1
limitCombien de résultats une page peut contenir, jusqu’à 250.Non.20
pageQuelle page des résultats, numéro 1 ?Non.1
sort_byIl s’agit d’un champ numérique et d’une direction, comme par exemple created_on:desc. Ce champ peut prendre les valeurs created_on, date_opened, last_activity, updated_on, users_ct et case_status.Non.Le meilleur match en premier.
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "found": 1,
    "page": 1,
    "hits": [
      {
        "document": {
          "case_id": "cc-1a2b3c4d5e6f70",
          "ref_id": "rear-end-2026",
          "title": "Jane Sample auto accident",
          "case_status": 1,
          "case_type": "general",
          "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
          "date_opened": 1772668800,
          "created_on": 1791043509,
          "last_activity": 1791050112,
          "users_ct": 3
        }
      }
    ],
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026"
  }
}
  • Chaque coup réussi… document Il contient l’identifiant de l’affaire, l’identifiant simple de l’affaire, le titre, l’état de l’affaire. Type de casType de cas Une catégorie pour les cas particuliers, telle que « général », utilisée pour cibler les automatisations sur les cas appropriés., ÉtapeScène Une étape du traitement d'un dossier, telle que la prise en charge ou l'envoi d'une demande, que le cabinet nomme et décrit et qui apparaît sur la page du dossier., Combien de personnes y participent ? De plus, les dates correspondent aux unités Unix, en secondes UTC.
  • found indique le nombre de cas qui correspondent à la condition recherchée. Passez en revue ces cas avec page ; il n’y a pas de nextLink.
  • Un cas peut être recherché en quelques secondes, dès qu’il y a un changement.

Recherche d'un dossier par son identifiant de balise

Il n’y a pas de méthode précise pour trouver un élément en fonction de son ID de tag. Il faut donc effectuer une recherche, puis sélectionner l’élément qui correspond à cette recherche. document.ref_id C’est exactement votre ID de tag. En effet, une recherche permet également de trouver des correspondances similaires, comme… rear-end-2025. Recherche par recherche. status=1, Ensuite status=0, Pour couvrir les cas ouverts et fermés.

Une fois que vous avez obtenu l’identifiant de l’affaire, tous les appels concernant cette affaire utilisent cet identifiant. Veuillez consulter la section “Lire et mettre à jour les informations sur l’affaire avec une clé hub”.

Paramètres de votre hub

AppelCe que cela répond
GET /whoamiL’identifiant de l’utilisateur qui possède la clé, le nom de votre hub, les types de cas qu’il peut gérer, ainsi que les sections sur lesquelles il est disponible. host_default_schemas, Ses cases de cas et de champ d’utilisateur
GET /rolesChaque rôle, y compris celui de l’assistant virtuel, comprend les attributs role::bots, role_id, name, description, color et reads_notes. Il s’agit donc d’un rôle capable de lire les notes.
GET /stagesChaque étape, de la première à la dernière, avec stage_id, name, description et order.
GET /schemasdefault_schemas, les pages concernant le cas de votre hub et les champs personnalisés par l’utilisateur. Chaque page contient les clés, les labels et les types des champs correspondants.

Aucune de ces pages ne répond à toutes les questions en même temps.

Si un appel est refusé

StatutmessagePourquoi
400SchemaFieldsExceptionUn paramètre manque ou est inválue. Par exemple, un query vide, ou un status autre que 0 ou 1. Le errors sert à désigner ce paramètre.
400InvalidStartKeyExceptionL’élément start_key provient d’une autre liste.
400SearchParameterExceptionLa recherche a refusé d’accepter un paramètre, comme par exemple… sort_by Sur un champ de texte ou quelque chose du genre. limit Plus de 250. reason Il indique quel chec.
403HostCreateCaseNotEnabledExceptionUn hub key a essayé de créer une situation particulière.

Pour les corps d’erreur et le reste des codes, veuillez consulter la section Gestion des erreurs et des codes de statut.

Articles connexes

Comprendre les possibilités de l'APIDécouvrez ce que permettent chacune une clé de gestion et une clé de hub, pourquoi chaque clé agit comme un assistant virtuel et où trouver la liste technique complète.IntégrationsConsultez et mettez à jour les détails du dossier à l'aide d'une clé de hub.Consultez les détails d'un dossier et de l'équipe, et modifiez les détails que l'administrateur autorise le rôle de l'assistant virtuel à modifier, tels que l'étape ou un champ personnalisé.IntégrationsCréer et mettre à jour des dossiers avec une clé de gestionRépertoriez, créez, consultez, mettez à jour et supprimez les dossiers de votre hub depuis votre propre logiciel, y compris leur étape et leurs champs personnalisés.IntégrationsGérer les erreurs et les codes d'état de l'APILisez le corps de l'erreur, ce que signifient les codes 400, 401, 403, 404, 500 et 503, et pourquoi un élément que votre clé ne peut pas voir renvoie la réponse 404.Intégrations