DocsICP FilingConsole
官方文档
首页

GetCampaign

更新时间：
复制 MD 格式
产品详情
我的收藏

Gets a predictive outbound campaign by its ID from a specified instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

The ID of the instance.

ccc-test
CampaignId

string

Yes

The ID of the campaign.

6badb397-a8b5-40b6-21019d382a09

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0
HttpStatusCode

integer

The HTTP status code.

200
Code

string

The response code.

OK
Data

object

The data returned.

ActualEndTime

integer

The actual end time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.

1634008800000
ActualStartTime

integer

The actual start time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.

1634000460000
CasesAborted

integer

The number of aborted contacts.

0
CasesUncompleted

integer

The number of uncompleted contacts.

0
CasesConnected

integer

The number of connected contacts.

40
MaxAttemptCount

integer

The maximum number of call attempts for each contact. If an attempt fails, the contact is redialed until this limit is reached.

1
MinAttemptInterval

integer

The minimum interval, in seconds, to wait before redialing a failed call.

1
Name

string

The name of the predictive outbound campaign.

test-campaign
PlanedEndTime

integer

The planned end time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.

1634054400000
PlanedStartTime

integer

The planned start time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.

1633968000000
QueueName

string

The name of the associated skill group.

测试技能组
TotalCases

integer

The total number of contacts.

100
State

string

The state of the predictive outbound campaign.

Valid values:

  • Draft :

    The campaign is a draft.

  • Completed :

    The campaign has finished.

  • Executing :

    The campaign is running.

  • Pending :

    The campaign is scheduled to start.

  • Aborted :

    The campaign was canceled.

  • Paused :

    The campaign is temporarily stopped.

Completed
CampaignId

string

The ID of the predictive outbound campaign.

6badb397-a8b5-40b6-21019d382a09
StrategyType

string

The dialing strategy for the predictive outbound campaign.

Valid values:

  • PACING :

    A fixed-ratio dialing strategy. The number of outbound calls = number of idle agents × ratio.

  • PID :

    A Proportional-Integral-Derivative (PID) control strategy. The system automatically adjusts the number of outbound calls.

PACING
StrategyParameters

string

The strategy parameters for the predictive outbound campaign, in JSON format. For a PID strategy, the format is {"abandonRate":"5","historicalConnectedRate":"35"}. For a PACING strategy, the format is {"ratio":1}. abandonRate specifies the target abandon rate, historicalConnectedRate specifies the historical connection rate for reference, and ratio specifies the fixed dialing ratio.

{"ratio":1}
QueueId

string

The ID of the associated skill group.

skillgroup@ccc-test
Simulation

boolean

Indicates whether the campaign is a test simulation. This parameter is not intended for production use.

false
SimulationParameters

string

The parameters for a test simulation. This parameter is not intended for production use.

无
CasesUncompletedAfterAttempted

integer

The number of attempted but unconnected contacts that are still eligible for redial.

1
CasesUncompletedAfterAttempt

string

CompletionRate

number

The ratio of connected contacts to the total number of contacts.

ContactFlowId

string

The ID of the associated Contact Flow.

Examples

Success response

JSON format

{
  "RequestId": "6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Data": {
    "ActualEndTime": 1634008800000,
    "ActualStartTime": 1634000460000,
    "CasesAborted": 0,
    "CasesUncompleted": 0,
    "CasesConnected": 40,
    "MaxAttemptCount": 1,
    "MinAttemptInterval": 1,
    "Name": "test-campaign",
    "PlanedEndTime": 1634054400000,
    "PlanedStartTime": 1633968000000,
    "QueueName": "测试技能组",
    "TotalCases": 100,
    "State": "Completed",
    "CampaignId": "6badb397-a8b5-40b6-21019d382a09",
    "StrategyType": "PACING",
    "StrategyParameters": "{\"ratio\":1}",
    "QueueId": "skillgroup@ccc-test",
    "Simulation": false,
    "SimulationParameters": "无",
    "CasesUncompletedAfterAttempted": 1,
    "CasesUncompletedAfterAttempt": "",
    "CompletionRate": 0,
    "ContactFlowId": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.