Blacklist

Get blacklist

Description

You can use this API to check your blocked list.

Endpoint

    POST https://019sms.co.il/api
  

Parameters

Name	Type	Description	Required
blacklist	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
from	object	The start date to take the report from. Format : dd/mm/yy hh:mm	✔️
to	object	The end date to take the report from. Format : dd/mm/yy hh:mm	✔️

Request Example

json

Copy code

    {
  "blacklist": {
    "user": {
      "username": "XXXXXX"
    },
    "from": "02/06/22 00:00",
    "to": "15/12/22 23:59"
  }
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <user>
        <username>XXXXXX</username>
    </user>
    <from>02/06/15 00:00</from>
    <to>15/12/15 23:59</to>
</blacklist>

  

Response Example

json

Copy code

    {
  "status": 0,
  "message": "",
  "transactions": [
    {
      "phone": "5********",
      "date": "22/08/22 11:00"
    },
    {
      "phone": "5********",
      "date": "23/11/22 12:37"
    }
  ]
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<blacklist>
    <status>0</status>
    <message></message>
    <transactions>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 16:38</date>
        </transaction>
        <transaction>
            <phone>5********</phone>
            <date>03/12/14 12:33</date>
        </transaction>
    </transactions>
</blacklist>

  

Note

Full description of the response status and message can be found in here:

Remove phones from blacklist

Description

You can use this API to remove phones from blacklist.

Endpoint

    POST https://019sms.co.il/api
  

Parameters

Name	Type	Description	Required
rmNumBL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
phones	object	. Contains all phone elements.	✔️
phone	string	Contains phone you want to remove.	✔️
reason	object	Contains an text about the reason why you want to remove.	✔️

Request Example

json

Copy code

    {
  "rmNumBL": {
    "user": {
      "username": "xxxxxx"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    },
    "reason": "Text here"
  }
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<rmNumBL>
    <user>
        <username>xxxxxx</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
    <reason>Text here</reason>
</rmNumBL>

  

Response Example

json

Copy code

    {
  "status": 944,
  "message": "X phone numbers Successfully deleted , Y Phone numbers not exist in blacklist"
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<status>944</status>
<message>X phone numbers Successfully deleted , Y Phone numbers not exist in
blacklist</message>

  

Note

Full description of the response status and message can be found in here:

Add number to blacklist

Description

You can use this API to add phones from blacklist.

Endpoint

    POST https://019sms.co.il/api
  

Parameters

Name	Type	Description	Required
addNumBL	object	Contains all other elements.	✔️
user	object	Contains the user element.	✔️
username	string	The username of the account by which you are recognized in the system	✔️
phones	object	. Contains all phone elements.	✔️
phone	string	Contains phone you want to remove.	✔️

Request Example

json

Copy code

    {
  "addNumBL": {
    "user": {
      "username": "xxxxxx"
    },
    "phones": {
      "phone": [
        "5********",
        "05********"
      ]
    }
  }
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<addNumBL>
    <user>
        <username>xxxxxx</username>
    </user>
    <phones>
        <phone>5********</phone>
        <phone>05********</phone>
    </phones>
</addNumBL>

  

Response Example

json

Copy code

    {
  "status": 946,
  "message": "number has successfully added to blacklist"
}

  

xml

Copy code

    <?xml version="1.0" encoding="UTF-8"?>
<status>946</status>
<message>number has successfully added to blacklist</message>

  

Note

Full description of the response status and message can be found in here: