Remover contacto

URL da API

URL utilizado para enviar pedidos HTTP:

https://portal.bulkgate.com/api/1.0/address-book/remove

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/address-book/remove 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	Application ID	Sim	-
application_token	Application token	Sim	-
phone_number	Número de telefone do contacto a remover.	Sim	-
category	A agenda de contactos com que se trabalha. Por predefinição, a principal da conta.	Não	`main`

Exemplo de pedido

POST /api/1.0/address-book/remove HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "phone_number": "123456789" }

Resposta

Em caso de sucesso:

{ "data": { "message": "contact_has_been_removed" } }

Em caso de erro:

{ "type": "number_not_found", "code": 400, "error": "Number not found", "detail": null }

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

Em que:

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

Esta página foi útil?

Perguntar à IA Copiado