# Get Specific Campaign Details

## <span style="color: rgb(2, 106, 73);">**API: getCampaignInfo**</span>

###  **Description**

Retrieves detailed information about a specific campaign, including its settings, dial statuses, configurations, and associated transfer groups.

## 🔗 **URL**

#### https://**DOMAIN**.croco-dial.net/goAPIv2/goCampaigns/goAPI.php

<p class="callout info align-left">**Note:** Replace `DOMAIN` with the specific domain you want to query.</p>

### **📝 Required Parameters**  


<table border="1" id="bkmrk-parameter-value-desc" style="border-collapse: collapse; width: 100%; height: 178.667px;"><colgroup><col style="width: 23.0031%;"></col><col style="width: 20.0234%;"></col><col style="width: 56.9715%;"></col></colgroup><thead><tr style="height: 29.6px;"><td style="height: 29.6px;">**Parameter**</td><td style="height: 29.6px;">**Value**</td><td style="height: 29.6px;">**Description**</td></tr></thead><tbody><tr style="height: 29.6px;"><td style="height: 29.6px;">goAction</td><td style="height: 29.6px;">getCampaignInfo</td><td style="height: 29.6px;">Action to retrieve campaign details and settings.</td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;">goUser</td><td style="height: 29.6px;">MyUser</td><td style="height: 29.6px;">API authorized user.</td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;">goPass</td><td style="height: 29.6px;">MyPass</td><td style="height: 29.6px;">Password for the API authorized user.</td></tr><tr><td style="height: 29.6px;">campaign\_id</td><td style="height: 29.6px;">MyCampaignID</td><td style="height: 29.6px;">The ID of the campaign you want to retrieve information for.</td></tr><tr style="height: 30.6667px;"><td style="height: 30.6667px;">responsetype</td><td style="height: 30.6667px;">json/xml</td><td style="height: 30.6667px;">Format of the response (`json` recommended).</td></tr></tbody></table>

**Note:** This endpoint uses body parameters for authentication instead of tokens or headers.

### **Request Examples:**

#### **GET:** 

```bash
curl -X GET "https://DOMAIN.croco-dial.net/goAPIv2/goCampaigns/goAPI.php?goAction=getCampaignInfo&goUser=MyUser&goPass=MyPass&campaign_id=MyCampaignID&responsetype=json"

```

#### **POST (Form Data):**

If you prefer to send the data as form parameters:

```bash
curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goCampaigns/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=getCampaignInfo" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=Mypass" \
  --data-urlencode "responsetype=json" \
  --data-urlencode "campaign_id=11111111"

```

####  **Example Response**

```json
{
  "result": "success",
  "data": {
    "campaign_id": "1234567",
    "campaign_name": "CUTSERVICE",
    "active": "Y",
    "dial_status_a": null,
    "dial_status_b": "",
    "lead_order": "DOWN_LAST_CALL_TIME",
    "hopper_level": 1000,
    "auto_dial_level": "3",
    "next_agent_call": "longest_wait_time",
    "local_call_time": "24hrs",
    "dial_timeout": 30,
    "dial_prefix": "903",
    "campaign_cid": "123456789",
    "campaign_script": "SCRIPT001",
    "campaign_recording": "ALLFORCE",
    "closer_campaigns": "AGENTDIRECT, CUTSERVICE",
    "drop_call_seconds": 1,
    "drop_action": "IN_GROUP",
    "wrapup_seconds": 0,
    "manual_dial_list_id": 999999999,
    "queue_priority": 50,
    "default_xfer_group": "AGENTDIRECT",
    "survey_method": "AGENT_XFER",
    "survey_dtmf_digits": "1238",
    "survey_xfer_exten": "8300",
    "use_internal_dnc": "Y",
    "manual_dial_timeout": "30",
    "three_way_call_cid": "CAMPAIGN",
    "three_way_dial_prefix": "903",
    "callback_days_limit": 0,
    "campaign_description": null,
    "campaign_calldate": "2025-05-07 11:51:49"
  },
  "campaign_type": "OUTBOUND",
  "custom_fields_launch": "ONCALL"
}

```


### **Response Structure** 

<table border="1" id="bkmrk-field-type-descripti" style="border-collapse: collapse; border-color: rgb(206, 212, 217);"><thead><tr><td style="border-color: rgb(206, 212, 217);">**Field**</td><td style="border-color: rgb(206, 212, 217);">**Type**</td><td style="border-color: rgb(206, 212, 217);">**Description**</td></tr></thead><tbody><tr><td style="border-color: rgb(206, 212, 217);">`data`</td><td style="border-color: rgb(206, 212, 217);">`object`</td><td style="border-color: rgb(206, 212, 217);">Contains all the campaign details.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_id`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Unique ID of the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_name`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The name of the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `active`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Whether the campaign is active (`Y`) or not (`N`).</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `dial_status_a` to `dial_status_e`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The dial statuses associated with the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `lead_order`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Specifies the order of leads in the hopper.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `hopper_level`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Number of leads loaded into the hopper.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `auto_dial_level`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The auto-dial level for the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `next_agent_call`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Specifies the method for the next agent call assignment.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `local_call_time`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Time restrictions for dialing.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `dial_timeout`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Time in seconds before the call times out.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `dial_prefix`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The prefix added to dialed numbers.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_cid`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Caller ID for the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_script`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The script associated with the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_recording`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Indicates the call recording policy.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `closer_campaigns`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">List of related closer campaigns.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `drop_call_seconds`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Seconds before considering the call as "dropped".</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `drop_action`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Action to take when a call is dropped.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `wrapup_seconds`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Time for agents to wrap up after a call.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `wrapup_message`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Message displayed during the wrap-up.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `manual_dial_list_id`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">List ID for manual dialing.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `queue_priority`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Priority of this campaign in the call queue.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `default_xfer_group`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Default transfer group for calls.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `survey_method`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Method for handling survey calls (e.g., `AGENT_XFER`).</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `survey_dtmf_digits`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">DTMF digits used for survey responses.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `survey_xfer_exten`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Extension for survey transfers.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `use_internal_dnc`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Whether the campaign uses the internal Do Not Call list (`Y`/`N`).</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `manual_dial_timeout`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Timeout for manual dial attempts.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `three_way_call_cid`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Caller ID for three-way calls.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `three_way_dial_prefix`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Dial prefix for three-way calls.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `callback_days_limit`</td><td style="border-color: rgb(206, 212, 217);">`number`</td><td style="border-color: rgb(206, 212, 217);">Maximum days allowed for scheduled callbacks.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_description`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Optional description of the campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">└── `campaign_calldate`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">The last call date for this campaign.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">`campaign_type`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Specifies if the campaign is `INBOUND`, `OUTBOUND`, or `BLENDED`.</td></tr><tr><td style="border-color: rgb(206, 212, 217);">`custom_fields_launch`</td><td style="border-color: rgb(206, 212, 217);">`string`</td><td style="border-color: rgb(206, 212, 217);">Indicates if custom fields are launched during the call (`ONCALL`).</td></tr></tbody></table>