Retrieve Customer Details

This API returns ACW Agent ID and customer information such as customer name, contact number, email ID, company name for a given call id.

Endpoint

Method: GET

URL: http://https://api.<region>.cloud.uniphore.com/sms/v2/supervisor/api/customer?environment=<env_name>

Request

curl -X GET "https://api.<region>.cloud.uniphore.com/sms/v2/supervisor/api/customer?conversationId=1001&environment=dev" -H "accept: application/json"

Query Parameters

Parameter Name	Description	Data Type	Required / Optional
`conversationId`	Internally system-generated unique identification number.	String	Required
`environment`	Operating environment type. Three out-of-the-box environments are provided for each account: DEV TEST PROD	String	Optional

Parameter Name

Description

Data Type

Required /

Optional

conversationId

Internally system-generated unique identification number.

String

Required

environment

Operating environment type. Three out-of-the-box environments are provided for each account:

DEV
TEST
PROD

String

Optional

Example Response

{
agentId: uni123,
customerName: Raj,
contactNumber: 8090890900,
email: raj@abc.com
company: ABC
}

Response Parameters

The list of Response values is provided below:

Response Parameters	Description
`agentId`	The user ID of ACW agent
`customerName`	Customer’s name
`contactNumber`	Customer’s contact number
`Email`	Customer’s email ID
`company`	Customer’s company name

Response and Error Codes

Response Code	Description
200	OK – The request has succeeded.
401	Authentication failed. This response code will be shown if any of the following scenarios occur: The provided token is not a valid JWT token. The access_token provided is not a valid token or has already expired. The user for whom the access_token was generated is not eligible (incorrect role) to use the API.
500	Internal server error.

In this section:

Uniphore Customer Portal