> For the complete documentation index, see [llms.txt](https://multisource.gitbook.io/api-dintegration-multisource/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://multisource.gitbook.io/api-dintegration-multisource/integration/call-lookup.md).

# Call Lookup

Identifie, à partir d’un numéro de téléphone, les informations publiquement disponibles associées (nom, adresse, etc.). Cela est particulièrement utile pour l’identification des appels entrants dans des systèmes tels que :

* Centrales téléphoniques
* CRM
* Systèmes de support/helpdesk

## Intégrations / Modèles

Modèles prêts à l'emploi – aucun développement requis.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>3CX</strong></td><td>Modèle CRM côté serveur – identification de l'appelant directement dans le Web Client 3CX ainsi que dans les applications de bureau et mobiles.</td><td><a href="/files/KkMjPotF8wr9D5bjJzgU">/files/KkMjPotF8wr9D5bjJzgU</a></td><td><a href="/pages/NBXTeztxX8f9jAfmBJLs">/pages/NBXTeztxX8f9jAfmBJLs</a></td></tr><tr><td><strong>D'autres fournisseurs sont en préparation.</strong></td><td></td><td></td><td></td></tr></tbody></table>

## Implémentation propre

Votre système ne figure pas dans la liste, ou vous souhaitez intégrer Call Lookup directement dans votre propre application ? L'API peut être connectée à tout système prenant en charge les appels REST – les sections suivantes détaillent l'authentification, l'endpoint et le format de réponse.

### Authentification avec clé API

Pour accéder à l’API, une clé API est nécessaire.

* La clé API est fournie après un processus [d’onboarding](https://www.multisource.ch/call-lookup-start) réussi.
* La clé API doit être transmise dans l’en-tête de chaque requête.

Exemple:

{% code overflow="wrap" %}

```http
curl --location 'https://api.multisource.ch/v2/search/calllookup?number=+41791234567' \
--header 'Auth-Key: <API-KEY>'
```

{% endcode %}

### Point de terminaison API

## GET /search/calllookup

>

```json
{"openapi":"3.0.1","info":{"title":"multisource•api","version":"v2"},"tags":[{"name":"Search"}],"servers":[{"url":"https://api.multisource.ch/v2","description":"Production - v2"}],"security":[{"auth-key":[]}],"components":{"securitySchemes":{"auth-key":{"type":"apiKey","description":"API Key required for authorized endpoints.","name":"auth-key","in":"header"}},"schemas":{"SearchOutputOfListOfOutputCalllookup":{"type":"object","properties":{"hitCount":{"type":"integer","format":"int32"},"resultCount":{"type":"integer","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OutputCalllookup"}}}},"OutputCalllookup":{"type":"object","properties":{"dwhId":{"type":"string","nullable":true},"companyname":{"type":"string","nullable":true},"firstname":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"houseNumber":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"location":{"type":"string","nullable":true},"category":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"email":{"type":"string"},"url":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"string"},"nullable":true},"mobileNumbers":{"type":"array","items":{"type":"string"},"nullable":true}}}}},"paths":{"/search/calllookup":{"get":{"tags":["Search"],"parameters":[{"name":"number","in":"query","required":true,"schema":{"type":"string"}},{"name":"outputFormat","in":"query","description":"Optional.","schema":{"enum":[1,2],"type":"integer","description":"**Allowed values:**\n- `1` = `Local`\n- `2` = `E164`","format":"int32","default":1}},{"name":"format","in":"query","description":"Optional.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/SearchOutputOfListOfOutputCalllookup"}},"application/json":{"schema":{"$ref":"#/components/schemas/SearchOutputOfListOfOutputCalllookup"}},"text/json":{"schema":{"$ref":"#/components/schemas/SearchOutputOfListOfOutputCalllookup"}}}}}}}}}
```

### Paramètres

<table><thead><tr><th width="144.75390625">Champ</th><th width="87.87109375">Type</th><th width="290.01953125">Description</th><th>Exemple</th></tr></thead><tbody><tr><td><code>number</code></td><td>string</td><td>Le numéro de téléphone au format local (sans indicatif pays) ou au format E.164 (avec +)</td><td><p><code>0791234567</code></p><p><code>+41791234567</code></p></td></tr><tr><td><code>outputFormat</code></td><td>string</td><td><p>Format du numéro de téléphone retourné :</p><ul><li><code>1</code> = Format local (sans indicatif pays)</li><li><code>2</code> = E.164 (avec + et indicatif pays)</li></ul></td><td><code>1</code> = <code>0791234567</code><br><code>2</code> = <code>+41791234567</code></td></tr><tr><td><code>format</code></td><td>string</td><td><p>Format de sortie de la réponse :</p><ul><li><code>json</code> = Données structurées (par défaut) – pour un traitement ultérieur dans votre propre application</li><li><code>html</code> = Extrait HTML prêt à l'emploi</li></ul></td><td><code>json</code><br><code>html</code></td></tr></tbody></table>

### Champs de réponse

#### Champs de niveau racine

<table><thead><tr><th width="145">Champ</th><th width="88">Type</th><th width="290">Description</th><th>Exemple</th></tr></thead><tbody><tr><td><code>hitCount</code></td><td>integer</td><td>Nombre total de résultats dans la base de données pour le numéro de téléphone demandé</td><td><code>1</code></td></tr><tr><td><code>resultCount</code></td><td>integer</td><td>Nombre d'entrées effectivement retournées dans le <code>data</code>-Array</td><td><code>1</code></td></tr><tr><td><code>data</code></td><td>array</td><td>Tableau contenant les entrées d'annuaire trouvées</td><td>voir champs de sortie ci-dessous</td></tr></tbody></table>

#### Champs de sortie

<table><thead><tr><th width="145">Champ</th><th width="88">Type</th><th width="290">Description</th><th>Exemple</th></tr></thead><tbody><tr><td><code>dwhId</code></td><td>string</td><td>ID unique de l'entrée</td><td><code>ABC123456789</code></td></tr><tr><td><code>companyname</code></td><td>string</td><td>Nom de l'entreprise pour les entrées professionnelles</td><td><code>Swisscom Directories AG</code></td></tr><tr><td><code>firstname</code></td><td>string</td><td>Prénom pour les personnes privées</td><td><code>Lara</code></td></tr><tr><td><code>name</code></td><td>string</td><td>Nom de famille pour les personnes privées</td><td><code>Graf</code></td></tr><tr><td><code>street</code></td><td>string</td><td>Nom de la rue</td><td><code>Förrlibuckstrasse</code></td></tr><tr><td><code>houseNumber</code></td><td>string</td><td>Numéro de maison</td><td><code>62</code></td></tr><tr><td><code>zip</code></td><td>string</td><td>Code postal (NPA)</td><td><code>8005</code></td></tr><tr><td><code>location</code></td><td>string</td><td>Nom de la localité</td><td><code>Zürich</code></td></tr><tr><td><code>phoneNumbers</code></td><td>array</td><td>Tableau avec un ou plusieurs numéros de téléphone fixe</td><td><p><code>[</code></p><p><code>“*08001234567",</code></p><p><code>"*0587654321"</code></p><p><code>]</code></p></td></tr><tr><td><code>mobileNumbers</code></td><td>array</td><td>Tableau avec un ou plusieurs numéros de mobile</td><td><p><code>[</code></p><p><code>“*0791234567"</code></p><p><code>]</code></p></td></tr></tbody></table>

#### Marquage opposition à la publicité

Les numéros retournés avec un astérisque en préfixe (`*`) (p. ex. `*0791234567`) sont marqués d'une opposition à la publicité. Le titulaire s'est opposé à l'utilisation de son numéro à des fins publicitaires. Ces numéros ne doivent pas être utilisés pour du démarchage téléphonique. L'astérisque fait actuellement partie de la chaîne du numéro et non d'un champ séparé – veuillez en tenir compte (le traiter séparément) lors du traitement des données.

## Conditions préalables pour des résultats réussis

Le numéro de téléphone indiqué doit être inscrit dans nos annuaires publics (local.ch ou search.ch) et autorisé pour la recherche inversée.

### Numéros de téléphone sous forme de tableaux

* `phoneNumbers` et `mobileNumbers` sont toujours des tableaux, même avec un seul numéro
* Les tableaux vides `[]` signifient qu'aucun numéro de ce type n'est disponible

### Gestion de plusieurs entrées

Un numéro de téléphone peut avoir plusieurs entrées (p. ex. plusieurs personnes dans un ménage ou différents services d'une entreprise). Lorsque plusieurs entrées sont retournées (resultCount > 1), nous recommandons la logique d'affichage suivante pour l'intégration :

#### **Option 1:** Afficher la première entrée

La première entrée du tableau data est généralement l'entrée principale et convient pour un affichage simple dans les systèmes de téléphonie.

#### **Option 2:** Proposer toutes les entrées

Pour les intégrations avancées, toutes les entrées retournées peuvent être affichées dans une liste déroulante ou comme options sélectionnables.

#### Exemple : Résultat avec plusieurs entrées

```json
{
  "id": "123",
  "status": 200,
  "info": [],
  "result": {
    "hitCount": 2,
    "resultCount": 2,
    "data": [
      {
        "dwhId": "ABC1234567890",
        "companyname": "Swisscom Directories AG",
        "firstname": "",
        "name": "",
        "street": "Förrlibuckstrasse",
        "houseNumber": "62",
        "zip": "8005",
        "location": "Zürich",
        "phoneNumbers": [],
        "mobileNumbers": [
          "*079 123 45 67"
        ]
      },
      {
        "dwhId": "CBA0987654321",
        "companyname": "",
        "firstname": "Lara",
        "name": "Graf",
        "street": "Förrlibuckstrasse",
        "houseNumber": "62",
        "zip": "8005",
        "location": "Zürich",
        "phoneNumbers": [],
        "mobileNumbers": [
          "*079 123 45 67"
        ]
      }
    ]
  }
}
```

## Metrics & Usage

**Votre utilisation en un coup d'œil** L'endpoint `metrics/usage` vous permet de consulter à tout moment le nombre de requêtes envoyées et d'éléments retournés pour ce module – ventilé par période. [**En savoir plus**](/api-dintegration-multisource/integration/metrics-and-usage.md)