Help Center/ Cognitive Engagement Center/ API Reference/ Telemarketing Outbound Call Interface Reference/ Querying Interface Invocation Records
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Interface Invocation Records

Scenario

This interface is invoked to query third-party interface invocation details and provided for the scenario where interface invocation records need to be queried.

Usage Description

  • Prerequisites
    • The corresponding AK/SK authentication permission is available.
    • You have applied for a developer account.

Method

This interface supports only the POST method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calllogs

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

No.

Parameter

Type

Mandatory or Not

Description

1

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

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

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

No.

Parameter

Type

Mandatory or Not

Description

1

offset

Integer

Yes

Parameter for determining the start page of the query.

Value of offset = Value of limit x (Value of page – 1)

page indicates the start page to be queried.

2

limit

Integer

Yes

Number of query records on each page. The value ranges from 1 to 100.

3

url

String

No

Invocation URL.

If this parameter is set, the URL invocation records are queried.

If this parameter is left empty, all interface invocation records are queried.

4

beginTime

String

Yes

Start time.

The format is yyyy-MM-dd HH:mm:ss.

5

endTime

String

Yes

End time.

The format is yyyy-MM-dd HH:mm:ss.

The interval between the start time and end time cannot exceed seven days.

Response Description

Table 4 Response body parameters

No.

Parameter

Type

Description

1

resultCode

String

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

For details, see error code description in "Table 6."

2

resultDesc

String

Description.

3

result

OpenapiLog

Scenario type list.

4

returnCode

String

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

For details, see Table 6.

5

returnDesc

String

Description.
Table 5 OpenapiLog

No.

Parameter

Type

Description

1

id

String

Log ID.

2

operTime

Datetime

Log time.

3

url

String

Invocation URL.

4

request

Object

Input parameter.

5

resultCode

String

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

For details, see Table 6.

6

resultDesc

String

Description.

7

httpStatus

Integer

Interface invocation status code.

8

type

String

Request type.

Error Codes

Table 6 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

  • The following provides an example of the request body of this interface: 
    {"limit": 10,"offset": 0,"beginTime": "2022-08-20 15:55:55","endTime": "2022-08-23 15:55:55","url":""}
  • The following provides an example of the response body of this interface: 
    {
  "result": [
    {
      "request": "{\"defId\":\"456\",\"vdnId\":2}",
      "httpStatus": 200,
      "resultCode": "0200000",
      "id": "166088991109059950708365448582",
      "resultDesc": "queryObsResultDetail success",
      "url": "/rest/isales/v1/openapi/campaigns/2/456/queryObsResultDetail",
      "operTime": "2022-08-19T14:18:31.000+00:00",
      "type": "GET"
    }
  ],
  "returnCode": "0200000",
  "resultCode": "0200000",
  "count": 1,
  "resultDesc": "queryCalllogs success",
  "returnDesc": "queryCalllogs success"
}