SmsDeleteBlacklistPhone¶

DELETE sms/blacklist

Removes a number from the do-not-message list. The entry can be addressed either by id or by the number — an operator holding a phone number should not have to look up an id first.

Removing an OPT_OUT entry means messaging someone who asked to be left alone: it is an administrative action and is journalled as one.

Access Control¶

Allowed role: admin.

Request¶

RESTTCPSDK

DELETE request

DELETE https://{broker_domain}/sms/blacklist?phone=+380950000000
Authorization: <JWT_TOKEN>

{
  "command": "SmsDeleteBlacklistPhone",
  "extID": "1",
  "data": {
    "phone": "+380950000000"
  }
}

const res = await platform.SmsDeleteBlacklistPhone({
  phone: "+380950000000"
});

Request Data¶

Field	Type	Required	Description
`id`	int	No	Blacklist entry id
`phone`	string	No	Number in any format; used when `id` is not given

Response Data¶

{
  "id": 31,
  "phone": "380950000000",
  "deleted": true
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Neither `id` nor `phone` was provided
`404`	`NOT_FOUND`	No such entry in the brand