Skip to main content

Uniphore Help Center Portal

Retrieve AI-based Call Disposition Values for a Conversation ID/External Conversation ID

This API triggers the AI-based Call Disposition generation during or after a call, using either the given Conversation ID or External Conversation ID. It is primarily intended for third-party applications that do not use the AI Agent Assist UI, enabling them to retrieve Call Disposition values while the call is in progress or after it has ended.

To view the Call Disposition values in run time, the Disposition predefined in the X-Platform must be mapped with an Experience.

For more information on defining a Call Disposition, click here.

For more information on mapping a Disposition to an Experience, click here.

For more information on viewing Call Disposition values in real time, click here.

Note

Only one active Disposition generation occurs per conversation.

Endpoint

Method: GET

URL: https://api.<REGION>.cloud.<DOMAIN>.com/dispositions/v1/disposition/ai-disposition?conversation_id=<CONV_ID>&environment=<ENV_NAME>

<REGION> - Mention the name of the region, such as the United States, India, the United Kingdom, the Middle East, and so on, where Real-Time Guidance Agent is deployed on the public cloud.

<DOMAIN> - Mention the name of the domain, such as uniphore staging and uniphore.

Sample Request
curl --location 
'https://api.us.cloud.uniphorestaging.com/dispositions/v1/disposition/ai-disposition?conversation_id=79b70a73-0a68-47fe-940f-a79e919aaeda&experience_id=726b970-c93c-4791-b0fb-a270fd2311fa&environment=dev'\
--header 'Authorization: Bearer syJhbLciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiaW50ZXJhY3RfYWdlbnQiLCJ1X2FnZW50Il0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9lbWFpbF9pZCI6ImFwaXRlc3RpbmctdWFzc2lzdGFnZW50XzEwMDFAcWF0ZXN0ZW52MS5jb20iLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJhcGl0ZXN0aW5nLXVhc3Npc3RhZ2VudF8xMDAxQHFhdGVzdGVudjEuY29tIiwiZmFtaWx5X25hbWUiOiJhcGl0ZXN0aW5nLXVhc3Npc3RhZ2VudF8xMDAxIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2F1dGgwX25hbWUiOiJhcGl0ZXN0aW5nLXVhc3Npc3RhZ2VudF8xMDAxIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfaWQiOiJhdXRoMHw2NTUzMjMxNDYxYWZmNTA5MTI4OTVjMzkiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9tZXRhZGF0YSI6eyJjbGllbnRfaWQiOiJhcGl0ZXN0aW5nLXVhc3Npc3RhZ2VudF8xMDAxQHFhdGVzdGVudjEuY29tIiwic3RhdGlvbl9jb2RlIjoiMTIzNCJ9LCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiM2UzNzYzMWMtNzhhYy00MTM3LTg0MTUtNzJkY2Q5MGIxOWZkIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3RlbmFudF9uYW1lIjoicWF0ZXN0ZW52MSIsImlzcyI6Imh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw2NTUzMjMxNDYxYWZmNTA5MTI4OTVjMzkiLCJhdWQiOlsidWFzc2lzdC51bmlwaG9yZS5jb20iLCJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNzE2OTU1MjY0LCJleHAiOjE3MTcwNDE2NjQsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUiLCJvcmdfaWQiOiJvcmdfUDZTQ3VGSHlsRUNQNTU2MCIsImF6cCI6IkRqY3B4b0lkZERmdWZIRmRRTjVCbjRpWDYzWnhBa3VmIiwicGVybWlzc2lvbnMiOlsicmVhZDpleHBlcmllbmNlcyIsIndyaXRlOmV4cGVyaWVuY2VzIl19.TgClXKzwQpuqxdg3IZrYhz0BQpLPeQD8vI0KumVtIH0YcFGo8incnqKpcYDcO4HBm0DyFLa1Jpmr-fd4TVd9xGFoS2VqnR6paka1ZC1mbJz4DwM3OuCeIAlB9HEOwSI_cRQGRcyxxYfsNb7Piyy4f5tCfkBaoJw33xf_bG9vDS9pRE385FtJGXbhpuk_6dmQpfIUQR6-EkGjMKoAvAA21Z403EtkC8yeUl1QMaptBArzDONdbRq_pD0JM3x7EdQ1pFpLBO_5idpIcSvNYf1kwlwUT_hmhQ-IjowzZs-ospQHh4VLFIY8mJgYsK_xyo4zo8DcmPpK5kibUCtP0yboCQ'

Note

Include either the conversation_id or ext_conversation_id parameter in the request.

Header Parameter

In the Header Parameter, mention the authorization token of the Admin or Agent users. For more information on how to obtain a user authorization token, click here.

Authorization - Bearer <Token>
Query Parameters

Parameter Name

Mandatory/Optional

Data Type

Description

conversation_id

Mandatory

String

ID generated by the conversation service.

ext_conversation_id

Conversation ID for the call passed from the external application to U-Assist.

environment

Mandatory

String

The name of the environment. Three out-of-the-box environments are provided for each account:

  • DEV

  • TEST

  • PROD

For more information on multi environment accounts, click here.

Sample Response
{    
    "disposition": {        
        "aiResult": [            
            "Phone Upgrade",            
            "Payment Opted",            
            "EMI Installments",            
            "Credit card payment"   
        ] 
    }
}
Response Parameters

Parameter Name

Description

disposition

The four-level AI-generated Call Disposition results using a predefined Disposition assigned to the current Experience.

For more information on viewing Call Disposition in real time, click here.

Response and Error Codes

Code

Response

200

Ok - The request has succeeded. This response code will be shown when the Disposition is successfully generated for the given request.

400

This error code is returned when both the Conversation ID and External Conversation ID are provided in the request, or if either ID is empty.

404

In the event that the conversation corresponding to either the provided Conversation ID or External Conversation ID cannot be found.

In this section: