Skip to content
vocapable.Docs

Text conversations offered to you and yours

GET
/v1/mobile/workspace/contact-center/conversations/mine
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/workspace/contact-center/conversations/mine \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcMyConversations
object
enabled
required
Enabled
boolean
offers
required
Offers
Array<object>
CcConversationOffer
object
offer_id
required
Offer Id
string
kind
required
Kind
string
Allowed values: route transfer
offered_at
required
Offered At
string format: date-time
expires_at
required
Expires At
string format: date-time
conversation
required
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
assigned
required
Assigned
Array<object>
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
capacity
required
Capacity
integer
holding
required
Holding
integer
poll_seconds
required
Poll Seconds
integer
transfer_queues
required
Transfer Queues
Array<object>
CcQueueRef
object
id
required
Id
string
name
required
Name
string
transfer_people
required
Transfer People
Array<object>
CcConversationPerson
object
user_id
required
User Id
string
name
required
Name
string
Example
{
  "offers": [
    {
      "kind": "route",
      "conversation": {
        "state": "waiting",
        "close_reason": "resolved",
        "sla_state": "pending"
      }
    }
  ],
  "assigned": [
    {
      "state": "waiting",
      "close_reason": "resolved",
      "sla_state": "pending"
    }
  ]
}