Sjekk blokkeringsliste

Kontrollerer om de oppgitte numrene står på blokkeringslisten. Returnerer en oversikt over nummer → true/false.

API-URL

URL som brukes til å sende HTTP-forespørsler:

https://portal.bulkgate.com/api/1.0/black-list/is-black-listed

Merk

Hvis forespørselen ikke kommer frem, kan du sende den på nytt til reserveserveren backup1.bulkgate.com.

Støttede HTTP-metoder

POST - application/json

POST /api/1.0/black-list/is-black-listed HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Merk

API-et har en kvote på 20 forespørsler per minutt.

Parametertabell

PARAMETERNAVN	VERDI	OBLIGATORISK	STANDARDVERDI
application_id	Application ID	Ja	-
application_token	Autentiseringstoken for applikasjonen	Ja	-
numbers	Numre som skal kontrolleres — en array eller en kommaseparert streng	Ja	-
wallet	Lommeboken numrene skal kontrolleres i	Nei	Standardlommebok
route	Ruten blokkeringen vurderes for — `promotional`, `transactional` eller `all`	Nei	`promotional`

Eksempel på forespørsel

POST /api/1.0/black-list/is-black-listed HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "numbers": ["420123456789", "420987654321"], "wallet": "bg1905014138000023" }

Svar

Ved suksess:

{ "data": { "420123456789": true, "420987654321": false } }

Der:

nøkkelen er telefonnummeret du sendte
verdien er true når nummeret står på blokkeringslisten, ellers false

Ugyldige numre gir ingen feil — de står i svaret med verdien false.

Ved feil:

{ "type": "invalid_wallet", "code": 400, "error": "Invalid wallet", "detail": null }

{ "type": "minute_quota_exceeded", "code": 400, "error": "Minute quota exceeded", "detail": null }

Der:

type og error (beskrivelse av feilen) finner du i tabellen over feiltyper
code er HTTP-feilkoden
detail er tilleggsinformasjon om feilen

Feiltyper i Blacklist API

I tillegg til de generelle typene returnerer Blacklist API sine egne:

TYPE	NÅR DET SKJER
`invalid_wallet`	Den oppgitte lommeboken finnes ikke, eller du har ikke tilgang til den.
`minute_quota_exceeded`	Kvoten på 20 forespørsler per minutt er brukt opp.

Var denne siden nyttig?

Spør AI Kopiert