Hoppa till huvudinnehåll
Denna artikel kommer att introducera en mobilnummerstatuskontroll API integrationsbeskrivning, som kan användas för att verifiera statusen för ett mobilnummer, du kan ange mobilnumret för att göra en förfrågan.

Ansökningsprocess

För att använda API:et måste du först gå till Mobilnummerstatuskontroll API motsvarande sida för att ansöka om den tjänst som behövs, när du kommer in på sidan, klicka på “Acquire”-knappen, som visas i bilden: Om du inte har loggat in eller registrerat dig kommer du automatiskt att omdirigeras till inloggningssidan för att uppmanas att registrera dig och logga in, efter inloggning och registrering kommer du automatiskt att återvända till den aktuella sidan. Vid första ansökan kommer det att finnas en gratis kvot som ges, så att du kan använda detta API gratis.

Grundläggande användning

Först bör du förstå den grundläggande användningsmetoden, vilket är att ange mobilnumret för att få det bearbetade resultatet, du behöver först enkelt överföra ett mobile fält. Vi kan sedan fylla i motsvarande innehåll på gränssnittet, som visas i bilden:

Här kan vi se att vi har ställt in Request Headers, inklusive:
  • accept: vilken format av svar du vill ta emot, här anges som application/json, det vill säga JSON-format.
  • authorization: nyckeln för att anropa API:et, efter ansökan kan du direkt välja från rullgardinsmenyn.
Dessutom har vi ställt in Request Body, inklusive:
  • mobile: det mobilnummer som ska bearbetas, är ett obligatoriskt parameter.
  • encryption: valfritt, känsliga fält krypteringsparameter (om du behöver skicka krypterad text).
När du har valt kan du se att motsvarande kod också har genererats till höger, som visas i bilden:

Klicka på “Try”-knappen för att göra ett test, som visas i bilden ovan, här har vi fått följande resultat:
{
  "result": "0",
  "description": "Framgång",
  "status_code": 0
}
Det returnerade resultatet har flera fält, som beskrivs nedan:
  • result, autentiseringsresultatkod, avgiftsläget är som följer.
    • Avgiftsresultatkod:
      • 0: Framgång
    • Ingen avgiftsresultatkod:
      • -1: Ingen resultat hittades
      • -2: Mobilnummerformatet är inte korrekt
      • -3: Verifieringscentralens tjänst är upptagen
  • description, affärsresultatsbeskrivning.
  • status_code, statuskod:
    • 0: Normal
    • 1: Avstängd
    • 2: Avregistrerad
    • 3: Tomt nummer
    • 4: Inte i nätet
    • 99: Okänd status
Det kan ses att statusen för detta mobilnummer redan har kontrollerats. Om du vill generera motsvarande integrationskod kan du direkt kopiera den som genererats, till exempel CURL-koden nedan:
curl -X POST 'https://api.acedata.cloud/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
Python integrationskoden ser ut så här:
import requests

url = "https://api.acedata.cloud/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Felhantering

När du anropar API:et, om du stöter på fel, kommer API:et att returnera motsvarande felkod och information. Till exempel:
  • 400 token_mismatched: Bad request, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 400 api_not_implemented: Bad request, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 401 invalid_token: Obehörig, ogiltig eller saknad auktoriseringstoken.
  • 429 too_many_requests: För många förfrågningar, du har överskridit hastighetsgränsen.
  • 500 api_error: Intern serverfel, något gick fel på servern.

Exempel på felrespons

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "hämtning misslyckades"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Slutsats

Genom detta dokument har du fått en förståelse för hur du använder mobilnummerstatuskontroll API för att verifiera statusen för ett mobilnummer, du kan ange mobilnumret för att göra en förfrågan. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda detta API. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.