Skip to content
vocapable.Docs

Routed texts: rules, queues, people and lines (CC8-R1)

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcMessagingSetup

Everything an owner sets for routed texts, in one read.

object
enabled
required
Enabled
boolean
can_manage
required
Can Manage
boolean
rules
required
CcMessagingRules

The company’s messaging rules (defaults until an owner saves them).

object
default_capacity
required
Default Capacity
integer
offer_timeout_seconds
required
Offer Timeout Seconds
integer
call_blocks_conversations
required
Call Blocks Conversations
boolean
acw_blocks_conversations
required
Acw Blocks Conversations
boolean
not_ready_reasons
required
Not Ready Reasons
Array<string>
sla_seconds
required
Sla Seconds
integer
sla_percent
required
Sla Percent
integer
revision
required
Revision
integer
queues
required
Queues
Array<object>
CcQueueMessaging

One queue’s overrides (null = the company’s) and what applies.

object
queue_id
required
Queue Id
string
queue_name
required
Queue Name
string
capacity
required
Any of:
integer
offer_timeout_seconds
required
Any of:
integer
call_blocks_conversations
required
Any of:
boolean
sla_seconds
required
Any of:
integer
sla_percent
required
Any of:
integer
effective_capacity
required
Effective Capacity
integer
effective_offer_timeout_seconds
required
Effective Offer Timeout Seconds
integer
effective_call_blocks_conversations
required
Effective Call Blocks Conversations
boolean
effective_sla_seconds
required
Effective Sla Seconds
integer
effective_sla_percent
required
Effective Sla Percent
integer
revision
required
Revision
integer
agents
required
Agents
Array<object>
CcAgentMessaging
object
user_id
required
User Id
string
name
required
Name
string
capacity
required
Any of:
integer
effective_capacity
required
Effective Capacity
integer
holding
required
Holding
integer
revision
required
Revision
integer
lines
required
Lines
Array<object>
CcMessagingLine
object
phone_number_id
required
Phone Number Id
string
phone_e164
required
Phone E164
string
label
required
Any of:
string
mode
required
Mode
string
Allowed values: off flow queue
queue_id
required
Any of:
string
routes_to
required
Routes To
Array<string>
revision
required
Revision
integer
Example
{
  "lines": [
    {
      "mode": "off"
    }
  ]
}