Skip to main content

Uniphore Help Center Portal

Retry Failed Summary Submissions
Fetch Failed Summary Submission Conversation List

This API fetches the list of conversations for which the Summary Submission has failed. The results are limited to conversations initiated within the last 24 hours.

Endpoint

Method: GET

URL: https://api.{region}.cloud.uniphorestaging.com/argon/v1/retry/convList?ctiAgentId={ctiAgentId}&environment={env}

<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 installed on the public cloud.

Sample Request
curl --location 'https://api.us.cloud.uniphorestaging.com/argon/v1/retry/convList?ctiAgentId=uadmin@uniphore.com&environment=dev' \ 
--header 'Authorization: Bearer M2M_TOKEN/AUTH_TOKEN'
Header Parameter

In the Header Parameter, mention the authorization token of the Admin or Agent user. 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

ctiAgentId

Mandatory

String

The Agent’s Email ID used for login.

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
[
    {
        "_id": "98cbf9f6-046b-4bf2-9a71-7363ba3383ee",
        "tenantId": "c5d45bd5-c426-4d8c-8416-e21215e17cdf",
        "experienceId": "d16095a4-d0f7-472d-8252-697289ba377e",
        "sessionId": "1f0e9f29-d5b5-6063-8cdd-93c24b68d4b9",
        "ctiAgentId": "uadmin@uniphore.com",
        "environment": "dev",
        "participantId": "auth0|642d055d444c951146a9e902",
        "submissionStatus": "ERROR",
        "createdTimestamp": "2026-01-05T04:54:27.729Z",
        "modifiedTimestamp": "2026-01-05T04:55:20.987Z",
        "callEndTime": "2026-01-05T04:54:45.607Z"
    }
]
Response Parameters

Parameter Name

Description

_id

Conversation ID(s) for which Summary Submission has failed.

tenantId

A unique identifier for your account.

experienceId

A unique identifier for the experience.

sessionId

Customer session ID for the call is passed from the customer environment to Real-Time Guidance Agent.

ctiAgentId

The Agent’s Email ID used for login.

environment

The name of the environment.

participantId

A unique identifier for the specific Agent.

submissionStatus

For failed submission conversations, the value of the status variable 'SummarySubmitServiceFlowStatus' is set to Error.

callEndTime

The date and time when the conversation ended.

Response and Error Codes

Code

Response

200

Ok - The request has succeeded. This response code will be shown when the conversation list is successfully fetched for the given request.

400

This response code will be shown when invalid request parameters are provided.

500

When the services are down, it shows an 'Internal Server Error'.

Copy and Mark Failed Summary Submissions as Submitted

This API manually marks a list of conversations as SUBMITTED and copies the summaries to the clipboard. After copying, the conversations are removed from the retry queue, and an event is published to the Conversations service with the status variable 'SummarySubmitServiceFlowStatus' set to COMPLETED.

Endpoint

Method: GET

URL: https://api.{region}.cloud.uniphorestaging.com/argon/v1/retry/conversations/markSubmit?environment={environment-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 installed on the public cloud.

Sample Request
curl --location 'https://api.us.cloud.uniphorestaging.com/argon/v1/retry/conversations/markSubmit?environment=dev' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiQWNjb3VudCBBZG1pbmlzdHJhdG9yIiwiYWRtaW4iLCJ1X2FkbWluaXN0cmF0b3IiLCJpbnRlcmFjdF9hY2NvdW50X2FkbWluIiwiQkkgRGVzaWduZXIiLCJpbnRlcmFjdF9iaV9kZXNpZ25lciIsIkJJIFZpZXdlciIsImludGVyYWN0X2JpX3ZpZXdlciIsInVfcmVwb3J0aW5nX2FuYWx5c3QiXSwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2VtYWlsX2lkIjoidWFkbWluQHVuaXBob3JlLmNvbSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9hdXRoMF9uYW1lIjoidSAgYWRtaW4iLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9pZCI6ImF1dGgwfDY0MmQwNTVkNDQ0Yzk1MTE0NmE5ZTkwMiIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91cGRhdGVkX2F0IjoiMjAyNi0wMS0wNVQwNToxNToxNy44NDlaIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfbWV0YWRhdGEiOnsiY2xpZW50X2lkIjoidWFkbWluQHVuaXBob3JlLmNvbSIsInVwZGF0ZWRfYXQiOiIxNzYzNjQyMjI3NDcwIn0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS90ZW5hbnQiOiJjNWQ0NWJkNS1jNDI2LTRkOGMtODQxNi1lMjEyMTVlMTdjZGYiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50X25hbWUiOiJ1YXNzaXN0cWE1YSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9jbHVzdGVyIjoidXMiLCJpc3MiOiJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NjQyZDA1NWQ0NDRjOTUxMTQ2YTllOTAyIiwiYXVkIjpbImFwaS51bmlwaG9yZS5jb20iLCJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNzY3NTkwMTIxLCJleHAiOjE3NjgxOTQ5MjEsInNjb3BlIjoib3BlbmlkIiwib3JnX2lkIjoib3JnX2VwRzdTaDRzeG1jRU9RQUYiLCJhenAiOiJwZHRHaFhnQlpFcjZQc1g0WVhaNE55TDl5dnZ5a2FEeCIsInBlcm1pc3Npb25zIjpbImF1ZGl0LWxvZzp2aWV3OnVjYXB0dXJlIiwiY29uZmlndXJhdGlvbjpzeXN0ZW06dWNhcHR1cmUiLCJjcmVhdGU6dGVuYW50Omxvb2tlciIsImRlbGV0ZTp1c2VycyIsImRlc2lnbjpiaTpsb29rZXIiLCJleHBvcnQ6Y29udmVyc2F0aW9ucyIsInBvbGljeTphY3RpdmF0ZTp1Y2FwdHVyZSIsInBvbGljeTpjcmVhdGU6dWNhcHR1cmUiLCJwb2xpY3k6ZGVhY3RpdmF0ZTp1Y2FwdHVyZSIsInJlYWQ6ZXhwZXJpZW5jZXMiLCJyZWFkOm9yZ0hpZXJhcmNoeSIsInJlYWQ6dGVuYW50cyIsInJlYWQ6dWXB0dXJlICIsInJlY29yZGluZzpvbi1kZW1hbmQ6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy1saXZlOnVjYXB0dXJlIiwicmVjb3JkaW5nOnZpZXctbWV0YWRhdGE6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy10cmFuc2NyaXB0OnVjYXB0dXJlIiwic2VhcmNoOnZpZXc6dWNhcHR1cmUiLCJ2aWV3OmJpOmxvb2tlciIsInZpZXc6b3JnLWhpZXJhcmNoeSIsIndyaXRlOmV4cGVyaWVuY2VzIiwid3JpdGU6dWFzc2lzdCJdfQ.ziJd0LZICPMujkrsxy3U68iSfj3LIFWVGUtJ_PFWrQMwPoOUK1LzM1fUF2huBla27Qyn-mLz9K234gmAXoLH_SrkHFQ6_xXRdQDG9bnROfksbrELitNUr1cRuToJVbYTLaytE7FGaNS9Vig3N9nEW2i009jHa4aTzZFe5n161huX7ISEXEtBYxcQMjFeJ9ycnf4yde8y7Q0Eshipfj_NFh2Npt3PbROkGGIvMrKKWio5iTEUoUMqR205aoKYWdEvGuh3Wr9KPe0WQ8TnCPkaWul-3jecg1MIIdj5ZSh74KI-GXgDN5hiKf173PwgCWnRcopbF2ftpZ4-JFZzNy18cg' \
--header 'Content-Type: application/json' \
--data '{
    "conversationIds": [
        "9ee43ccc-234e-4b4e-ac6e-34efae4b99f5"
    ]
}'
Header Parameter

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

Authorization - Bearer <Token>
Query Parameter

Parameter Name

Mandatory/Optional

Data Type

Description

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.

Request Body
{
    "conversationIds": [
        "9ee43ccc-234e-4b4e-ac6e-34efae4b99f5"
    ]
}
Sample Response
{"message": "Success"}
Response and Error Codes

Code

Response

200

Ok - The request has succeeded. This response code will be shown when the conversation ID(s) for which the Summary Submission has failed are successfully copied and marked as SUBMITTED for the given request.

400

This response code will be shown when the request body is invalid.

500

When the services are down, it shows an 'Internal Server Error'.

Retry Failed Submissions

This API re-triggers the Data Flow for a list of conversations to retry failed Summary submissions.

Endpoint

Method: POST

URL: https://api.{region}.cloud.uniphorestaging.com/argon//v1/retry/submit/version/{version}/account/{account}/run/{flowId}/{applicationKey}?environment={env}

<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 installed on the public cloud.

Sample Request
curl --location 'https://api.us.cloud.uniphorestaging.com/argon/v1/retry/submit/version/2/account/uassistqa5a/run/2d6a9a458d16-fdce9c1057eb0420-5760/356d25be-987e-4835-b554-a0c2a1eb0b66?environment=dev' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiQWNjb3VudCBBZG1pbmlzdHJhdG9yIiwiYWRtaW4iLCJ1X2FkbWluaXN0cmF0b3IiLCJpbnRlcmFjdF9hY2NvdW50X2FkbWluIiwiQkkgRGVzaWduZXIiLCJpbnRlcmFjdF9iaV9kZXNpZ25lciIsIkJJIFZpZXdlciIsImludGVyYWN0X2JpX3ZpZXdlciIsInVfcmVwb3J0aW5nX2FuYWx5c3QiXSwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2VtYWlsX2lkIjoidWFkbWluQHVuaXBob3JlLmNvbSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9hdXRoMF9uYW1lIjoidSAgYWRtaW4iLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9pZCI6ImF1dGgwfDY0MmQwNTVkNDQ0Yzk1MTE0NmE5ZTkwMiIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91cGRhdGVkX2F0IjoiMjAyNi0wMS0xMlQwOToxNDo0Ny4wMzlaIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfbWV0YWRhdGEiOnsiY2xpZW50X2lkIjoidWFkbWluQHVuaXBob3JlLmNvbSIsInVwZGF0ZWRfYXQiOiIxNzYzNjQyMjI3NDcwIn0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS90ZW5hbnQiOiJjNWQ0NWJkNS1jNDI2LTRkOGMtODQxNi1lMjEyMTVlMTdjZGYiLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50X25hbWUiOiJ1YXNzaXN0cWE1YSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9jbHVzdGVyIjoidXMiLCJpc3MiOiJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8NjQyZDA1NWQ0NDRjOTUxMTQ2YTllOTAyIiwiYXVkIjpbImFwaS51bmlwaG9yZS5jb20iLCJodHRwczovL2Rldi1nMmo1bXUyei51cy5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNzY4MjA5Mjg4LCJleHAiOjE3Njg4MTQwODgsInNjb3BlIjoib3BlbmlkIiwib3JnX2lkIjoib3JnX2VwRzdTaDRzeG1jRU9RQUYiLCJhenAiOiJwZHRHaFhnQlpFcjZQc1g0WVhaNE55TDl5dnZ5a2FEeCIsInBlcm1pc3Npb25zIjpbImF1ZGl0LWxvZzp2aWV3OnVjYXB0dXJlIiwiY29uZmlndXJhdGlvbjpzeXN0ZW06dWNhcHR1cmUiLCJjcmVhdGU6dGVuYW50Omxvb2tlciIsImRlbGV0ZTp1c2VycyIsImRlc2lnbjpiaTpsb29rZXIiLCJleHBvcnQ6Y29udmVyc2F0aW9ucyIsInBvbGljeTphY3RpdmF0ZIsInJlY29yZGluZzpvbi1kZW1hbmQ6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy1saXZlOnVjYXB0dXJlIiwicmVjb3JkaW5nOnZpZXctbWV0YWRhdGE6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy10cmFuc2NyaXB0OnVjYXB0dXJlIiwic2VhcmNoOnZpZXc6dWNhcHR1cmUiLCJ2aWV3OmJpOmxvb2tlciIsInZpZXc6b3JnLWhpZXJhcmNoeSIsIndyaXRlOmV4cGVyaWVuY2VzIiwid3JpdGU6dWFzc2lzdCJdfQ.JLPYuEu3iYiSE2F7G7TMjssws5MoMmwLWxUM0RxfIqEw10pxCFcig0pUCxk3elMesAuPJHOoBtTyKoJtAMl1CHfuUMPmKxKE2PtEJ9CafL787nGIOKPOuE79naH_y1b9pbIGd4siRU3ZNE7UXjQkaplO8tWYy5W0W0fACjyyu1rW2UF770CzoFdIgCCzXTNBSBtewVD1DGb1Ln0Px2nkVEPM8tMH-M0pE0HHidKHJljND7EFpdZN6SgMYq4Qqv-MKx-K-qFYvvwsNtumtvcnxnaVhS84J8BYf167nQDyVvioQb1kRi7ccvQy7LU1Dct7pft16Bh9FJwGCqPIDl24Sg' \
--header 'Content-Type: application/json' \
--data '{
    "conversationIds": [
        "1d49a258-fe17-4d14-ba05-f218426442d4"
    ]
}'
Header Parameter

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

Authorization - Bearer <Token>
Path Parameters

Parameter Name

Mandatory/Optional

Data Type

Description

version

Mandatory

String

Flow version.

account

Mandatory

String

The specific account to which the Flow belongs.

flowId

Mandatory

String

The unique identifier of the Flow.

applicationKey

Mandatory

String

The unique key associated with the specific AI Agent application.

Query Parameter

Parameter Name

Mandatory/Optional

Data Type

Description

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.

Request Body
{
    "conversationIds": [
        "9ee43ccc-234e-4b4e-ac6e-34efae4b99f5"
    ]
}
Sample Response
{"message": "Success"}
Response and Error Codes

Code

Response

200

Ok - The request has succeeded. This response code will be shown when the Data Flow is successfully re-triggered for a list of conversations.

400

This response code will be shown when the request body is invalid or when one or more request parameters (version, account, or flowId) are invalid.

500

This response code will be shown when the retry submission fails for the conversation ID(s).

In this section: