Help Center/ Cognitive Engagement Center/ API Reference/ Telemarketing Outbound Call Interface Reference/ Outbound Result Interface/ Querying Call Records of Automatic and Intelligent Outbound Calls (V2.0.0)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Call Records of Automatic and Intelligent Outbound Calls (V2.0.0)

Scenario

This interface is invoked to query call records of automatic and intelligent outbound calls. Compared with the V1 interface, the V2 interface has the mandatory parameters page and limit and supports pagination query.

This interface can be invoked to query only call records generated in AICC 22.100.0 and later versions.

Method

POST

URI

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/callRecord

In the URL, ip indicates the IP address of the CC-iSales server, and port indicates the HTTPS port number of the CC-iSales server.

Table 1 Parameters in the URL

Parameter

Type

Mandatory or Not

Description

vdnId

Integer

Yes

VDN ID.

The value is an integer ranging from 1 to 9999.

Request Description

Table 2 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Authorization

String

Yes

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

2

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.
Table 3 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

callId

String

Yes

Call record ID, which is used to associate with call data such as CDRs on the CTI. The value is obtained from the callId field returned by the interface described in Querying Outbound Call Results or Calling Back Outbound Call Results.

2

page

Integer

Yes

page indicates the start page to be queried.

The value ranges from 1 to 1000.

3

limit

Integer

Yes

Number of query records on each page.

The value ranges from 1 to 100.

Response Description

  • Status code: 200
    Table 4 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    resultCode

    String

    Yes

    Error code. The value 0200000 indicates success, and other values indicate failure.

    For details about error codes, see Table 5.

    2

    recordList

    List

    No

    Call records.

    2.1

    interNo

    String

    Yes

    Internal number.

    2.2

    systemReply

    String

    Yes

    System reply.

    If the system reply is a voice file in an IVR flow or intelligent IVR flow and the voice file contains noise or music, the voice file cannot be converted into text information accurately.

    Even if a voice or TTS file is interrupted during a call and is not completely played, the queried system reply is a complete voice file.

    2.3

    userSaying

    String

    Yes

    Subscriber reply.

    2.4

    intention

    String

    Yes

    Subscriber intention.

    2.5

    systemReplyTime

    String

    Yes

    System reply time.

    2.6

    requestTime

    String

    Yes

    Subscriber request time.

    2.7

    responseSource

    String

    Yes

    Whether the reply comes from the chatbot or a silent agent.

    The options are 0 (chatbot) and 1 (silent agent).

    3

    resultDesc

    String

    Yes

    Returned description.
  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

Table 5 Error code description

No.

Error Code

Description

1

0200001

Parameter error. For details about the error, see resultDesc.

2

02000001

Empty parameter.

3

02000002

The parameter contains invalid characters.

4

02000003

The parameter length cannot exceed the maximum length.

5

02000004

The parameter length cannot be less than the minimum length.

6

02000005

The parameter length must be within the specified range.

7

02000006

Incorrect parameter type.

8

02000007

Incorrect parameter value.

9

02000008

Parameter conversion error. Check the request parameters.

10

02000009

Incorrect parameter combination. Check the request parameters.

11

02000010

The hour and minute parameters must be set at the same time.

12

02000011

The number of parameters cannot exceed the specified number.

Example

Request header:

Content-Type:application/json;charset=UTF-8
Authorization:XXXXXXXXXXXXXXXXXXXXXXX
Request parameters: 
{
	"callId" : "1688028889-836",
        "page":1,
	"limit":10
}
Response parameters: 
{
  "returnCode": "0200000",
  "recordList": [
    {
      "interNo": "1",
      "userSaying": null,
      "systemReply": "May I ask my colleague in charge to briefly introduce the highlights of the exhibition to you? Enterprises related to foreign trade will be interested in the exhibition.",
      "intention": null,
      "systemReplyTime": "2022-05-31 20:13:08",
      "requestTime": "2022-05-31 20:13:10",
      "responseSource": "0"
    },
    {
      "interNo": "2",
      "userSaying": "null",
      "systemReply": "Hello, welcome to use the intelligent chatbot.",
      "intention": null,
      "systemReplyTime": "2022-05-31 20:13:08",
      "requestTime": "2022-05-31 20:13:08",
      "responseSource": "0"

    }
  ],
  "resultCode": "0200000",
  "resultDesc": "success",
  "returnDesc": "success"
}