Call Record Callback

Callback Body Parameters

Parameter	Type	Nullable	Description
callId	String	false	Call identifier
workflow	int	false	Call type (1-Incoming, 2-Outbound Direct, 3-Two-way Callback, 4-Auto Outbound)
fromNumber	String	false	Caller number
toNumber	String	false	Callee number
relayNumber	String	false	Relay number
callStartTime	date	false	Call start time (e.g., yyyy-MM-dd HH:mm:ss)
callEndTime	date	false	Call end time (e.g., yyyy-MM-dd HH:mm:ss)
callDuration	int	false	Total call duration (seconds)
callRecordUrl	String	true	Call recording URL
customerProvince	String	true	Customer - Province
customerCity	String	true	Customer - City
routerId	int	true	Router ID
routerName	String	true	Router name
transferAgentFlag	int	true	Transfer to agent flag (0-No, 1-Yes)
agentId	String	true	Agent ID
agentName	String	true	Agent name
queueId	String	true	Queue ID
queueName	String	true	Queue name
robotNames	Array	true	Robot name array (["Dialogue 1", "Dialogue 2"])
labelInfos	Array	true	General label array (["Fruit", "Heavy"])
instances	Array	true	Dialogue records
instances[].callId	String	true	Call identifier
instances[].instanceId	int	true	Dialogue case identifier
instances[].robotId	int	true	Robot identifier
instances[].robotDefId	int	true	Robot definition identifier
instances[].robotName	String	true	Dialogue name
instances[].dialogueStartTime	date	true	Dialogue start time
instances[].dialogueEndTime	date	true	Dialogue end time
instances[].dialogueDuration	int	true	Total dialogue duration (seconds)
instances[].dialogueRecordUrl	String	true	Dialogue recording URL
instances[].dialogueRound	int	true	Dialogue round
instances[].intentionLabelKey	String	true	Intention label identifier
instances[].intentionLabelName	String	true	Intention label name
instances[].labelInfoList	Array	true	Label information
instances[].labelInfoList[].name	String	true	Label name
instances[].dialogueContentList	Array	true	Dialogue content
instances[].dialogueContentList[].callId	String	true	Call identifier
instances[].dialogueContentList[].instanceId	int	true	Session identifier
instances[].dialogueContentList[].robotId	int	true	Robot ID
instances[].dialogueContentList[].robotDefId	int	true	Robot definition ID
instances[].dialogueContentList[].dialogueRole	int	true	Dialogue role (1-Robot, 2-User, 9-System)
instances[].dialogueContentList[].dialogueStartTime	date	true	Dialogue end time
instances[].dialogueContentList[].dialogueContent	String	true	Dialogue content
instances[].dialogueContentList[].dialogueRecordUrl	String	true	Dialogue recording URL
instances[].dialogueContentList[].matchType	int	true	Matched type (1-Question Hit, 2-Answer Branch Hit, 3-Node Repeat, 4-Global Config Hit, 10-No Hit)
instances[].dialogueContentList[].matchResult	String	true	Match result
instances[].dialogueContentList[].matchName	String	true	Match name
variables	Array	true	Variables
variables[].variableName	String	true	Variable name
variables[].variableValue	String	true	Variable value
intentionLabelKey	String	true	Intention label identifier
intentionLabelName	String	true	Intention label name
allRecordUrl	Array	true	All call recordings
allRecordUrl[].recordUrl	String	true	Call recording URL
allRecordUrl[].recordType	String	true	Call recording type
adTaskId	int	true	Outbound task ID
adTaskName	String	true	Outbound task name
contactDetailRel	Object	true	Contact information
contactDetailRel.name	String	true	Name
contactDetailRel.mobile	String	true	Number
contactDetailRel.companyName	String	true	Company
contactDetailRel.remark	String	true	Remark
contactDetailRel.variates	Object	true	Contact variable information
contactDetailRel.variates.key	String	true	Contact variable key
contactDetailRel.variates.type	String	true	Contact variable type
contactDetailRel.variates.value	String	true	Contact variable value
callResult	int	true	Ring result
calledResult	int	true	Outbound result 1-Not connected 2-Connected
agentCallDuration	int	true	Agent call duration
hangupCause	String	true	Outbound failure reason
hangupBy	int	true	Call hang-up party 1: Customer 2: Agent 3: System 4: IVR 5: External line
customerNumber	String	true	Customer number
remark	String	true	Remark
taskContactBatchName	String	true	Contact name
userAnsweredFlag	int	true	Valid call (0-No, 1-Yes)
userAnsweredCount	int	true	User interaction count
userAnsweredEffectiveCount	int	true	User effective interaction count
isFinalCall	int	true	Last call flag 1-Last outbound 0-No

Callback Example

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522
{
      "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":"Tianjin",
      "customerCity":"Tianjin",
      "routerId":185,
      "routerName":"210528bbr",
      "transferAgentFlag":0,
      "agentId":null,
      "agentName":null,
      "queueId":null,
      "queueName":null,
      "robotNames":[
          "F Test_English1"
      ],
      "labelInfos":[
         "Satisfied"
      ],
      "variables":[
            {
                "variableName":"2", 
                "variableValue":"Beijing"
            }
            ]
      "instances":[
             {
                 "callId":"eff790c4-90a5-4453-990c-ff7d4aa30914",
                 "instanceId":1622255025121140,
                 "robotId":25233,
                 "robotDefId":30724,
                 "robotName":"F Test_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 (Explicit Refusal)",
                 "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":"Hmm.",
                         "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 English.",
                         "dialogueRecordUrl":"https://tiao.com/7859ff65-0e6a-44e4-4ec2-1052f43f647a/cc_recordings/202105291ff7d4aa30914_eff790c4-90a5-4453-990c-ff7d4aa30914.mp3",
                         "matchType":6,
                         "matchResult":"Matched to answer branch: [Default]",
                         "matchName":"Default"
                     }
                 ]
             }
         ]
      "intentionLabelKey"："C",
      "intentionLabelName"："C-Level (Explicit Refusal)",
      "allRecordUrl": [
          {
            "recordUrl": "https://tiao.com/7859ff65-0e6a-44e4-4ec2-1052f43f647a/cc_recordings/202105291ff7d4aa30914_eff790c4-90a5-4453-990c-ff7d4aa30914.mp3",
            "recordType": "ivr"
          }
      ],
      "adTaskId": 1762,
      "adTaskName": "Test Outbound Task",
      "contactDetailRel": {
         "name": "zmh",
         "mobile": "18770915633",
         "companyName": "Wo Feng Technology",
         "remark": "Beautiful in heart and kind",
         "variates": [
            {
               "key": "name",
               "type": "text",
               "value": "zmh"
            },
            {
               "key": "age",
               "type": "number",
               "value": "18"
            }
        ]
      },
     "callResult": 1,
     "calledResult": 1,
     "agentCallDuration": 23,
     "hangupCause": "Customer is busy",
     "hangupBy": 1,
     "customerNumber": 18770915633,
     "remark": "",
     "taskContactBatchName": "Test Contact",
     "userAnsweredFlag":1,
     "userAnsweredCount":2,
     "userAnsweredEffectiveCount":0,
     "isFinalCall" : 1
    }