Create an Annotation

Add an annotation to a specific conversation, as mentioned earlier adding an annotation is like adding a note but with more structure. Apply an offset to the annotation to point to a specific part of the conversation, and use annotation headers to group your annotations under useful types.

Endpoint

Method: POST

URL: /annotation/{conversationId}

Path Parameter

Parameter Name	Data Type	Description	Required/Optional
`conversationId`	String	The ID of the conversation to add an annotation to. Use the search conversations request to get valid conversation IDs.	Required

Request Body Parameters

Parameter Name	Data Type	Description	Required/Optional
`header`	String	The annotation header to use for the new annotation, use the Get Annotation Headers request for a list of valid headers in your system.	Required
`text`	String	The annotation text to add to the specified conversation.	Required
`offsetInSeconds`	Number	How far along in the conversation to add the annotation (in seconds). For Example, `0` would be at the start of the call and `120` would be two minutes into the call.	Required

For an example, see Sample Request.

Response and Error Code

Response Code	Condition
201	Created

Response Parameter

Parameter	Data Type	Description
`annotationId`	String	The ID of the annotation just created.
`header`	String	The annotation header used by the annotation just created.
`text`	String	The actual text used in the annotation just created.
`offsetInSeconds`	Number	How far along in the conversation the annotation just created is.
`timestamp`	Number	When (date and time) the annotation was added to the system.
`participantId`	String	The ID of the user that created the annotation.
`productType`	String	The product that the annotation feature belongs to (U-Capture).

For an example, see Sample Response.

Sample Request

{
  "header": "Example Header 2",
  "text": "annotation text",
  "offsetInSeconds": 5
}

Sample Response

{
    "annotation": {
        "annotationId": "dca23ffc-af12-4074-8c27-8c85a66585ad",
        "header": "Example Header 2",
        "text": "annotation text",
        "offsetInSeconds": 5,
        "timestamp": "2024-07-24T10:23:13.286101622Z",
        "participantId": "auth0|993wuh75e132b847256a581f",
        "productType": "PRODUCT_TYPE_U_CAPTURE"
    }
}

In this section:

Uniphore Customer Portal