Skip to main content

Uniphore Customer Portal

Fetch ACW Disposition List

dispositions [id range] API fetches a list of dispositions based on the ids passed. This is a streaming API.

Endpoint

Method: GET

URL: https://api.<region>.cloud.uniphore.com/data-collector/dispositions?t=id-range&ids=1,2,3,...,n&tenantId=<tenantId>&environment=<environment-name>

Request
curl -H “Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b” -XGET https://api.<region>.cloud.uniphore.com/data-collector/dispositions?t=id-range&ids=1,2,3,...,n&tenantId=<tenantId>&environment=<environment>

<slug-name> denotes the tenant name.

Header Parameter
Authorization - Bearer <Token>
Query Parameters

Parameter Name

Mandatory/

Optional

Data Type

Description

t

Mandatory

string

t represents the type of query.

Example: For ids use id-range value.

ids

Mandatory

string

A list of ids for which disposition need to be fetched. The ids are separated by a comma.

tenantid

Mandatory

String

The unique identifier for your account.

environment

Optional

String

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

  • DEV

  • TEST

  • PROD

Response and Error Codes

Code

Response

200

A stream of newline separated disposition documents in the format listed in the API 'Fetch ACW Disposition by ID'.

401

{“reason”:”Authentication failed”}

422

{“error”: “Error while decoding response from the database”}

500

{“error”: “Internal server error”}

Disposition Schema

  1. {

  1. "$schema": "http://json-schema.org/draft-04/schema#",

  2. "type": "object",

  3. "properties": {

  4. "conversationId": {

  5. "type": "string"

  6. },

  7. "startTime": {

  8. "type": "integer"

  9. },

  10. "lang": {

  11. "type": "string"

  12. },

  13. "metadata": {

  14. "type": "object",

  15. "properties": {

  16. "agentId": {

  17. "type": "string"

  18. },

  19. "customerId": {

  20. "type": "string"

  21. },

  22. "conversationType": {

  23. "type": "string"

  24. },

  25. "journeyId": {

  26. "type": "string"

  27. },

  28. "tenantId": {

  29. "type": "string"

  30. },

  31. "organizationId": {

  32. "type": "string"

  33. },

  34. "businessProcessId": {

  35. "type": "string"

  36. }

  37. },

  38. "required": [

  39. "agentId",

  40. "customerId",

  41. "conversationType",

  42. "journeyId",

  43. "tenantId",

  44. "organizationId",

  45. "businessProcessId"

  46. ]

  47. },

  48. "isReviewed": {

  49. "type": "boolean"

  50. },

  51. "resolution": {

  52. "type": "object",

  53. "properties": {

  54. "hierarchy": {

  55. "type": "string"

  56. },

  57. "data": {

  58. "type": "string"

  59. }

  60. },

  61. "required": [

  62. "hierarchy",

  63. "data"

  64. ]

  65. },

  66. "manualEdits": {

  67. "type": "object",

  68. "properties": {

  69. "userId": {

  70. "type": "string"

  71. },

  72. "ts": {

  73. "type": "integer"

  74. },

  75. "hierarchy": {

  76. "type": "string"

  77. },

  78. "data": {

  79. "type": "string"

  80. }

  81. },

  82. "required": [

  83. "userId",

  84. "ts",

  85. "hierarchy",

  86. "data"

  87. ]

  88. }

  89. },

  90. "required": [

  91. "conversationId",

  92. "startTime",

  93. "lang",

  94. "metadata",

  95. "isReviewed",

  96. "resolution",

  97. "manualEdits"

  98. ]

  99. }

In this section: