Outbound campaign management

Create an outbound campaign

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

HTTP method: POST

Content-Type: multipart/form-data !!!!! IMPORTANT

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

POST data (body):

{
        "name":"sdv", 
        "desc1":"qewcwecewc", 
        "start_time":1572022800000,
        "end_time":1572109200000, 
        "max_call_retry":1,
        "time_between_two_call":60, 
        "auto_dialer_type":"1", 
        "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
        "agent":["AGAH2Q4Q"],
        "group":["GR10048CS"],
        "number":" 842499966631",
        "businesshour":1,
        "type": "3",
        "preview_time": "30",
        "max_abandon_rate": "0.05",
        "wait_greeting": "",
        "max_waiting_time": "60",
        "quota_type": 1,
        "quota_call_out":5,
        "time_do_not_call":180
}

Field	Type	Require	Description
name	String	YES	Campaign name
desc1	String	NO	Campaign description
start_time	Int	YES	Start time
end_time	Int	YES	End time
max_call_retry	Int	YES	Number of times to retry
time_between_two_call	Int	NO	Interval time between 2 consequential retries, calculate by minutes, the lowest is 10
auto_dialer_type	Int	YES	1: preview, 2: progressive, 3: predictive, 4: manual
listcontacts	Array	NO	List of contacts adding to the campaign
listfilters	Array	NO	List of filters adding to the campaign (Only use StringeeX)
file	File	NO	Import a contact file to campaign (.xlsx file)
agent	Array	NO	List of agents id added to the campaign
group	Array	NO	List of groups id added to the campaign
number	Int	YES	Call-out number
businesshour	Int	NO	Business-hour ID
type	Int	YES	Type: 1: send sms, 2: send email, 3: call out, 4: send facebook message, required to be 3 for campaign
preview_time	Int	NO	Preview contact before call-out, work with preview dialer, use for auto_dialer_type = 1
max_abandon_rate	Float	NO	Maximum abandon rate, work with predictive dialer, less than 0.1, Use for auto_dialer_type = 3
wait_greeting	File	NO	Wait greeting for predictive dialer, Use for auto_dialer_type = 3
max_waiting_time	Int	NO	Max waiting time when no agents are ready, greater than 30 (seconds), use for auto_dialer_type =3
quota_type	Int	NO	1:quota for all agent, 2:quota for each agent, use for auto_dialer_type = 4
quota_call_out	Int	NO	quota customer for all agent, use for quota_type = 1
time_do_not_call	Int	NO	Call-blocking period (days)

Response:

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

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

Sample request

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

{
    "name": "campaign A"
}

Sample response

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

Edit an outbound campaign

URL: https://icc-api.stringee.com/v1/campaign/ + {campaignId}

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: ""abc"",
        desc1: ""abc"", 
        start_time: "1572627600",
        end_time: "1572714000",
        max_call_retry:1,
        time_between_two_call:60, 
        auto_dialer_type:"1",
        number:"842499966631",
        businesshour:1,
        type: "3",
        preview_time: "30",
        max_abandon_rate: "0",
        wait_greeting: "",
        max_waiting_time: "60"  
}

Field	Type	Require	Description
name	String	NO	Campaign name
desc1	String	NO	Campaign description
start_time	Int	NO	Start time
end_time	Int	NO	End time
max_call_retry	Int	NO	Number of times to retry
time_between_two_call	Int	NO	Interval time between 2 consequential retries, calculate by minutes, the lowest is 10
auto_dialer_type	Int	NO	1: preview, 2: progressive, 3: predictive
number	Int	NO	Call-out number
businesshour	Int	NO	Business-hour ID
type	Int	NO	Type of campaign, forced to choose 3 (call-out)
preview_time	Int	NO	Preview contact before call-out, work with preview dialer
max_abandon_rate	Float	NO	Maximum abandon rate, work with predictive dialer, less than 0.1
wait_greeting	File	NO	Wait greeting for predictive dialer
max_waiting_time	Int	NO	Maximum waiting time when agent not ready, greater than 30 (seconds)

Response:

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

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

Sample request

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

{
    "name": "campaign A"
}

Sample response

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

Update campaign status

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

HTTP method: POST

Content-Type: Application/json

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

POST data (body):

{
        "id": "CATJVSM9",
        "status": 1
}

Field	Type	Require	Description
id	String	YES	Campaign ID
status	Int	YES	Campaign status, 0: New, 1: Approved, 2: Active, 3: Paused, 4: Completed

Response:

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

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

Sample request

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

{
    "id": "CATJVSM9",
    "status": 1
}

Sample response

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

Get all information of campaign

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

HTTP method: GET

Content-Type: Application/json

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

POST data (body):

{
        name: "", 
        start_time_start: "",
        start_time_end: "", 
        end_time_start: "",
        end_time_end: "", 
        status: "", 
        page: 1,
        sort_order: "desc",
        sort_by: "created",
        limit: 10
}

Field	Type	Require	Description
name	String	YES	Campaign name
start_time_start	Int	YES	Start time from
start_time_end	Int	YES	Start time to
end_time_start	Int	YES	End time from
end_time_end	Int	YES	End time to
status	Int	YES	Campaign status, 0: New, 1: Approved, 2: Active, 3: Paused, 4: Completed
page	Int	YES
sort_order	String	YES
sort_by	String	YES
limit	Int	YES

Response:

{
        "message": "Call API success",
        "r": 0,
        "data":
        "rows": [
                0: {
                    account: 16
                    auto_dialer_type: 1
                    business_hour_id: 0
                    callout_number: "+842499966631"
                    created: 1572059450
                    description: "call"
                    end_time: 1572454800
                    id: "CA0CQN2Q"
                    max_abandon_rate: "0.00000"
                    max_call_retry: 2
                    max_waiting_time: 60
                    name: "abc"
                    preview_time: 30
                    project: 25
                    start_time: 1571936400
                    status: 3
                    time_between_two_call: 2
                    type: 3
                    wait_greeting: null
                },
                1: {
                    account: 16
                    auto_dialer_type: 1
                    business_hour_id: 0
                    callout_number: "+842499966631"
                    created: 1572057555
                    description: "abc"
                    end_time: 1572454800
                    id: "CAB4UBEQ"
                    max_abandon_rate: "0.00000"
                    max_call_retry: 2
                    max_waiting_time: 60
                    name: "abc"
                    preview_time: 30
                    project: 25
                    start_time: 1571936400
                    status: 0
                    time_between_two_call: 2
                    type: 3
                    wait_greeting: null
                }
            ]
        "totalCount": "2"
        "totalPages": 1
}

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

Sample request

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

{
    "name": "Campaign A"
}

Sample response

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

Delete campaign

URL: https://icc-api.stringee.com/v1/campaign/ + {campaignId}

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

Field	Type	Require	Description
id	String	YES	Campaign ID

Response:

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

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

Sample request

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

{
    "id": "CATJVSM9"
}

Sample response

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

Suggestions

Create an outbound campaign

Edit an outbound campaign

Update campaign status

Get all information of campaign

Delete campaign