Lookup

Vous pouvez utiliser ce point de terminaison pour formater et vérifier les numéros de téléphone. Vérifiez la validité d'un numéro de téléphone, à quel réseau mobile un numéro de téléphone appartient, formatez un numéro de téléphone au format national et international ou vérifiez si un numéro de téléphone existe et est connecté au réseau mobile.

Paramètres

Toutes les requêtes listées ci-dessous ne nécessitent que le numéro de téléphone comme paramètre :

  • Name
    number
    Type
    string
    Description

    Le numéro à interroger. Plusieurs numéros doivent être séparés par des virgules. Vous pouvez entrer presque n'importe quel format - notre API formate automatiquement le numéro correctement.


GET/api/lookup/format

Format

Interrogez le format national et international de n'importe quel numéro de téléphone mobile. Vous recevrez également des informations sur l'opérateur de réseau associé au numéro (sans informations de portabilité).

Requête

GET
/api/lookup/format
curl "https://gateway.seven.io/api/lookup/format?number=4917612345678" \
  -H "X-Api-Key: VOTRE_CLÉ_API" \
  -H "Accept: application/json"

Réponse

{
    "success": true,
    "national": "0176 12345678",
    "international": "+4917612345678",
    "international_formatted": "+49 176 12345678",
    "country_name": "Germany",
    "country_code": "49",
    "country_iso": "DE",
    "carrier": "O2",
    "network_type": "mobile"
}

GET/api/lookup/rcs

Capacités RCS

Vous pouvez utiliser ce point de terminaison pour interroger la capacité RCS d'un numéro de téléphone. Avant d'envoyer un RCS, vous devriez toujours interroger d'abord les capacités d'un numéro de téléphone et mettre en cache le résultat si nécessaire.

Paramètres optionnels

  • Name
    from
    Type
    string
    Description

    Pour vérifier les capacités RCS d'un numéro de téléphone, l'identifiant d'agent respectif est toujours requis. Par défaut, notre API utilise le premier ID d'expéditeur RCS de votre compte. Vous pouvez utiliser un agent différent avec ce paramètre.

Requête

GET
/api/lookup/rcs
curl "https://gateway.seven.io/api/lookup/rcs?number=4917612345678" \
  -H "X-Api-Key: VOTRE_CLÉ_API" \
  -H "Accept: application/json"

Réponse

{
  "success": true,
  "national": "0176 12345679",
  "international": "+49176123456789",
  "international_formatted": "+49 179 123456789",
  "country_name": "Germany",
  "country_code": "49",
  "country_iso": "DE",
  "carrier": "O2",
  "network_type": "mobile",
  "rcs_capabilities": [
    "RICHCARD_STANDALONE",
    "ACTION_CREATE_CALENDAR_EVENT",
    "ACTION_DIAL",
    "ACTION_OPEN_URL",
    "ACTION_SHARE_LOCATION",
    "ACTION_VIEW_LOCATION",
    "RICHCARD_CAROUSEL"
  ]
}

Aperçu de toutes les fonctionnalités

FonctionnalitéDescription
FEATURE_UNSPECIFIEDNon spécifié.
REVOCATIONSi cette fonctionnalité est prise en charge, vous pouvez révoquer un message envoyé avant qu'il ne soit livré.
RICHCARD_STANDALONERich Cards autonomes
RICHCARD_CAROUSELCarrousel de Rich Cards
ACTION_CREATE_CALENDAR_EVENTL'action suggérée pour créer un événement de calendrier.
ACTION_DIALAction suggérée pour composer un numéro.
ACTION_OPEN_URLL'action suggérée pour ouvrir une URL.
ACTION_SHARE_LOCATIONAction suggérée pour partager la localisation.
ACTION_VIEW_LOCATIONAction suggérée pour voir une localisation dans une app de carte.

GET/api/lookup/hlr

HLR

Obtenez des informations détaillées sur un numéro de téléphone mobile via une requête dans la base de données HLR. La requête est possible pour les numéros de presque tous les pays/réseaux dans le monde.

Requête

GET
/api/lookup/hlr
curl "https://gateway.seven.io/api/lookup/hlr?number=4917612345678" \
  -H "X-Api-Key: VOTRE_CLÉ_API" \
  -H "Accept: application/json"

Réponse

