Skip to main content

Uniphore Customer Portal

Fetch Transcripts Using Client Contact ID

This API is based on Transcripts module which returns the transcripts at the word offset level based on the organization id, category id and client contact id.

Endpoint

Method: GET

URL: /v2/transcripts?orgid=&catid=&clientcontactid=

Header Parameter
Authorization - Bearer <Token>
Authorization - X-USER-ID
Query Parameter

Parameter Name

Mandatory/

Optional

Type

Description

orgid

Mandatory

integer

Organization Id as query filter.

catid

Mandatory

integer

Category Id as query filter.

clientcontactid

Mandatory

string

Client contact Id as query filter.

Sample Request
curl --location --request GET 'http://localhost:3120/v2/transcripts?orgid=10&catid=5&clientcontactid=50bcedd9-077e-4892-9014-071b8b6dcec6' \
--header 'X-User-Id: 1' \
--header 'Authorization: Bearer 1234567890'
Sample Response
{
    "_id": "000000000000000000000000",
    "lang": "es-us",
    "searchLang": "en",
    "startTime": 1660521600000,
    "metadata": {
        "tenantId": "1",
        "organizationId": "2",
        "categoryId": "1",
        "contactId": "01d02a0d-bf47-45b4-953a-6f74b7d8e80c",
        "convId": "ENGcall01",
        "type": "batch",
        "contactType": "voice",
        "isDiarized": true,
        "contactDuration": 505582,
        "agentId": "3",
        "agentClientId": "acdefc6b-2254-4c7d-9032-aea2425a70a9",
        "customerId": "1",
        "customerClientId": "customer01"
    },
    "turns": [
        {
            "startOffset": 10860,
            "endOffset": 11900,
            "order": 1,
            "speaker": "agent",
            "words": [
                {
                    "text": "al",
                    "confidence": 9,
                    "startOffset": 10860,
                    "endOffset": 11100
                },
                {
                    "text": "uh",
                    "confidence": 4.3,
                    "startOffset": 11130,
                    "endOffset": 11900
                }
            ]
        }
    ],
    "wsText": [
        "al uh "
    ],
    "isChunk": false,
    "isLastChunk": true,
    "__ts": 1661499732699
}
Response and Error Codes

Code

Response

200

OK

400

{"error": "orgid, catid, clientcontactid cannot be empty"}

401

{“reason”: "Authorization failed"}

500

Internal Server Error