Skip to main content

Uniphore Help Center Portal

Get Call IDs with a Specific Lock Description in Pages

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

Endpoint

Method: POST

URL: /lock/get_calls_by_tag

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`lockDescription`	String	Enter the lock description to get the conversation IDs for locked conversations with matching lock descriptions.	Required
`pageToken`	String	The token for which page of the response to see, if you want the first page of a search use `null`, if applicable the response will provide a `nextPageToken` that can be used to get the next page in a subsequent request. Add `==` to the end of the `nextPageToken` to use as the `pageToken` parameter in the request.	Optional

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.
`nextPageToken`	String	The token for the next page of conversations, use this token as the pageToken parameter value in a subsequent request to get the next page.
`totalCount`	String	How many conversations match the request in total. This does not reflect the amount of to conversations in the page.

Sample Request

{
  "lockDescription": "sales",
  "pageToken": "eyJwYWdlX3NpemUiOjIsImNoZWNrX3N1bSI6WzE5MSwxMTQsNjUsMjUxLDE4NCwxOSwxMywxNjMsMjE0LDUyLDkzLDExNiw2NSwyMDEsMTU2LDExMF0sInRlbmFudF9pZCI6IjY2ZGQ4NDE4LWIxZDEtNGQ0Ny05MjE4LWMwZTI5YmYxMzE3MCIsImNvbnZlcnNhdGlvbl9pZCI6IjFjZWU1YTQ2LTFiNGUtNGU4OS05ZjYxLTc3ZjdmNWUwMjExYyIsInRvdGFsX2NvdW50IjozNSwiZmlsdGVyX3ZhbHVlcyI6eyI0IjoiMjAyNC0wOC0wNlQxMTo0MDo0MS4yOTFaIn19"
}

Sample Response

{
    "conversationIds": [
        "f3e99e8e-303d-4ed9-80bb-5d18ac07a4db",
        "e5a256d5-aad1-4a56-8509-af19df7fe0ef"
    ],
    "nextPageToken": "eyJwYWdlX3NpemUiOjIsImNoZWNrX3N1bSI6WzE5MSwxMTQsNjUsMjUxLDE4NCwxOSwxMywxNjMsMjE0LDUyLDkzLDExNiw2NSwyMDEsMTU2LDExMF0sInRlbmFudF9pZCI6IjY2ZGQ4NDE4LWIxZDEtNGQ0Ny05MjE4LWMwZTI5YmYxMzE3MCIsImNvbnZlcnNhdGlvbl9pZCI6IjFjZWU1YTQ2LTFiNGUtNGU4OS05ZjYxLTc3ZjdmNWUwMjExYyIsInRvdGFsX2NvdW50IjozNSwiZmlsdGVyX3ZhbHVlcyI6eyI0IjoiMjAyNC0wOC0wNlQxMTo0MDo0MS4yOTFaIn19",
    "totalCount": "35"
}

In this section: