ListAttempts

更新时间:
复制 MD 格式

You can invoke ListAttempts to obtain the list of contact dialing records for a specified predictive outbound calling Activity under 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

Instance ID

ccc-test

CampaignId

string

Yes

Predictive outbound dialing Activity ID.

6badb397-a8b5-40b6-21019d382a09

StartTime

integer

No

Start Time. This parameter is optional. If not specified, it defaults to the Start Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.

1634115688291

EndTime

integer

No

End Time. This parameter is optional. If not specified, it defaults to the End Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.

1634115698291

QueueId

string

No

Filter by skill group ID. This parameter is optional and defaults to empty, which means no filtering is applied.

skillgroup@ccc-test

CaseId

string

Yes

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

60ecb1a2-4480-4d01-bede-c5b7655bfadf

AttemptId

string

No

Call record ID, which has the same value as the call ID.

job-16976964500325****

ContactId

string

No

Filter by call ID. This parameter is optional and defaults to empty.

job-16976964500325****

AgentId

string

No

Filter by agent ID. This parameter is optional and defaults to empty.

agent@ccc-test

Caller

string

No

Filter by caller number. This parameter is optional and defaults to empty.

05711234****

Callee

string

No

Filter by called number. Optional. Default is empty.

1888888****

PageNumber

integer

Yes

Page number. The product of PageNumber and PageSize must not exceed 10 000.

1

PageSize

integer

Yes

Page size. The product of PageNumber and PageSize must not exceed 10 000.

100

Criteria

string

No

Extended query conditions in JSON format. Currently supports caseIds for batch queries.

{"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}

Response elements

Element

Type

Description

Example

object

Schema of Response

Code

string

Response code.

OK

HttpStatusCode

integer

HTTP status code.

200

Message

string

Response message.

RequestId

string

Request ID.

7CC6523B-0E51-1B62-8DA5-6A9831CAE315

Data

object

Data.

TotalCount

integer

Total count.

1

PageNumber

integer

Page number. The product of PageNumber and PageSize must not exceed 10 000.

1

PageSize

integer

Page size. The product of PageNumber and PageSize must not exceed 10 000.

100

List

array<object>

List of contact dialing records.

object

Contact dialing record.

AttemptId

string

Call ID.

job-1704342174816****

ContactId

string

The call ID.

job-1704342174816****

CaseId

string

A contact ID generated by the system. Customers do not need to be concerned with this value.

21d194a7-60b7-4824-932b-48ed03a83704

CampaignId

string

Predictive outbound dialing Activity ID.

083046e3-5822-4cda-9b84-04f2a02eb605

InstanceId

string

The instance ID.

ccc-test

QueueId

string

The skill group ID.

skillgroup@ccc-test

Caller

string

Calling number.

05711234****

Callee

string

Callee number.

1888888****

AgentId

string

Agent ID.

agent@ccc-test

DialTime

integer

Time when the dial-up was initiated, in UNIX timestamp format, in milliseconds.

1634196283974

DialDuration

integer

The dial-up duration, in seconds.

2734

CustomerEstablishedTime

integer

The time when the Customer answered the call, formatted as a UNIX timestamp in milliseconds.

1634196286708

CustomerReleasedTime

integer

The time when the Customer hung up, formatted as a UNIX timestamp in milliseconds.

1634196317888

EnterIvrTime

integer

The time when the call was transferred into IVR, formatted as a UNIX timestamp in milliseconds.

1634196286740

IvrDuration

integer

The duration spent in IVR, in seconds.

1049

EnqueueTime

integer

The time when the contact entered the queue, in Unix timestamp format, in milliseconds.

1634196287789

QueueDuration

integer

The queue duration, in seconds.

80

AssignAgentTime

integer

The time when the agent was assigned, formatted as a UNIX timestamp in milliseconds.

1634196287869

AgentRingDuration

integer

Agent ring duration, in seconds.

23

AgentEstablishedTime

integer

The time when the agent answered the call, in Unix timestamp format, in milliseconds.

1632883592732

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "7CC6523B-0E51-1B62-8DA5-6A9831CAE315",
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 100,
    "List": [
      {
        "AttemptId": "job-1704342174816****",
        "ContactId": "job-1704342174816****",
        "CaseId": "21d194a7-60b7-4824-932b-48ed03a83704",
        "CampaignId": "083046e3-5822-4cda-9b84-04f2a02eb605",
        "InstanceId": "ccc-test",
        "QueueId": "skillgroup@ccc-test",
        "Caller": "05711234****",
        "Callee": "1888888****",
        "AgentId": "agent@ccc-test",
        "DialTime": 1634196283974,
        "DialDuration": 2734,
        "CustomerEstablishedTime": 1634196286708,
        "CustomerReleasedTime": 1634196317888,
        "EnterIvrTime": 1634196286740,
        "IvrDuration": 1049,
        "EnqueueTime": 1634196287789,
        "QueueDuration": 80,
        "AssignAgentTime": 1634196287869,
        "AgentRingDuration": 23,
        "AgentEstablishedTime": 1632883592732
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.