Suggestions

close search

Campaign Management

Report Campaign customers

URL: https://api.stringeex.com/v1/pcccampaign

HTTP method: POST

Content-Type: application/json

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

Sample request:

{
        "uri": "v1/customcampaign/reportcustomer",
        "method": "POST",
        "body": {
            "campaign_id": null,
            "agent_id": null,
            "limit": 15,
            "page": 1,
            "sort_by": "name",
            "sort_order": "asc"
        }
    }

Sample response:

    {
        "r": 0,
        "message": "Call API success",
        "resFromPccApi": {
            "data": [
                {
                    "campaign_name": "1",
                    "total_customer": 8,
                    "new_customer": 8,
                    "process_customer": 0,
                    "failed_customer": 0,
                    "exceed_customer": 0,
                    "success_customer": 0,
                    "callback_customer": 0,
                    "error_call": 0,
                    "donotcall_customer": 0
                },
                {
                    ...
                }
            ],
            "totalCount": "40",
            "r": 0,
            "msg": "Success"
        }
    }

Report Campaign calls

URL: https://api.stringeex.com/v1/pcccampaign

HTTP method: POST

Content-Type: application/json

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

GET params:

Field	Type	Required	Description
limit	Number	No	Default: 10
page	Number	No	Default: 1
sort_by	Text	No	Default: name
sort_order	Text	No	asc | desc, Default: asc

Sample response:

{
    "data": {
        "rows": [
            {
                "id": "CATMNQ9P",
                "name": "1",
                "total_customer": 8,
                "campaign": "CATMNQ9P",
                "total_call": 3,
                "total_call_success": 0,
                "total_call_failed": 3,
                "total_answer_duration": 0,
                "average_answer_duration": 0
            },
            {
                ...
            }
        ],
        "totalCount": "40"
    },
    "r": 0,
    "msg": "Success"
}

Report Campaign agents

URL: https://api.stringeex.com/v1/pcccampaign

HTTP method: POST

Content-Type: application/json

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

Sample request:

{
    "uri": "v1/campagent?agent=&campaign=&limit=20&page=1",
    "method": "GET"
}

Sample response:

{
    "data": {
        "rows": [
            {
                "id": "CATMNQ9P",
                "name": "1",
                "total_customer": 8,
                "campaign": "CATMNQ9P",
                "total_call": 3,
                "total_call_success": 0,
                "total_call_failed": 3,
                "total_answer_duration": 0,
                "average_answer_duration": 0
            },
            {
                ...
            }
        ],
        "totalCount": "40"
    },
    "r": 0,
    "msg": "Success"
}

List Campaign scripts

URL: https://api.stringeex.com/v1/pcccampaign

HTTP method: GET

Content-Type: application/json

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

Sample request:

{
    "uri": "v1/campaign/search",
    "method": "POST",
    "body": {}
}

Sample response:

{
    "r": 0,
    "message": "Call API success",
    "resFromPccApi": {
        "data": [
            {
                "id": "CATMNQ9P",
                "project": 1120,
                "account": 1069,
                "name": "1",
                "type": 3,
                "start_time": 1580720089,
                "end_time": 1582909200,
                "description": "1",
                "status": 4,
                "max_call_retry": 1,
                "time_between_two_call": 60,
                "time_do_not_call": 1,
                "created": 1580720125,
                "auto_dialer_type": 1,
                "business_hour_id": 235,
                "callout_number": "+84869388381",
                "max_abandon_rate": "0.00000",
                "wait_greeting": null,
                "max_waiting_time": 60,
                "preview_time": 30,
                "quota_type": null,
                "quota_call_out": null,
                "template_id": null,
                "is_create_ticket": 0,
                "wrap_up_time_limit": 10
            },
            {
                ...
            }
        ],
        "r": 0,
        "msg": "Success"
    }
}

Report Campaign survey

URL: https://api.stringeex.com/v1/campaign/survey/report?limit=15&page=1&campaign_id=CAME60LL

HTTP method: GET

Content-Type: application/json

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

GET params:	Field	Type	Required	Description
page	Number	No	Default: 1
limit	Number	No	Default: 15
campaign_id	Text	No	Campaign ID

Sample response:

{
    "r": 0,
    "data": {
        "rows": [
            {
                "id": "2412",
                "account_id": "AC3C5R7800",
                "portal_id": "PT8LB2FD3Q",
                "contact_id": "8e26a3b3a7a7abadb1e6bf55d939dbe4",
                "campaign_id": "CAME60LL",
                "template_id": "SVTZZQG2Z40",
                "created_time": 1587628756,
                "updated_time": 1587628756,
                "object_type": "survey_report",
                "call_status": 1,
                "campaign_name": "A_Manual",
                "campaign_type": 3,
                "customer_name": "Nguyễn Minh Thái Hà 8",
                "customer_phone": "84368646891"
            },
            {
                ...
            }
        ],
        "totalPages": 1,
        "totalCount": 5
    }
}

Add customers to a campaign

URL: https://api.stringeex.com/v1/pcccampaign

HTTP method: POST

Content-Type: multipart/form-data

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

Sample request: Add customers from filters

file_upload: 
type: 
uri: v1/customcampaign/insert
method: POST
body: {"type":"1","campaign":"CAB5U4EK","contact":["CTVBG69SBM","CTEGSOXSEC"]}

Sample request: Add customers from contacts

file_upload: 
type: 
uri: v1/customcampaign/insert
method: POST
body: {"type":"2","campaign":"CAB5U4EK","contact":[],"filter":["FT8R7Q3M6D","FTZMARDAL3"]}

Sample request: Add customers from file excel

file_upload: FILE_EXCEL
type: xlsx
uri: v1/customcampaign/insert
method: POST
body: {"type":"4","campaign":"CAB5U4EK"}

Sample response:

{
    "r": 0,
    "message": "Call API success",
    "resFromPccApi": {
        "data": [],
        "r": 0,
        "msg": "Success"
    }
}