Interface for Querying the Recordings of Calls Transferred to a Third Party
Description
This interface is invoked to query the recordings of calls transferred from a common IVR to a third party.
Interface Method
POST
URL
https://IP:PORT/oifde/rest/api/queryTransferRecordHistory
Request
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
tenantId |
String |
Body |
Yes |
Tenant ID. |
authToken |
String |
Body |
Yes |
Valid token value for accessing the interface. You can obtain the valid token information by invoking the interface for obtaining tokens. For details, see C3 OIAP Interface Authentication. |
beginTime |
String |
Body |
No |
Start time. Format: yyyy-MM-dd HH:mm:ss |
endTime |
String |
Body |
No |
End time. Format: yyyy-MM-dd HH:mm:ss |
pageNum |
String |
Body |
No |
Page number. Number of the page to be queried. The value 1 is for the first page. If this parameter is not transferred, the default value of page number is 1. |
pageSize |
String |
Body |
No |
Number of records on each page. The value can be 5, 10, 20, 50, or 100. If this parameter is not transferred, 100 records are displayed on each page by default. |
callId |
String |
Body |
No |
Flow call ID. One of the userMobile, callId, and ctiCallId parameters must be transferred. |
userMobile |
String |
Body |
No |
Subscriber number. One of the userMobile, callId, and ctiCallId parameters must be transferred. |
ctiCallId |
String |
Body |
No |
CTI call ID. One of the userMobile, callId, and ctiCallId parameters must be transferred. |
Response
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
errorCode |
Integer |
Body |
Yes |
Error code.
|
errorMessage |
String |
Body |
Yes |
Error description. |
total |
Long |
Body |
No |
Total number of records. |
transferRecordList |
transferRecord[] |
Body |
No |
Call transfer record list (array structure). |
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
id |
String |
Body |
Yes |
Unique ID of a transfer record. |
tenantId |
String |
Body |
Yes |
Tenant ID. |
callId |
String |
Body |
Yes |
Flow call ID. |
ctiCallId |
String |
Body |
Yes |
CTI call ID. |
flowInstId |
String |
Body |
Yes |
Flow instance ID. |
callingNumber |
String |
Body |
Yes |
Calling number (user number). |
calledNumber |
String |
Body |
Yes |
Called flow access code. |
transfNumber |
String |
Body |
Yes |
Number to be transferred to a third-party. |
startTime |
Long |
Body |
Yes |
Start time of a call. The value is in timestamp format. |
endTime |
Long |
Body |
No |
Call end time. The value is in timestamp format. |
recordFilePath |
String |
Body |
No |
Recording file address. |
locationId |
String |
Body |
Yes |
Recording node, which is used when the CTI pool is used. |
opResult |
String |
Body |
Yes |
Transfer result. The options are INIT (start), SUCCESS (successful), and FAIL (failed). |
recordResult |
String |
Body |
No |
Recording result. The options are 0 (success), N/A (no feedback), and other values (failure). |
Example
- Request
{ "authToken": "P********************oN1ix", "tenantId": "202204017094", "beginTime":"2022-02-21 20:04:38", "endTime":"", "pageNum": "1", "pageSize": "5", "callId": "1648805538-165717321823298", "userMobile": "", "ctiCallId": "" }
- Response
{ "errorCode": 0, //Interface success or failure flag. "errorMessage": "success!",//Interface success or failure description. "total": 1,//Total "transferRecordList": [ { "id": "202204013156893697", "tenantId": "202204017094", "callId": "1648805538-165717321823298", "ctiCallId": "1648805538-1657", "flowInstId": "88880301202204011732186311648805538-165717321823298", "callingNumber": "88880301", "calledNumber": "30502", "transfNumber": "88880302", "startTime": 1648805539000, "endTime": 1648805558000, "recordFilePath": "Y:/61/transferrecord/20220401/77448039.wav", "locationId": "0", "opResult": "SUCCESS", "recordResult": "N/A" } ] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot