Skip to content
vocapable.Docs

Transfer a conversation to a queue or a teammate (expected_revision)

POST
/v1/workspace/contact-center/conversations/{conversation_id}/transfer
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/contact-center/conversations/example/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "queue_id": "example", "user_id": "example", "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
conversation_id
required
Conversation Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CcConversationTransfer

To another queue (its routing starts over) or to one person (offered to them).

object
queue_id
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
user_id
Any of:
string
>= 1 characters <= 64 characters /^[A-Za-z0-9_-]+$/
expected_revision
required
Expected Revision
integer
>= 1
Examplegenerated
{
  "queue_id": "example",
  "user_id": "example",
  "expected_revision": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcConversation
object
id
required
Id
string
state
required
State
string
Allowed values: waiting offered assigned closed
queue_id
required
Queue Id
string
queue_name
required
Queue Name
string
contact_id
required
Any of:
string
customer_label
required
Customer Label
string
customer_e164
required
Customer E164
string
phone_number_id
required
Any of:
string
preview
required
Any of:
string
vip_labels
required
Vip Labels
Array<string>
assignee
required
Any of:
CcConversationPerson
object
user_id
required
User Id
string
name
required
Name
string
enqueued_at
required
Enqueued At
string format: date-time
requeued_at
required
Requeued At
string format: date-time
last_inbound_at
required
Last Inbound At
string format: date-time
first_offered_at
required
Any of:
string format: date-time
accepted_at
required
Any of:
string format: date-time
first_response_at
required
Any of:
string format: date-time
closed_at
required
Any of:
string format: date-time
close_reason
required
Any of:
string
Allowed values: resolved opted_out line_unrouted
disposition
required
Any of:
string
close_note
required
Any of:
string
sla_seconds
required
Sla Seconds
integer
sla_percent
required
Sla Percent
integer
sla_due_at
required
Sla Due At
string format: date-time
sla_state
required
Sla State
string
Allowed values: pending met missed
first_response_seconds
required
Any of:
integer
transfer_count
required
Transfer Count
integer
revision
required
Revision
integer
Example
{
  "state": "waiting",
  "close_reason": "resolved",
  "sla_state": "pending"
}

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": {}
    }
  ]
}