DocsICP FilingConsole
官方文档
首页

ListCases

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

Invoke ListCases to obtain the execution details list of the outbound contact list for the predictive dialing Activity corresponding to the specified ID under the 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

Instance ID.

ccc-test
CampaignId

string

Yes

Predictive outbound dialing activity ID.

6badb397-a8b5-40b6-21019d382a09
PhoneNumber

string

No

Filters by phone number. Fuzzy Matching is not supported. This parameter is not Required and defaults to empty.

无
PageNumber

integer

Yes

The paging ordinal number, ranging from 1 to 100.

1
PageSize

integer

Yes

Page size, ranging from 1 to 100.

100
State

string

No

Pending (to be dialed)
Executing (dialing in progress)
Connected (contact succeeded)
Failed (contact failed)
Aborted (call stopped or canceled)
Forbidden (call prohibited by rule, such as blacklist)

Pending

Response elements

Element

Type

Description

Example

object

RequestId

string

Request ID.

7CC6523B-0E51-1B62-8DA5-6A9831CAE316
Message

string

Response message.

无
HttpStatusCode

integer

HTTP status code.

200
Code

string

Response code.

OK
Data

object

Data.

PageNumber

integer

Page number, ranging from 1 to 100.

1
PageSize

integer

Page size, ranging from 1 to 100.

100
TotalCount

integer

Total count.

1
List

array<object>

List of contact list execution details.

object

Contact list execution details.

AbandonType

string

The type of call abandonment, that is, the reason why the call was not successfully connected.

Valid values:

  • NA :

    Not abandoned

  • IVR :

    IVR interaction phase

  • Ringing :

    Agent ringing phase

  • Queuing :

    Queuing phase

NA
AttemptCount

integer

Number of attempts, which is the total number of calls made to this contact.

1
FailureReason

string

Reason for outbound call failure.

Valid values:

  • AbandonedInQueue :

    Abandoned in queue

  • AbandonedInRing :

    Abandoned during ringing

  • AbandonedInIVR :

    Abandoned in IVR

  • NoAnswer :

    Customer did not answer

  • QueuingTimeout :

    Queue timeout

  • Reject :

    Customer rejected the call

  • Voicemail :

    Transferred to voicemail

  • QueuingFailed :

    Failed to transfer to agent

  • QueuingOverflow :

    Queue overflow

  • AbandonedInVoiceNavigator :

    Abandoned in Intelligent Voice Navigator

  • IVRException :

    IVR abnormal

  • ForwardToOutsideNumber :

    Forwarded to external number

无
PhoneNumber

string

Phone number.

1888888****
State

string

Status.

Valid values:

  • Connected :

    Succeeded

  • Failed :

    Failed

  • Executing :

    Dialing

  • Pending :

    Pending

  • Aborted :

    Aborted

Connected
CaseId

string

System-generated contact ID. Customers do not need to concern themselves with this.

60ecb1a2-4480-4d01-bede-c5b7655bfadf
CustomVariables

string

Custom variables defined by the customer, formatted as a JSON object. The object can contain up to 10 properties, each with a name and value defined by the customer. These can be configured when creating a predictive outbound dialing activity.

{"name":"yy","客戶标签":"tag-yy"}
AbandonPhase

string

Phase at which the call was abandoned.

  • IVR (IVR interaction phase)

  • Queuing (queuing phase)

  • Ringing (agent ringing phase)

Ringing

Examples

Success response

JSON format

{
  "RequestId": "7CC6523B-0E51-1B62-8DA5-6A9831CAE316",
  "Message": "无",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Data": {
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 1,
    "List": [
      {
        "AbandonType": "NA",
        "AttemptCount": 1,
        "FailureReason": "无",
        "PhoneNumber": "1888888****",
        "State": "Connected",
        "CaseId": "60ecb1a2-4480-4d01-bede-c5b7655bfadf",
        "CustomVariables": "{\"name\":\"yy\",\"客戶标签\":\"tag-yy\"}",
        "AbandonPhase": "Ringing"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.