DOKUMEN API CALL
C-iCare System
V2.0
August 2025
The information in this document shall not be disclosed outside organization and shall not be
duplicated. used or disclosed in whole or in part for any purpose other than to evaluate the
document, provided that if a contract is awarded to C-iCare as a result of or in connection with the
submission of this document, shall have the right to duplicate, use or disclose the information to the
extent provided by the contract. The restriction does not limit the right of to use information
contained in this document if it is obtained from another source without restriction
Contact Support
WA Only: +62 899-0955-155
API CAMPAIGN
1. Generate Token
INFO This API is used to retrieve user information based on the given user ID or
query parameters
URL [Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {API KEY}
- Status: 200
- Content-Type: application/json
{
"status": true,
"api_token": "xxxxxxxxxxx",
"expired_at": "2025-10-03 12:16:46"
RESPONSE }
• This function ensures that only authenticated and authorized requests can
execute campaign actions.
• When the token expires, clients must call the token generation endpoint again
to get a new valid token.
2. Get Campaign
INFO This API is used to retrieve user information based on the given user ID or
query parameters
URL [Link]
METHOD GET
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
C-iCare (Costumer Care System) 2
Contact Support
WA Only: +62 899-0955-155
- Status: 200
- Content-Type: application/json
{
"status": true,
"response": "Success",
"messages": "Campaign list retrieved successfully",
"data": [
{
"campaign_name": "All Agent",
"campaign_type": "predictiveicare",
"start_date": "2025-08-10",
"end_date": "2026-08-10",
"stime_perday": "00:00:00",
"etime_perday": "23:00:00",
"retries": "3",
"dialerstatus": "0",
RESPONSE "campaign_key": "XXXX"
},
{
"campaign_name": "postponed 489001",
"campaign_type": "predictiveicare",
"start_date": "2025-08-10",
"end_date": "2025-08-20",
"stime_perday": "08:00:00",
"etime_perday": "17:00:00",
"retries": "3",
"dialerstatus": "0",
"campaign_key": "XXXX"
}
],
"timestamp": 1754879927
}
3. Info Campaign
INFO This API allows you to create a new user in the system. Required inputs include
basic user information such as name, and role.
URL [Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
BODY {
"campaign_code": "XXXX"
C-iCare (Costumer Care System) 3
Contact Support
WA Only: +62 899-0955-155
• Campaign_code (string, required):
The campaign code is a unique code for each campaign. It has 15 characters
consisting of letters and numbers.
Code : 200
{
"status": true,
"response": "Success",
"messages": "Campaign retrieved successfully",
"campaign_code": "XXXX",
"data_campaign": {
"campaign_name": "XXXX 489001",
"start_date": "2025-08-10",
"end_date": "2025-08-20",
"stime_perday": "08:00:00",
"etime_perday": "17:00:00",
"retries": "3",
"dialerstatus": "0",
"outbound_type": "predictiveicare",
"ratio": "3",
RESPONSE "waittime_call": "60",
"agents": [
"489001"
],
"form": [
"phonenumber",
"leadid"
]
},
"timestamp": 1754880461
}
Code : 400
{
"status": false,
"response": "Error",
"message": "Campaign tidak ditemukan"
}
4. Add & Remove Agent Campaign
INFO This API allows you to create a new user in the system. Required inputs include
basic user information such as name, and role.
C-iCare (Costumer Care System) 4
Contact Support
WA Only: +62 899-0955-155
URL [Link]
[Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
{
"campaign_code": "xxxx",
"agents": ["489001", "489002"]
}
• campaign_code (string, required):
The campaign code is a unique identifier for each campaign. It consists of 15
BODY alphanumeric characters (a combination of letters and numbers) that uniquely
represent the campaign in the system.
• agents (array of strings, required):
A list of agent IDs to be associated with the campaign. Each ID must be provided as a
string.
Code : 200
Add Agent
{
"status": true,
"response": "Success",
"messages": "Agents added successfully",
"timestamp": 1754881130
}
Remove Agent
{
RESPONSE "status": true,
"response": "Success",
"messages": "Agents Remove successfully",
"timestamp": 1754881147
}
Code : 400
{
"status": false,
"response": "Error",
"message": "Campaign not found"
}
C-iCare (Costumer Care System) 5
Contact Support
WA Only: +62 899-0955-155
5. Send Data
INFO This API allows you to create a new user in the system. Required inputs include
basic user information such as name, and role.
URL [Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
{
"campaign_code": "xxxx",
"data_campaign": [
{
"phonenumber": "0827483434",
"leadid": "87364434"
}
]
}
• campaign_code (string, required):
The unique identifier for the campaign. It consists of 15 alphanumeric
characters (letters and numbers) that identify a specific campaign in the
BODY system.
• data_campaign (array, required):
An array containing one or more lead records for the campaign.
Each record includes:
o phonenumber (string) – The phone number of the lead.
o leadid (string) – The unique ID of the lead.
Important:
The phonenumber and leadid fields here are only examples. The actual field names
and structure are determined by the campaign’s header definition, which can be
retrieved from the API INFO endpoint.
Each campaign may have different fields depending on its configuration.
Code : 200
{
"status": true,
RESPONSE
"response": "Success",
"messages": "Inserted successfully",
"timestamp": 1754881582
}
C-iCare (Costumer Care System) 6
Contact Support
WA Only: +62 899-0955-155
Code : 400
{
"status": false,
"response": "Error",
"message": "Campaign not found"
}
{
"status": false,
"response": "Error",
"messages": "No data to insert",
"timestamp": 1754881638
}
6. Delete Data
INFO This API allows you to create a new user in the system. Required inputs include
basic user information such as name, and role.
URL [Link]
METHOD DELETE
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
{
"campaign_code": "PdYxFD6OVXInW9g",
"type_delete": "all",
"data_campaign": [
{
"leadid": "8736422434"
},
{
"leadid": "34354646"
}
]
BODY }
• campaign_code (string, required)
A unique 15-character alphanumeric code that identifies the campaign.
This value can be retrieved from the API INFO endpoint.
• type_delete (string, required, enum: all, notcall)
Determines the delete operation mode:
o all → Deletes all campaign data matching the given leadid(s).
o notcall → Deletes only campaign data that has not been called for
the given leadid(s).
• data_campaign (array, required)
A list of objects containing leadid(s) that should be deleted.
C-iCare (Costumer Care System) 7
Contact Support
WA Only: +62 899-0955-155
o leadid (string, required)
Unique identifier of the campaign data record.
Code : 200
{
"status": true,
"response": "Success",
"messages": "campaign data has been deleted successfully"
}
RESPONSE
Code : 400
{
"status": false,
"response": "Error",
"message": "Campaign not found"
}
7. Report Preview/AutoDial
URL [Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
BODY {
"campaign_code": "{CAMPAIGN CODE}",
"data": {
"startdate": "2024-11-01",
"enddate": "2024-11-05",
"page": "1"
}
}
DESCRIPTION • Campaign_code • string
BODY • stardate • date
• enddate • date
• page • integer
RESPONSE {
SUCCESS "status": true,
"data": [
{
"form_id_customer": "123",
"form_phone_number": "08888888888",
"assignment": "270001",
"upload_date": "2024-11-04 09:11:04",
"caller": "270001",
"attemp": "1",
C-iCare (Costumer Care System) 8
Contact Support
WA Only: +62 899-0955-155
"start_date": "2024-11-04 13:35:32",
"end_date": "2024-11-04 13:35:32",
"response_status": "",
"call_status": "Uncontacted",
"status": "Ringing No Pick Up",
"duration": "00:00:00",
"note": "",
"recordingfile": ""
}
],
"total_data": 1,
"page": "1",
"total_page": 1
}
8. Report Predictive
URL [Link]
METHOD POST
HEADER • Content-Type : application/json
• Authorization : Bearer {TOKEN}
BODY {
"campaign_code": "{CAMPAIGN CODE}",
"data": {
"startdate": "2024-11-01",
"enddate": "2024-11-05",
"page": "1"
}
}
DESCRIPTION • Campaign_code • string
BODY • stardate • date
• enddate • date
• page • integer
RESPONSE {
SUCCESS "status": true,
"data": [
{
"form_id_customer": "123",
"form_phone_number": "08888888888",
"assignment": "270001",
"upload_date": "2024-11-04 09:11:04",
"caller": "270001",
"attemp": "1",
C-iCare (Costumer Care System) 9
Contact Support
WA Only: +62 899-0955-155
"start_date": "2024-11-04 13:35:32",
"end_date": "2024-11-04 13:35:32",
"response_status": "",
"call_status": "Uncontacted",
"status": "Ringing No Pick Up",
"duration": "00:00:00",
"note": "",
"recordingfile": ""
}
],
"total_data": 1,
"page": "1",
"total_page": 1
}
C-iCare (Costumer Care System) 10