Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ Other Interfaces/ Jointly Commissioning the CC-iSales and CTI-OBS/ Interface for Obtaining Interface Information
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for Obtaining Interface Information

Scenario

This interface provides interface paths for the CTI-OBS.

Method

Post

URI

https://Domain name/rest/isales/v1/openapi/obs/business/interface. An example of the domain name is service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Value Type

Mandatory or Not

Description

1

Authorization

String

Yes

Authentication field.

2

Content-Type

String

No

The value is application/json.
Table 2 Request body parameter

No.

Parameter

Mandatory or Not

Value Type

Description

1

version

Yes

String

Version information.

Response Description

  • Response status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Value Type

    Description

    1

    result

    String

    Error code. The options are as follows:

    0: success

    Other values: failure

    2

    resultData

    Object

    Object in the returned result after a successful query.
    Table 4 resultData object

    No.

    Parameter

    Value Type

    Description

    1

    version

    String

    Version information.

    2

    refreshToken

    String

    Path of the request for refreshing the token.

    3

    getTask

    String

    Path of the request for obtaining a task.

    4

    getUserData

    String

    Path of the request for reading outbound call data.

    5

    getHoliDay

    String

    Path of the request for obtaining holiday information.

    6

    pushCallOutRlt

    String

    Path of the request for writing back results.

    7

    pushMidRlt

    String

    Path of pushing intermediate status.

    8

    pushTaskStatus

    String

    Path of updating the intermediate status of a task.

Error Codes

  • Response status code: 400

    Incorrect request. Check the request path and parameters.

  • Response status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Response status code: 403

    Authentication failed.

  • Response status code: 404

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

  • Response status code: 500

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

Example

  • Request header:
Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae
Content-Type:application/json

  • Request message:
{
"version":311
}

  • Response message: 
    {
"result":0,  // 0: success; other values: failure
    "resultData": {
        "version":310,
        "refreshToken":"/iSales/refreshToken ",
        "getTask":"/iSales/getTask", 
        "getUserData":"/iSales/getUserData",
"getHoliDay":"/iSales/ getHoliDay",
"pushCallOutRlt":"/iSales/pushCallOutRlt",
"pushMidRlt":"/iSales/ pushMidRlt",
"pushTaskStatus":"/iSales/pushTaskStatus", // Optional
}
}