Customer management

Add contacts to a campaign

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

HTTP method: POST

Content-Type: Multipart/form-data

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

POST data (body):

{
        "type":"1",
        "campaign":"CATJVSM9",
        "listcontacts":[
                            {   "id":"CTKN242H2Y",
                                "name":"Hoang",
                                "phones":["84346608877", "0654521598"]
                            },
                            {   "id":"CT3NSRHTXF",
                                "name":"Hai",
                                "phones":["84877777777"]
                            }
                        ],
        "listfilters":[
                            { 
                                "id":"FTRLF1YBHO",
                                "query":"created:[1564592400 TO *]  ", 
                                "portal":"pt_zdm328wwmn3pizy0"
                            },
                            {
                                "id":"FT6SYCFWTT",
                                "query":"name:\"linh\" OR name:\"\u0110\u00e0i\" OR name:\"Ch\u1ecb soa\"  ",   
                                "portal":"pt_zdm328wwmn3pizy0"
                            }
                        ],
        "file" : .xlxs file
}

Field	Type	Require	Description
type	Int	NO	Type of contact's source, 1: From Contacts menu, 2: From Filters menu
campaign	String	YES	Campaign ID
listcontacts	Array	NO	Add contact to campaign
listfilters	Array	NO	Add a filtered list to campaign
file	File	NO	Import a contact file to campaign (.xlsx file)

Response:

{
        "msg": "Success"
        "r": 0,
        data: ["contactexistis", "CTGZUZ073Z"]
}

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

Sample request

POST v1/customcampaign HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: Multipart/form-data

{
    "id": "1"
}

Sample response

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

Filtering duplicate contacts

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

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", 
}

Field	Type	Require	Description
campaign	String	YES	Campaign ID

Response:

{
        "msg": "Success",
        "r": 0,
        "data": {
            84368646891: [
                0: {
                    id: 17674
                    name: "a1"
                    phone_number: "84368646891"
                },
                1: {
                    id: 17671
                    name: "a2"
                    phone_number: "84368646891"
                },
                2: {
                    id: 17672
                    name: "a3"
                    phone_number: "84368646891"
                }
            ],
            84346608877: [
                0: {
                    id: 17658
                    name: "a4"
                    phone_number: "84346608877"
                },
                1: {
                    id: 17659
                    name: "a5"
                    phone_number: "84346608877"
                },
                2: {
                    id: 17660
                    name: "a6"
                    phone_number: "84346608877"
                }
            ]
        }
    }

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

Sample request

POST v1/customcampaign/duplicate 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 primary contact in duplicate contacts

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

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",
        listKeepCustomer: [
            "84368646891": 17674
            "84346608877": 17659
        ]
}

Field	Type	Require	Description
campaign	String	YES	Campaign ID
listKeepCustomer	Array	YES	key: phone number, value: contact ID

Response:

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

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

Sample request

POST v1/customcampaign/keepduplicate 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,
}

Get contact

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

HTTP method: GET

Content-Type: Application/json

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

GET data (body):

{
        campaign: "",
        name: "",
        status: 0,
        page: 1,
        limit: 10
}

Field	Type	Require	Description
campaign	String	NO	Campaign ID
name	String	NO	Contact name
status	Int	NO	Contact status, 0: Opening, 1: Called but failed, 2: Successful, 3:, 5: Processing, 6: Call back, 7: Unsuccessful, 8: Do not call
page	Int	YES
limit	Int	YES

Response:

{
        "message": "Call API success",
        "r": 0,
            "resFromPccApi": {
            "data":
            "rows": [
                0: {
                    callback_time: 0
                    campaign_id: "CA4KWWUS"
                    campaignname: "A1"
                    crm_id: "CTE5YCSPD9"
                    do_not_call: 0
                    id: 133
                    insert_time: 1572057303
                    last_time_make_call: 0
                    name: "Linh"
                    number_call_out: 0
                    phones: [
                        0: "84386142833"
                    ]
                    status: 0
                    stringee_user_id_callback: null
                    type: 3
                },
                1: {
                    callback_time: 0
                    campaign_id: "CA4KWWUS"
                    campaignname: "A1"
                    crm_id: "CTGZUZ073Z"
                    do_not_call: 0
                    id: 134
                    insert_time: 1572057303
                    last_time_make_call: 0
                    name: "Tai"
                    number_call_out: 0
                    phones: [
                        0: "84392095847"
                    ]
                    status: 0
                    stringee_user_id_callback: null
                    type: 3
                }
            ]
            "totalCount": "2"
            "totalPages": 1
}

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

Sample request

GET v1/customcampaign 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,
}

Delete contacts from campaign

URL: https://icc-api.stringee.com/v1/customcampaign/ + {CustomerId}

HTTP method: DELETE

Content-Type: Application/json

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

DELETE data (body):

{
        "id": 110, 
}

Field	Type	Require	Description
id	INT	YES	ID CUSTOMER

Response:

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

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

Sample request

DELETE v1/customcampaign 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,
}

Suggestions

Add contacts to a campaign

Filtering duplicate contacts

Choosing primary contact in duplicate contacts

Get contact

Delete contacts from campaign