Añadir a la blacklist

Añade números a la blacklist. Un número incluido en la blacklist no recibe mensajes promocionales ni transaccionales.

URL de la API

URL a la que se envían las solicitudes HTTP:

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

Nota

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

Métodos HTTP admitidos

POST - application/json

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

Tabla de parámetros

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
application_id	ID de aplicación	Sí	-
application_token	Token de autenticación de la aplicación	Sí	-
numbers	Números que se van a incluir en la blacklist: un array o una cadena separada por comas	Sí	-
wallet	Monedero en el que se incluyen los números en la blacklist	No	Monedero predeterminado
source_id	Identificador del grupo de números incluidos en la blacklist	No	`api-<random string>`
reason	Motivo por el que el número se incluye en la blacklist	No	-
type	Lista a la que se añaden los números: `black-list` u `opt-out`	No	`black-list`

Ejemplo de solicitud

POST /api/1.0/black-list/add 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", "source_id": "api-my-import", "reason": "No quiero recibir comunicaciones comerciales." }

Respuesta

En caso de éxito:

{ "data": { "message": "contacts have been blacklisted" } }

En caso de error:

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

{ "type": "no_valid_numbers", "code": 400, "error": "No valid numbers", "detail": null }

{ "type": "number_already_exists", "code": 400, "error": "Number already exists", "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 sus propios tipos:

TIPO	CUÁNDO SE PRODUCE
`invalid_wallet`	El monedero indicado no existe o no tiene acceso a él.
`no_valid_numbers`	El parámetro `numbers` no contiene ningún número válido.
`number_already_exists`	Está enviando un único número y ya está en la blacklist.

¿Le ha resultado útil esta página?

Preguntar a la IA Copiado