Suggestions

close search

Group management

Create a group

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

HTTP method: POST

Content-Type: application/json

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

POST data (body):

{
    "name": "GROUP_NAME"
}

Field	Type	Require	Description
name	String	Yes	The group name

Response:

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

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	No	Result message
groupID	String	No	The group ID if create successfully

Sample request

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

{
    "name": "Support group"
}

Sample response

{
    "r": 0,
    "project": 246,
    "groupID": "VJ2LFCVKRO0CXAM2",
    "message": "Create group success"
}

Group list

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

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	NO	Page
limit	Int	NO	The maximum number of groups to get

Response:

{
    "r": 0,
    "message": "Load group(s) success",
    "project": 246,
    "data": {
        "totalGroups": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "groups": [
            {
                "id": "GR_PPOJHJCJVDFC7VQC",
                "account": 408,
                "project": 246,
                "name": "Support group",
                "number_of_agent": 1
            }
        ]
    }
}

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

Sample request

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

Sample response

{
    "r": 0,
    "message": "Load group(s) success",
    "project": 246,
    "data": {
        "totalGroups": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "groups": [
            {
                "id": "GR_PPOJHJCJVDFC7VQC",
                "account": 408,
                "project": 246,
                "name": "Support group"
            }
        ]
    }
}

Delete a group

URL: https://icc-api.stringee.com/v1/group/{GROUP_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
{GROUP_ID}	String	Yes	The group 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/group/GR_PPOJHJCJVDFC7VQC 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 group success"
}

Update group

URL: https://icc-api.stringee.com/v1/group/{GROUP_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):

{
    "name": "GROUP_NAME"
}

Field	Type	Require	Description
name	String	Yes	The group name

URI Parameters:

Field	Type	Require	Description
{GROUP_ID}	String	Yes	Group ID

Response:

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

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

Sample request

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

{
    "name": "GROUP 2"
}

Sample response

{
    "r": 0,
    "message": "Update group success",
    "project": 2
}