Update Call Notes for a Call

Update the call notes for a call during the call, or after the call.

Request URL

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

Request parameter

Parameter Required Type Description
id Yes String The unique ID of the call note.
Note: You can get the group ID from the (30028) Call Note Status Updated event report.
group_id No String The group ID of the call note.
Note:
  • The group ID is REQUIRED when modifying call notes during a call (update_entry is in_call) or in the wrap-up time (update_entry is queue_agent).
  • You can get the group ID from the (30028) Call Note Status Updated event report.
disposition_code_ids No String The unique ID(s) of call disposition code(s).
Note:
  • You can query the disposition code ID using the Get Menu Options interface.
  • Use comma to separate multiple disposition code IDs.
remark No String Remark of the call note.
update_entry Yes String The scenario in which the call note is updated.
Valid value:
  • in_call: Update call notes during a call.
  • cdr: Update call notes after a call in the call log.
  • queue_agent: Update call notes during wrap-up time.
    Note: This scenario is available for queue agents.

Response parameter

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Example

Request example

Update the call note of a specific call.

POST /openapi/v1.0/callnotes/update?access_token=C6jOpKQia170ueuKCqwQbYXcqdjPcZuM HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    
    "disposition_code_ids": "22,25",  
    "group_id": "1741336006.432"   
    "id": "20250306100421-F1C65", 
    "remark": "Already resolve customer's issue",  
    "update_entry": "in-call"
   
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}