Skip to main content

Uniphore Customer Portal

Get the Lock Information for a Specific Conversation

Use the get lock request to get the lock details for a specific conversation.

Endpoint

Method: GET

URL: /lock/:conversationId

Path Parameter

Parameter Name

Data Type

Description

Required/Optional

conversationId

String

The ID of the conversation to get the lock details for. See Conversation APIs for information on getting conversation IDs.

Required

Response and Error Code

Response Code

Condition

200

OK

Response Parameter

Parameter Name

Data Type

Description

locks

Array

The details of the lock on the conversation entered in the path parameter.

id

Integer

The automatically generated ID of the lock, this is used to delete the lock if needed.

tenantId

String

The ID of your tenant.

conversationId

String

The ID of the conversation with the lock, this will match the conversation ID entered in the path parameter.

category

String

The category of lock, at the time of writing only the default category is available.

description

String

The description of the lock, likely a simple explanation of why the conversation is locked.

createdDate

Date Time

When the conversation was locked, in the format YYYY-MM-DDT00:00:00.000000Z.

user

Array

The details of the user that added the lock to the conversation.

userId

String

The ID of the user that added the lock to the conversation.

email

String

The email of the user that added the lock to the conversation.

fullName

String

The full name of the user that added the lock to the conversation.

businessUnit

String

The business unit of the user that added the lock to the conversation.

Sample Response
{
    "locks": [
        {
            "id": "3778",
            "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
            "conversationId": "e5a256d5-aad1-4a56-8509-af19df7fe0ef",
            "category": "LOCK_CATEGORY_DEFAULT",
            "description": "Ongoing Sale",
            "createdDate": "2024-09-04T13:49:03.033318Z",
            "user": {
                "userId": "auth0|735ujf53h235bn09835d984h",
                "email": "jihn.doe@uniphore.com",
                "fullName": "John Doe",
                "businessUnit": "Sales"
            }
        }
    ]
}
In this section: