logo

Getting Details for a Specific CallId

Request URL

  • POST /api/v1/call-calls/simpleDetail

Request Parameters

ParameterTypeNullableDescription
TimestampLongFalseTimestamp (e.g., current seconds, 1533092860)
TokenStringFalseSignature: Authentication signature
AppIdStringFalseTenant ID
callIdStringFalseCall identifier

Token Signature Calculation Example

StringBuilder src = new StringBuilder();
src.append(AppId).append(Timestamp);
String appSecret = "eff790c4-90a5-4453-990c-ff7d4aa30914";
HmacUtils hmacUtils = new HmacUtils(HmacAlgorithms.HMAC_SHA_1, appSecret);
String token = hmacUtils.hmacHex(src.toString());

Response Parameters

ParameterTypeNullableDescription
succeedbooleanFalseProcessing indicator (not currently in use)
codeStringFalseReturn code
messageStringFalseReturn message
visiblebooleanFalseVisibility indicator (not currently in use)
dataObjectTrueResult
data.callIdStringFalseCall identifier
data.workflowintFalseCall type (1 inbound 2 outbound direct dial 3 two-way callback 4 automatic outbound)
data.fromNumberStringFalseCaller number
data.toNumberStringFalseCallee number
data.relayNumberStringFalseRelay number
data.callStartTimedateFalseCall start time (e.g., yyyy-MM-dd HH:mm:ss)
data.callEndTimedateFalseCall end time (e.g., yyyy-MM-dd HH:mm:ss)
data.callDurationintFalseTotal call duration (seconds)
data.callRecordUrlStringTrueCall recording URL
data.customerProvinceStringTrueCustomer location - Province
data.customerCityStringTrueCustomer location - City
data.routerIdintTrueRouter ID
data.routerNameStringTrueRouter name
data.transferAgentFlagintTrueTransfer to agent flag (0 no 1 yes)
data.agentIdStringTrueAgent ID
data.agentNameStringTrueAgent name
data.queueIdStringTrueQueue ID
data.queueNameStringTrueQueue name
data.robotNamesArrayTrueRobot names array (["Robot 1", "Robot 2"])
data.labelInfosArrayTrueGeneral label array (["Fruit", "Heavy"])
data.instancesArrayTrueDialogue records
data.instances[].callIdStringTrueCall identifier
data.instances[].instanceIdintTrueRobot case identifier
data.instances[].robotIdintTrueRobot identifier
data.instances[].robotDefIdintTrueRobot def identifier
data.instances[].robotNameStringTrueRobot name
data.instances[].dialogueStartTimedateTrueDialogue start time
data.instances[].dialogueEndTimedateTrueDialogue end time
data.instances[].dialogueDurationintTrueTotal dialogue duration (seconds)
data.instances[].dialogueRecordUrlStringTrueDialogue recording URL
data.instances[].dialogueRoundintTrueDialogue rounds
data.instances[].intentionLabelKeyStringTrueIntention label identifier
data.instances[].intentionLabelNameStringTrueIntention label name
data.instances[].labelInfoListArrayTrueLabel information
data.instances[].labelInfoList[].nameStringTrueLabel name
data.instances[].dialogueContentListArrayTrueDialogue content
data.instances[].dialogueContentList[].callIdStringTrueCall identifier
data.instances[].dialogueContentList[].instanceIdintTrueSession identifier
data.instances[].dialogueContentList[].robotIdintTrueRobot ID
data.instances[].dialogueContentList[].robotDefIdintTrueRobot definition id
data.instances[].dialogueContentList[].dialogueRoleintTrueDialogue role (1 robot 2 user 9 system)
data.instances[].dialogueContentList[].dialogueStartTimedateTrueDialogue end time
data.instances[].dialogueContentList[].dialogueContentStringTrueDialogue content
data.instances[].dialogueContentList[].dialogueRecordUrlStringTrueDialogue recording URL
data.instances[].dialogueContentList[].matchTypeintTrueMatched type (1 hit question 2 hit answer branch 3 hit node repeat 4 hit global config 10 not hit)
data.instances[].dialogueContentList[].matchResultStringTrueMatch result
data.instances[].dialogueContentList[].matchNameStringTrueMatch name
data.callResultintTrue1 customer not answered 2 customer answered 3 agent answered 4 agent not answered 5 line busy 6 line off 7 agent rejected 8 customer quick hang up 9 customer hung up 10 queue timeout 11 queue abandoned 12 no queue selected 13 external answered 14 external not answered
data.userAnsweredFlagintTrueEffective call (0 no 1 yes)
data.userAnsweredCountintTrueUser interaction count
data.userAnsweredEffectiveCountintTrueUser effective interaction count

Request Example

$ curl 'http://localhost:8080/v1/call-calls/simpleDetail?AppId=ef05710f-1144-4e2a-721c-991bf9df440a&Timestamp=1635933928&Token=232c0a7df5a8852a79b0ce5e08308443ada153e8' -i -X POST -H 'Content-Type: application/json' -d '{
    "callId": "eff790c4-90a5-4453-990c-ff7d4aa30914"
   }'

Response Example

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522
{
  "succeed":true,
  "code":200,
  "bizCode":"000000",
  "message":"OK",
  "visible":false,
  "data": {
      "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
      "workflow":3,
      "fromNumber":"18920765651",
      "toNumber":"05388593211",
      "relayNumber":"05388593191",
      "callStartTime":"2021-05-29 10:23:43",
      "callEndTime":"2021-05-29 10:23:57",
      "callDuration":14,
      "callRecordUrl":"https://tiao.com/7859ff65-0e6a-44e4-4ec2-1052f43f647a/cc_recordings/202105291ff7d4aa30914_eff790c4-90a5-4453-990c-ff7d4aa30914.mp3",
      "customerProvince":"Paris",
      "customerCity":"Paris",
      "routerId":185,
      "routerName":"210528bbr",
      "transferAgentFlag":0,
      "agentId":null,
      "agentName":null,
      "queueId":null,
      "queueName":null,
      "userAnsweredFlag":1,
      "userAnsweredCount":2,
      "userAnsweredEffectiveCount":0,
      "robotNames":[
          "Ftest _english1"
      ],
      "labelInfos":[
         "Satisfied"
     ],
     "instances":[
             {
                 "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
                 "instanceId":1622255025121140,
                 "robotId":25233,
                 "robotDefId":30724,
                 "robotName":"Ftest _english1",
                 "dialogueStartTime":"2021-05-29 10:23:43",
                 "dialogueEndTime":"2021-05-29 10:23:57",
                 "dialogueDuration":13,
                 "dialogueRecordUrl":null,
                 "dialogueRound":1,
                 "intentionLabelKey":"C",
                 "intentionLabelName":"C level (explicitly declined)",
                 "labelInfoList":[
                    {"name":"Fruit"}
                 ],
                 "dialogueContentList":[
                     {
                         "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
                         "instanceId":1622255025121140,
                         "robotId":25233,
                         "robotDefId":30724,
                         "dialogueRole":1,
                         "dialogueStartTime":"2021-05-29 10:23:43",
                         "dialogueContent":"Many lessons are boring, and he is very tired after doing gym.",
                         "dialogueRecordUrl":null,
                         "matchType":null,
                         "matchResult":"",
                         "matchName":""
                     },
                     {
                         "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
                         "instanceId":1622255025121140,
                         "robotId":25233,
                         "robotDefId":30724,
                         "dialogueRole":2,
                         "dialogueStartTime":"2021-05-29 10:23:49",
                         "dialogueContent":"Ok",
                         "dialogueRecordUrl":"https://tiao.com/7859ff65-0e6a-44e4-4ec2-1052f43f647a/cc_recordings/202105291ff7d4aa30914_eff790c4-90a5-4453-990c-ff7d4aa30914.mp3",
                         "matchType":9,
                         "matchResult":"Ignore",
                         "matchName":"Ignore"
                     },
                     {
                         "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
                         "instanceId":1622255025121140,
                         "robotId":25233,
                         "robotDefId":30724,
                         "dialogueRole":2,
                         "dialogueStartTime":"2021-05-29 10:23:56",
                         "dialogueContent":"It's an English",
                         "dialogueRecordUrl":"https://tiao.com/7859ff65-0e6a-44e4-4ec2-1052f43f647a/cc_recordings/202105291ff7d4aa30914_eff790c4-90a5-4453-990c-ff7d4aa30914.mp3",
                         "matchType":6,
                         "matchResult":"Matched to response branch: [Default]",
                         "matchName":"Default"
                     }
                 ]
             }
         ]
    }
}