Note Agent

更新时间:
复制 MD 格式

Subscribe to offline call notes inference results using HTTP batch push.

Protocol details

Category

Description

Protocol

HTTP + JSON

Encoding

UTF-8

Request details

The request body is in JSON array format.

  • Sample request:

    [{
    "call_id": "155***********^142**************",
    "biz_id": "21*********",
    "out_id": "123456789",
    "cell_number": "155********",
    "success": true,
    "error_code": "success",
    "error_msg": "success",
    "content_length": 1343,
    "duration": 267,
    "start_time": "2026-03-02 15:28:59",
    "report_time": "2026-03-02 15:29:07",
    "type": "Call Quality Inspection",
    "result": "[{\"item\":\"Prohibited Sensitive Word\",\"full_score\":15,\"score\":15,\"problem\":\"None\",\"suggestion\":\"Continue using compliant language and avoid absolute or commitment-based statements.\"}]"
    }]
  • Field descriptions:

    Name

    Type

    Description

    call_id

    String

    Call ID

    biz_id

    String

    Inference business ID

    out_id

    String

    Pass-through extension field. Returns the value passed in the API call.

    cell_number

    String

    Callee number.

    success

    Boolean

    Whether inference succeeded

    error_code

    String

    Inference result:

    success: Success,

    NOTE_AGENT_PROCESS_FAIL: Inference failed

    error_msg

    String

    Inference result description

    content_length

    Integer

    Inference content length

    duration

    Integer

    Billing duration, in seconds.

    start_time

    String

    Inference start time

    report_time

    String

    Report push time

    type

    String

    Inference type: Call Quality Inspection, Call Summary

    result

    String

    Call notes inference result. See Call Quality Inspection call notes inference result and Call Summary call notes inference result.

Call Quality Inspection call notes inference result

  • Sample request:

    [
      {
        "item": "Dimension 1",
        "full_score": 30,
        "score": 27,
        "problem": "Specific issue description",
        "suggestion": "Specific improvement suggestion"
      },
      {
        "item": "Dimension 2",
        "full_score": 70,
        "score": 65,
        "problem": "Specific issue description",
        "suggestion": "Specific improvement suggestion"
      }
    ]
  • Field descriptions:

    Name

    Type

    Description

    item

    String

    Quality inspection item or dimension

    full_score

    Integer

    Total score for this inspection item

    score

    Integer

    Score for this inspection item

    problem

    String

    Issue description

    suggestion

    String

    Improvement suggestion

Call Summary call notes inference result

  • Sample request:

    {
      "Enum Tag 1": ["Value 1"],
      "Enum Tag 2": ["Value 2.1", "Value 2.2"],
      "Text Tag 1": "Content 1",
      "Text Tag 2": "Content 2"
    }

Response details

  • Sample response:

    {
      "code": 0,
      "msg": "Accepted successfully"
    }
  • Field descriptions:

    Name

    Type

    Required

    Description

    Example value

    code

    Number

    Yes

    Acknowledgement code.

    0

    msg

    String

    No

    Description message.

    Accepted successfully

Note
  • The system validates only that the code of the return value is a number and does not validate the content. An HTTP status code of 200 indicates that the request is successful. The system retries the push if the HTTP status code is not 200 or the response times out.

  • If a system error or consumption failure occurs, return an HTTP status code in the 5xx range.

Retry push

If the first push fails, the system retries after 1 minute, 5 minutes, and 10 minutes. Retries stop after a successful push. If all three retries fail, no further attempts are made.