Suggestions

close search

Get agent's running campaigns

URL: https://icc-api.stringee.com/v1/campaign/findcampaignrunning

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        stringee_user_id: "ACEY3WVC3R", 
        name: "hoang",
}

Field	Type	Require	Description
stringee_user_id	String	YES	Stringee account ID
name	String	NO	Campaign name

Response:

{
        "msg": "Success",
        "r": 0
}

Field	Type	Require	Description
r	Int	Yes	Result code
msg	String	No	Result message

Sample request

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

{
    "id": "1"
}

Sample response

{
    "msg": "Success"
    "r": 0,
}

Choosing campaign to perform

URL: https://icc-api.stringee.com/v1/campagent/setperform

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        campaign: "CA3WVC3R",
        stringee_user_id: "ACTHWN342",
}

Field	Type	Require	Description
campaign	String	YES	Campaign ID
stringee_user_id	String	YES	Stringee account ID

Response:

{
        "msg": "Success",
        "r": 0
}

Field	Type	Require	Description
r	Int	Yes	Result code
msg	String	No	Result message

Sample request

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

{
    "id": "1"
}

Sample response

{
    "msg": "Success"
    "r": 0,
}

Remove performing campaign

URL: https://icc-api.stringee.com/v1/campagent/removeperform

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        stringee_user_id: "ACTHWN342"
}

Field	Type	Require	Description
stringee_user_id	String	YES	Stringee account ID

Response:

{
        "msg": "Success",
        "r": 0
}

Field	Type	Require	Description
r	Int	Yes	Result code
msg	String	No	Result message

Sample request

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

{
    "id": "1"
}

Sample response

{
    "msg": "Success"
    "r": 0,
}

Set call back time

URL: https://icc-api.stringee.com/v1/customcampaign/callback

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        customer_campaign_id: "7", 
        campaign_id: "CALPJTHO",
        stringee_user: "ac_v307fmglbbsd3u6r", 
        callback_time: "15656239990"
}

Field	Type	Require	Description
customer_campaign_id	String	YES	Contact ID
campaign_id	String	YES	Campaign ID
stringee_user	String	YES	Stringee account ID
callback_time	String	YES	Time to call back

Response:

{
        "msg": "Success",
        "r": 0
}

Field	Type	Require	Description
r	Int	Yes	Result code
msg	String	No	Result message

Sample request

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

{
    "id": "1"
}

Sample response

{
    "msg": "Success"
    "r": 0,
}

Set do not call

URL: https://icc-api.stringee.com/v1/customcampaign/donotcall

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        customer_campaign_id: "7",
        campaign_id: "CALPJTHO",
        phones: "84346608877"
}

Field	Type	Require	Description
customer_campaign_id	String	YES	Contact ID
campaign_id	String	YES	Campaign ID
phones	Array	YES	Customer phone numbers

Response:

{
        "msg": "Success",
        "r": 0
}

Field	Type	Require	Description
r	Int	Yes	Result code
msg	String	No	Result message

Sample request

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

{
    "id": "1"
}

Sample response

{
    "msg": "Success"
    "r": 0,
}