Group routing

Add a group to a queue

URL: https://icc-api.stringee.com/v1/routing-call-to-groups

HTTP method: POST

Content-Type: application/json

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

POST data (body):

{
    "queue_id": "QUEUE_ID",
    "group_id": "GROUP_ID",
    "primary_group": 1
}

Field	Type	Require	Description
queue_id	String	YES	The queue ID
group_id	String	YES	The group ID
primary_group	Int	YES	1= Set up the group to have a higher priority. Only when all agents in this group are not available, the call is routed to another group with lower priority (primary_group=0)

Response:

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

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

Sample request

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

{
    "queue_id": "QU_PRWHUKZJ8EMA2U0Y",
    "group_id": "GR_QD72WYP4BAG4HYZ9",
    "primary_group": 1
}

Sample response

{
    "r": 0,
    "project": 246,
    "groupRoutingID": "GR_RO_767XB0XBNTX6Z751",
    "message": "Create group routing success"
}

Group list of a queue

URL: https://icc-api.stringee.com/v1/routing-call-to-groups?queue={QUEUE_ID}

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
queue	String	YES	The queue ID

Response:

{
    "r": 0,
    "message": "Load group routing success",
    "project": 246,
    "data": {
        "totalCount": "3",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "groupRoutings": [
            {
                "id": "GR_RO_767XB0XBNTX6Z751",
                "account": 408,
                "project": 246,
                "queue_id": "QU_PRWHUKZJ8EMA2U0Y",
                "group_id": "GR_QD72WYP4BAG4HYZ9",
                "primary_group": 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/routing-call-to-groups?queue=QU_PRWHUKZJ8EMA2U0Y 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 routing success",
    "project": 246,
    "data": {
        "totalCount": "3",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "groupRoutings": [
            {
                "id": "GR_RO_767XB0XBNTX6Z751",
                "account": 408,
                "project": 246,
                "queue_id": "QU_PRWHUKZJ8EMA2U0Y",
                "group_id": "GR_QD72WYP4BAG4HYZ9",
                "primary_group": 1
            }
        ]
    }
}

Delete a group from a queue

URL: https://icc-api.stringee.com/v1/routing-call-to-groups/{GROUP_ROUTING_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_ROUTING_ID}	String	Yes	GROUP_ROUTING_ID

Response:

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

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

Sample request

DELETE /v1/routing-call-to-groups/GR_RO_767XB0XBNTX6Z751 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 routing success"
}

Update group routing

URL: https://icc-api.stringee.com/v1/routing-call-to-groups/{GROUP_ROUTING_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):

{
    "primary_group": 1
}

Field	Type	Require	Description
primary_group	Int	YES	1= Set up the group to have a higher priority. Only when all agents in this group are not available, the call is routed to another group with lower priority (primary_group=0)

URI Parameters:

Field	Type	Require	Description
{GROUP_ROUTING_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/routing-call-to-groups/GR_RO_767XB0XBNTX6Z751 HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "primary_group": 1
}

Sample response

{
    "r": 0,
    "message": "Group routing update success"
}

Suggestions

Group routing

Add a group to a queue

Group list of a queue

Delete a group from a queue

Update group routing