RobotCallReportAiccs

Updated at:

You can subscribe to robot call record messages (RobotCallReportAiccs) using HTTP batch push. After a call ends, you will receive call record information, which includes the called number, call start and end times, and call duration.

Protocol description

CategoryDescription
ProtocolHTTP + JSON
EncodingUTF-8

Request description

The request body is in the JSON Array format.

  • Request sample:

    [{
        "callId": "1264306***^113219835***",
        "data": {
            "output": {
                "slots": [{
                    "nodeName": "Opening node",
                    "action": "recognized",
                    "source": "test001",
                    "value": "other"
                }],
                "intentions":["intention1","intention2"],
                "tags": "tag1,tag2"
            },
            "info": {
                "duration": 9,
                "ringTime": 1640759017000,
                "calledNo": "1500000****",
                "code": 200000,
                "answerTime": 1640759026000,
                "callingNo": "05710000****",
                "startTime": 1640759017000,
                "endTime": 1640759034000,
                "direction": 0
            }
        },
        "partnerId": 10000000****,
        "robotId": "1000003****",
        "type": "finish"
    }]
  • Field descriptions:

    Name

    Type

    Example

    Description

    callId

    String

    1264306***^113219835***

    The call ID.

    nodeName

    String

    Opening node

    The node name.

    action

    String

    recognized

    Execute the action.

    source

    String

    test001

    The node ID or node name.

    • If a node ID is set, source is the ID of the traversed node.

    • If a node ID is not set, source is the node name.

    value

    String

    other

    • You can use a custom branch.

      • If an intent ID is set, value is the ID of the matched intent.

      • If an intent ID is not set, value is the intent name.

    • You can use a semantic model.

      value is the custom ID of the semantic model branch.

    intentions

    List

    ["intention1","intention2"]

    The knowledge base entries.

    tags

    String

    tag1,tag2

    The tags.

    duration

    Long

    9

    The call duration.

    ringTime

    Long

    1640759017000

    The timestamp for when the called party's phone started ringing.

    calledNo

    String

    1500000****

    The called number.

    code

    Long

    200000

    The call status code.

    answerTime

    Long

    1640759026000

    The timestamp for when the customer answered the call.

    callingNo

    String

    05710000****

    The calling number.

    startTime

    Long

    1640759017000

    The timestamp for when the call started.

    endTime

    Long

    1640759034000

    The timestamp for when the call ended.

    robotId

    String

    1000003****

    The robot ID.

    direction

    String

    1

    The direction of the hang-up. Valid values:

    • 0: The bot hangs up.

    • 1: The customer ended the call.

Response description

  • Response example:
    {
      "code": 0,
      "msg": "Accepted successfully"
    }
  • Field description:
    NameTypeRequiredDescriptionExample
    codeNumberYesThe acknowledgement code.0
    msgStringNoThe description.Accepted successfully
Note
  • The system only checks whether the returned code is a number and does not validate its content. An HTTP status code of 200 indicates that the request was successful. If the HTTP status code is not 200 or a timeout occurs, the system retries the push.
  • If a system exception or consumption failure occurs, return an HTTP 5xx status code.

Retry push

If the initial push fails, the system retries up to three times. The intervals between retries are 1 minute, 5 minutes, and 10 minutes. If the push remains unsuccessful, no further attempts are made.