获取指定通话的通话备注

获取在指定通话中添加的通话备注。

请求 URL

GET {base_url}/{api_path}/callnotes/get?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 通话备注的唯一 ID。
注： 你可以从 (30028) 通话备注可用状态 事件报告中获取通话备注的组 ID。
group_id 是 Integer 通话备注的组 ID。
注： 你可以从 (30028) 通话备注可用状态 事件报告中获取通话备注的组 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
history Array <Previous_Callnote> 通话中最近通话备注的信息。
current Object <Current_Callnote> 通话中当前通话备注的信息。
Previous_Callnote
参数 类型 说明
id String 通话备注的唯一 ID。
group_id String 通话备注的组 ID。
disposition_code_list Array<Disposition_Codes> 通话备注中选择的话务标签信息。
remark String 备注。
agent_name String 添加通话备注的分机用户的名称。
registration_time Long 分机用户添加通话备注的时间。
update_entry String 修改通话备注的场景。
Disposition_Codes
参数 类型 说明
id Integer 话务标签的唯一 ID。
name String 话务标签。
description String 话务标签说明。
Current_Callnote
参数 类型 说明
id String 通话备注的唯一 ID。
group_id String 通话备注的组 ID。
disposition_code_list Array<Disposition_Codes> 通话备注中选择的话务标签信息。
remark String 备注。
agent_name String 添加通话备注的分机用户的名称。
registration_time Long 分机用户添加通话备注的时间。
update_entry String 修改通话备注的场景。
Disposition_Codes
参数 类型 说明
id Integer 话务标签的唯一 ID。
name String 话务标签。
description String 话务标签说明。

示例

请求示例

查询通话中的通话备注。

GET /openapi/v1.0/callnotes/get?access_token=zbVqLE97rG5j37NZ8ewKRaEXKsbcn6Gz&group_id=1741226609.252&id=20250306100421-F1C65 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "history": [
        {
            "id": "20250306100329-59999",
            "group_id": "1741226609.252",
            "disposition_code_list": [
                {
                    "id": 21,
                    "name": "Transferred to Another Department",
                    "description": "The call was transferred to the appropriate team or department."
                }
            ],
            "remark": "User encountered xx issue, needs resolution from the tech support department",
            "agent_name": "Madison Cooper",
            "registration_time": 1741226653,
            "update_entry": ""
        }
    ],
    "current": {
        "id": "20250306100421-F1C65",
        "group_id": "1741226609.252",
        "disposition_code_list": [
            {
                "id": 20,
                "name": "Follow-up Required",
                "description": "Further contact is needed at a specific time or condition."
            },
            {
                "id": 25,
                "name": "Tech Support Provided",
                "description": "The customer received help resolving a technical issue."
            }
        ],
        "remark": "Customer's issue has been resolved.",
        "agent_name": "Carmen Gordon",
        "registration_time": 1741226703,
        "update_entry": ""
    }
}