Skip to content
vocapable.Docs

Why this agent: a conversation's routing trace

GET
/v1/workspace/contact-center/conversations/{conversation_id}/routing
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/conversations/example/routing \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
conversation_id
required
Conversation Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcConversationTrace
object
conversation_id
required
Conversation Id
string
queue_id
required
Queue Id
string
queue_name
required
Queue Name
string
base_priority
required
Base Priority
integer
vip_labels
required
Vip Labels
Array<string>
sticky_name
required
Any of:
string
sticky_reason
required
Any of:
string
Allowed values: last_agent crm_owner
assigned_to
required
Any of:
string
summary
required
Summary
string
decisions
required
Decisions
Array<object>
CcRoutingDecision
object
id
required
Id
string
decided_at
required
Decided At
string format: date-time
last_decided_at
required
Last Decided At
string format: date-time
repeats
required
Repeats
integer
outcome
required
Outcome
string
Allowed values: offered waiting sticky_hold ai_turn moved reprioritized
step_index
required
Step Index
integer
step_after_seconds
required
Step After Seconds
integer
requirements
required
Requirements
Array<object>
CcRoutingRequirement
object
skill_id
required
Skill Id
string
name
required
Name
string
min_proficiency
required
Min Proficiency
integer
negate
Negate
boolean
any_of
Any Of
Array<object>
CcRoutingRequirementGroup

An OR group as a trace or simulation shows it: one alternative must hold.

object
alternatives
required
Alternatives
Array<Array<object>>
pool_queues
required
Pool Queues
Array<string>
strategy
required
Strategy
string
Allowed values: longest_idle most_skilled round_robin ring_all
effective_priority
required
Effective Priority
integer
waited_seconds
required
Waited Seconds
integer
candidates
required
Candidates
Array<object>
CcRoutingCandidate
object
user_id
required
Any of:
string
name
required
Name
string
outcome
required
Outcome
string
Allowed values: picked eligible skipped
reason
required
Any of:
string
detail
required
Any of:
string
rank
required
Any of:
integer
score
required
Any of:
number
idle_seconds
required
Any of:
integer
explanation
required
Explanation
string
code
Code
string
""
candidate_count
required
Candidate Count
integer
skip_counts
Skip Counts
object
key
additional properties
integer
step_entry_reason
Step Entry Reason
string
default: start
Allowed values: start timeout
step_exit_reason
Any of:
string
Allowed values: matched timeout
picked_names
required
Picked Names
Array<string>
elapsed_ms
required
Elapsed Ms
integer
summary
required
Summary
string
redacted
required
Redacted
boolean
Example
{
  "sticky_reason": "last_agent",
  "decisions": [
    {
      "outcome": "offered",
      "requirements": [
        {
          "negate": false
        }
      ],
      "any_of": [
        {
          "alternatives": [
            [
              {
                "negate": false
              }
            ]
          ]
        }
      ],
      "strategy": "longest_idle",
      "candidates": [
        {
          "outcome": "picked",
          "code": ""
        }
      ],
      "step_entry_reason": "start",
      "step_exit_reason": "matched"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}