Suggestions

close search

Blacklist Number management

Add a number to blacklist number

URL: https://icc-api.stringee.com/v1/blacklistnumber

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

POST data (body):

{
    "number": "STRINGEE_NUMBER",
    "ivr_blocked": 1,
    "queue_blocked": 1
}

Field	Type	Require	Description
number	String	YES	The blacklist number
ivr_blocked	Boolean	NO	Allow block in IVR
queue_blocked	Boolean	NO	Allow block in queue

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "blacklistNumberID": "BLACKLIST_NUMBER_ID",
    "message": "RESULT_MSG"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	No	Result message
blacklistNumberID	String	No	Blacklist number ID

Sample request

POST /v1/blacklistnumber HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "number" : "84379361752",
    "ivr_blocked": 1,
    "queue_blocked": 1
}

Sample response

{
    "r": 0,
    "project": 24,
    "blacklistNumberID": "BNXJ3OWK",
    "message": "Create blacklist number success"
}

Blacklist number

URL: https://icc-api.stringee.com/v1/blacklistnumber

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

GET parameters:

Field	Type	Require	Description
page	Int	YES	Default = 1
limit	Int	YES	Default = 50, max = 100

Response:

{
    "r": 0,
    "message": "Load blacklist(s) success",
    "project": 24,
    "data": {
        "totalCount": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "blacklistNumbers": [
            {
                "id": "BNXJ3OWK",
                "account": 6,
                "project": 24,
                "number": "+84379361752",
                "ivr_blocked": 1,
                "queue_blocked": 1
            }
        ]
    }
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	Yes	Result message
data	JSON	Yes	Blacklist number list

Sample request

GET /v1/blacklistnumber HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "message": "Load number success",
    "project": 246,
    "data": {
        "totalCount": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "numbers": [
            {
                "id": "NU_S53F60KUWL19L663",
                "account": 408,
                "project": 246,
                "number": "84986225112",
                "nickname": "Number 112",
                "allow_outbound_calls": 1,
                "enable_ivr": 0,
                "ivr_menu": "TR_5DFM9ZXZNBM5EQG9",
                "queue_id": "QU_H7CFNKKKUGYG5N2R"
            }
        ]
    }
}

Delete a number in blacklist number

URL: https://icc-api.stringee.com/v1/blacklistnumber/{BLACKLIST_NUMBER_ID}

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

URI Parameters:

Field	Type	Require	Description
{BLACKLIST_NUMBER_ID}	String	Yes	The blacklist number ID

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "message": "RESULT_MESSAGE"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	No	Result message

Sample request

DELETE /v1/blacklistnumber/BNXJ3OWK HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "project": 246,
    "message": "Delete blacklist number success"
}

Update blacklist number

URL: https://icc-api.stringee.com/v1/blacklistnumber/{BLACKLIST_NUMBER_ID}

HTTP method: PUT

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

PUT data (body):

{
    "number": "STRINGEE_NUMBER",
    "ivr_blocked": ALLOW_BLOCK_IVR_OR_NOT",
    "queue_blocked": ALLOW_BLOCK_QUEUE_OR_NOT
}

Field	Type	Require	Description
number	String	YES	The Contact Center number, bought from Stringee Dashboard
ivr_blocked	Boolean	NO
queue_blocked	Boolean	NO

URI Parameters:

Field	Type	Require	Description
{BLACKLIST_NUMBER_ID}	String	Yes	Blacklist number ID

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "message": "RESULT_MSG"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	No	Your project ID
message	String	Yes	Result message

Sample request

PUT /v1/blacklistnumber/BNXJ3OWK HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "number" : "84379361752",
    "ivr_blocked": 1,
    "queue_blocked": 1
}

Sample response

{
    "r": 0,
    "project": 24,
    "blacklistNumberID": "BNXJ3OWK",
    "message": "Update blacklist number success"
}