Adicionar à blacklist

Adiciona números à blacklist. Um número na blacklist não recebe mensagens promocionais nem transacionais.

URL da API

URL utilizado para enviar os pedidos HTTP:

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

Nota

Se o pedido não chegar ao destino, repita-o no servidor de reserva backup1.bulkgate.com.

Métodos HTTP suportados

POST - application/json

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

Tabela de parâmetros

NOME DO PARÂMETRO	VALOR	OBRIGATÓRIO	VALOR PREDEFINIDO
application_id	ID da aplicação	Sim	-
application_token	Token de autenticação da aplicação	Sim	-
numbers	Números a adicionar à blacklist — um array ou uma string separada por vírgulas	Sim	-
wallet	Carteira na qual os números são adicionados à blacklist	Não	Carteira predefinida
source_id	Identificador do grupo de números na blacklist	Não	`api-<string aleatória>`
reason	Motivo pelo qual o número foi adicionado à blacklist	Não	-
type	A lista à qual os números são adicionados — `black-list` ou `opt-out`	Não	`black-list`

Exemplo de pedido

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": "Não quero receber mensagens comerciais." }

Resposta

Em caso de sucesso:

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

Em caso de erro:

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

Em que:

type e error (descrição do erro) encontram-se na tabela de tipos de erros
code é o código de erro HTTP
detail contém informações adicionais sobre o erro

Tipos de erros da Blacklist API

Além dos tipos gerais, a Blacklist API devolve os seus próprios:

TIPO	QUANDO OCORRE
`invalid_wallet`	A carteira indicada não existe ou não tem acesso a ela.
`no_valid_numbers`	O parâmetro `numbers` não contém nenhum número válido.
`number_already_exists`	Está a enviar um único número e este já se encontra na blacklist.

Esta página foi útil?

Perguntar à IA Copiado