Skip to main content

Uniphore Customer Portal

Get Call IDs with a Specific Lock Description

Use the get call IDs by tag request to get a list of conversation IDs for locked calls where the lock description matches a specified string.

Endpoint

Method: GET

URL: /lock/get_call_ids_by_tag/:lockDesc

Path Parameter

Parameter Name

Data Type

Description

Required/Optional

lockDesc

String

Enter the lock description to get the conversation IDs for locked conversations with matching lock descriptions.

Required

Response and Error Code

Response Code

Condition

200

OK

Response Parameter

Parameter Name

Data Type

Description

conversationIds

Array

A list of conversation IDs for the locked conversations with lock descriptions matching the lockDesc specified in the path parameter.

Sample Response
{
    "conversationIds": [
        "f3e99e8e-303d-4ed9-80bb-5d18ac07a4db",
        "e5a256d5-aad1-4a56-8509-af19df7fe0ef"
    ]
}