Blacklist Number Management

APIs for managing Number in Blacklist. This API only work with user who has permission to manage blacklist number.

List Number In Blacklist

GET https://{yoursubdomain}.oncaller.asia/api/v1/blacklist-number

This endpoint allows you to get blacklist numbers

Query Parameters

Name	Type	Description
page	number	Page
limit	number	Number of limit item per page. M

Headers

Name	Type	Description
Authentication	string	Bearer + {token}

200 Cake successfully retrieved.

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}

Add new Number to Blacklist

POST https://{yoursubdomain}.oncaller.asia/api/v1/blacklist-number

Add new number to Blacklist

Headers

Name	Type	Description
Authentication	string	Bearer + {Token}

Request Body

Name	Type	Description
number	string	Number to add to blacklist, start with 0 or '+'. Ex: 0904893123, [phone]
ivr_blocked	boolean	Block go to IVR or not
queue_blocked	boolean	Block go to Queue or not

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": {
        "number": "[phone]",
        "ivr_blocked": true,
        "queue_blocked": true,
        "updated_at": "2020-10-07T03:25:00.000000Z",
        "created_at": "2020-10-07T03:25:00.000000Z",
        "id": 39
    }
}

Update number in Blacklist

PUT https://{yoursubdomain}.oncaller.asia/api/v1/blacklist-number/{number}

Headers

Name	Type	Description
Authentication	string	Bearer + {token}

Request Body

Name	Type	Description
number	string	Number must be start with 0 or '+'
ivr_blocked	boolean	Block go to IVR or not
queue_blocked	boolean	Block go to Queue or not

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": {
        "number": "[phone]",
        "ivr_blocked": true,
        "queue_blocked": true,
        "updated_at": "2020-10-07T03:25:00.000000Z",
        "created_at": "2020-10-07T03:25:00.000000Z",
        "id": 39
    }
}

Delete Number in Blacklist

DELETE https://{yoursubdomain}.oncaller.asia/api/v1/blacklist-number/{number}

Remove number in blacklist

Headers

Name	Type	Description
Authentication	string	Bearer + {token}

200

{
    "success": true,
    "code": 200,
    "locale": "en",
    "message": "OK",
    "data": {}
}