{
    "status": true,
    "status_message": "success",
    "lookup_outcome": true,
    "lookup_outcome_message": "success",
    "international_format_number": "4917612345678",
    "international_formatted": "+49 176 12345678",
    "national_format_number": "0176 12345678",
    "country_code": "DE",
    "country_name": "Germany",
    "country_prefix": "49",
    "current_carrier":
    {
        "network_code": "26207",
        "name": "Telefonica Germany GmbH & Co. OHG",
        "country": "DE",
        "network_type": "mobile"
    },
    "original_carrier":
    {
        "network_code": "26207",
        "name": "Telefonica Germany GmbH & Co. OHG",
        "country": "DE",
        "network_type": "mobile"
    },
    "valid_number": "valid",
    "reachable": "unknown",
    "ported": "assumed_not_ported",
    "roaming": "not_roaming",
    "gsm_code": null,
    "gsm_message": null
}

GET/api/lookup/mnp

MNP

Utilisez notre API MNP (Mobile Number Ported) pour interroger l'opérateur de réseau de n'importe quel numéro de téléphone international.

Requête

GET
/api/lookup/mnp
curl "https://gateway.seven.io/api/lookup/mnp?number=4917612345678" \
  -H "X-Api-Key: VOTRE_CLÉ_API" \
  -H "Accept: application/json"

Réponse

{
    "success": true,
    "code": 100,
    "price": 0.005,
    "mnp":
    {
        "country": "DE",
        "number": "+4917612345678",
        "national_format": "0176 12345678",
        "international_formatted": "+49 176 12345678",
        "network": "Telekom Deutschland GmbH",
        "mccmnc": "26201",
        "isPorted": true,
        "network_type": "mobile"
    }
}

GET/api/lookup/cnam

CNAM

Vous pouvez utiliser CNAM Lookup pour interroger le nom de l'ID de l'appelant pour n'importe quel numéro de téléphone dans le monde. Veuillez noter qu'il pourrait ne pas y avoir d'entrée pour chaque numéro de téléphone. Comme les données sont compilées à partir de diverses sources, des emplacements géographiques, des noms d'entreprises ou l'opérateur de réseau peuvent être stockés ici.

Requête

GET
/api/lookup/cnam
curl "https://gateway.seven.io/api/lookup/cnam?number=4917612345678" \
  -H "X-Api-Key: VOTRE_CLÉ_API" \
  -H "Accept: application/json"

Réponse

{
	"success": "true",
	"code": "100",
	"number": "4917612345678",
	"name": "GERMANY"
}

Couverture

CNAM est à l'origine une fonctionnalité réseau nord-américaine. Pour les numéros situés dans le NANP (indicatif pays +1), les opérateurs gèrent eux-mêmes le nom de l'ID de l'appelant : le name renvoyé correspond donc généralement au titulaire réel de la ligne, c'est-à-dire un nom de personne ou d'entreprise.

En dehors du NANP, il n'existe pas de base de noms équivalente au niveau du réseau. Les données sont compilées à partir de diverses sources : pour les numéros internationaux, la réponse contient donc souvent une désignation géographique (comme dans l'exemple ci-dessus : GERMANY), un nom d'entreprise disponible publiquement ou l'opérateur de réseau. Une requête internationale renvoie donc presque toujours une valeur, mais cette valeur n'est pas nécessairement le nom du titulaire.

Comportement en l'absence d'entrée

Si la source de données ne renvoie aucun résultat ou n'est pas joignable, l'entrée de la réponse ne contient que le code d'erreur, sans success, number ni name :

Réponse sans résultat

{
	"code": "600"
}

Vérifiez donc toujours success au lieu de supposer que le champ name est présent.

CodeSignification
100Requête réussie, name contient le nom de l'ID de l'appelant.
202Le numéro est invalide et n'a pas pu être interrogé. Non facturé.
500Solde insuffisant.
600La requête n'a renvoyé aucun résultat ou la source de données était indisponible.

Facturation et requêtes groupées

Les numéros transmis dans une même requête sont interrogés les uns après les autres, et chaque requête individuelle a un délai d'expiration de cinq secondes. Dimensionnez vos lots de manière à respecter votre propre délai d'expiration HTTP et répartissez les gros volumes sur des requêtes parallèles plutôt que sur une longue liste. Les numéros en double au sein d'une requête ne sont interrogés - et facturés - qu'une seule fois.

Comme les noms d'ID de l'appelant changent rarement, nous vous recommandons de mettre les résultats en cache de votre côté plutôt que d'interroger plusieurs fois le même numéro.

Dernière mise à jour: Il y a 6 heures