Comprobar el blacklist

Comprueba si los números indicados están en el blacklist. Devuelve un mapa de número → true/false.

URL de la API

URL utilizada para enviar las solicitudes HTTP:

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

Nota

Si la solicitud no llega a su destino, repítala en el servidor de respaldo backup1.bulkgate.com.

Métodos HTTP compatibles

POST - application/json

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

Nota

La API tiene una cuota de 20 solicitudes por minuto.

Tabla de parámetros

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
application_id	Application ID	Sí	-
application_token	Token de autenticación de la aplicación	Sí	-
numbers	Números que se van a comprobar: un array o una cadena separada por comas	Sí	-
wallet	Monedero en el que se comprueban los números	No	Monedero predeterminado
route	La ruta para la que se evalúa el bloqueo: `promotional`, `transactional` o `all`	No	`promotional`

Ejemplo de solicitud

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" }

Respuesta

En caso de éxito:

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

Donde:

la clave es el número de teléfono que ha enviado
el valor es true si el número está en el blacklist y false en caso contrario

Los números no válidos no devuelven ningún error: aparecen en la respuesta con el valor false.

En caso de error:

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

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

Donde:

type y error (descripción del error) se encuentran en la tabla de tipos de error
code es el código de error HTTP
detail es información adicional sobre el error

Tipos de error de la Blacklist API

Además de los tipos generales, la Blacklist API devuelve los suyos propios:

TIPO	CUÁNDO OCURRE
`invalid_wallet`	El monedero indicado no existe o no tiene acceso a él.
`minute_quota_exceeded`	Se ha agotado la cuota de 20 solicitudes por minuto.

¿Le ha resultado útil esta página?

Preguntar a la IA Copiado