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 Reading Outbound Call Data
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for Reading Outbound Call Data

Scenario

This interface is invoked by the OBS to obtain outbound call data of a task.

Method

Post

URI

https://Domain name/rest/isales/v1/openapi/obs/business/callnos. 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 parameters

No.

Parameter

Mandatory or Not

Value Type

Description

1

subCCNo

Yes

Integer

ID of a call center.

2

vdnId

Yes

Integer

ID of a VCC.

3

serviceId

Yes

Integer

Keyword of an outbound call task.

4

batchCount

Yes

Integer

Number of records obtained in this batch.

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

    seviceId

    String

    ID of an outbound call task.

    3

    uniqueId

    String

    Customer ID.

    4

    phoneNumber

    Array

    Called number.

    5

    callData

    String

    Call data received by the agent performing the outbound call task.

    6

    callerNumber

    String

    Calling number.

    7

    ieData

    String

    This parameter consists of two parts:

    1. IE information carried in the outbound call task. Format: IE name:Domain name 1=Domain value 1,Domain name 2=Domain value 2,...,Domain name n=Domain value n. Example: RedInfo:RedInd=1,OldRes=1,Res=1,Count=2;RedNumber:NumPlan=0,NumType=0,NumSi=0,NumPi=0,Number=9558800. In addition, this field can display a specified calling number in the format of callerno:callernumber=12345. In this parameter value, the commas (,), semicolons (;), and colons (:) must be SBC characters, and the letters are case insensitive. The value cannot contain spaces.
    2. SIP data carried in the outbound call task.

    Format: sipdatahead:x-charge:Bob sip:bob@biloxi.com;tag=a\6c,85cf#%#%x-vdf:vender name#$#$

    In the preceding information, #$#$ is the end character, which is used for future extension. #%#% is the separator of each header field.

    Note: The sequence of the two parts cannot be changed. That is, SipData must be the last part of IEData.

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": {
              "taskData":[
                     {
"seviceId:"fadsfa",
"uiqueId":"sfa",
"phoneNumber":["10086","1008611"],
"callData":"1s56fas68dasf",  
"callerNumber":"10086",
"ieData":"xxx"
}
]
} 
}