Suggestions

close search

Number management

Add a hotline number

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

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",
    "nickname": "NUMBER_NICKNAME",
    "allow_outbound_calls": ALLOW_OUTBOUND_CALLS_OR_NOT,
    "enable_ivr": ENABLE_IVR_NOR_NOT,
    "ivr_menu": "IVR_TREE_ID",
    "queue_id": "QUEUE_ID",
    "record_outbound_calls": RECORD_OUTBOUND_CALLS_OR_NOT
}
Field Type Require Description
number String YES The hotline number, bought from Stringee Dashboard
nickname String NO The hotline nickname
allow_outbound_calls Boolean YES Allow outbound calls for this number or not
enable_ivr Boolean YES Enable IVR for this number or not. If YES, the ivr_menu must be set by an IVR tree ID
ivr_menu String NO The IVR tree ID if enable_ivr=YES
queue_id String NO The queue ID to route the call to if enable_ivr=NO
record_outbound_calls Boolean NO Record outbound calls or not

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "numberID": "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
numberID String No Number ID

Sample request

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

{
    "number": "84986225112",
    "nickname": "Number 112",
    "allow_outbound_calls": true,
    "enable_ivr": true,
    "ivr_menu": "TR_5DFM9ZXZNBM5EQG9",
    "queue_id": "QU_H7CFNKKKUGYG5N2R"
}

Sample response

{
    "r": 0,
    "project": 246,
    "numberID": "Z1SQMO3W5UIHUGHC",
    "message": "Create number success"
}

Hotline number list

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

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
limit Int YES

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"
            }
        ]
    }
}
Field Type Require Description
r Int Yes Result code
project Int Yes Your project ID
message String Yes Result message
data JSON Yes Number list

Sample request

GET /v1/number 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 hotline number

URL: https://icc-api.stringee.com/v1/number/{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
{NUMBER_ID} String Yes The 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/number/NU_S53F60KUWL19L663 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 number success"
}

Update number

URL: https://icc-api.stringee.com/v1/number/{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",
    "nickname": "NUMBER_NICKNAME",
    "allow_outbound_calls": ALLOW_OUTBOUND_CALLS_OR_NOT,
    "enable_ivr": ENABLE_IVR_NOR_NOT,
    "ivr_menu": "IVR_TREE_ID",
    "queue_id": "QUEUE_ID",
    "record_outbound_calls": RECORD_OUTBOUND_CALLS_OR_NOT
}
Field Type Require Description
number String YES The hotline number, bought from Stringee Dashboard
nickname String NO The hotline nickname
allow_outbound_calls Boolean YES Allow outbound calls for this number or not
enable_ivr Boolean YES Enable IVR for this number or not. If YES, the ivr_menu must be set by an IVR tree ID
ivr_menu String NO The IVR tree ID if enable_ivr=YES
queue_id String NO The queue ID to route the call to if enable_ivr=NO
record_outbound_calls Boolean NO Record outbound calls or not

URI Parameters:

Field Type Require Description
{NUMBER_ID} String Yes Queue 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/number/NU_S53F60KUWL19L663 HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "number": "333333",
    "nickname": "new nick name",
    "allow_outbound_calls": true
}

Sample response

{
    "r": 0,
    "message": "Update number success"
}