Skip to content
vocapable.Docs

Mobile Waiting Calls

GET
/v1/mobile/workspace/shared-phone/waiting
curl --request GET \
  --url 'https://api.vocapable.com/v1/mobile/workspace/shared-phone/waiting?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SharedPhoneWaitingRoom
object
observed_at
required
Observed At
string format: date-time
pickup_enabled
required
Pickup Enabled
boolean
phone_ready
required
Phone Ready
boolean
phone_hint
required
Any of:
string
app_ready
App Ready
boolean
data
required
Data
Array<object>
SharedPhoneWaitingEntry
object
id
required
Id
string
phone_number_id
required
Phone Number Id
string
state
required
State
string
revision
required
Revision
integer
generation
required
Generation
integer
enqueued_at
required
Enqueued At
string format: date-time
deadline
required
Deadline
string format: date-time
caller_display
required
Caller Display
string
position
required
Any of:
integer
offer_id
required
Any of:
string
offer_expires_at
required
Any of:
string format: date-time
ai_declined
required
Ai Declined
boolean
connected_at
required
Any of:
string format: date-time
business_number
required
Business Number
string
line_name
required
Line Name
string
member_of_line
required
Member Of Line
boolean
offer_for_you
required
Offer For You
boolean
need
Any of:
string
need_source
Any of:
string
Allowed values: ai_handoff caller_request
queue_id
Any of:
string
queue_name
Any of:
string
ewt_seconds
Any of:
integer
priority
Any of:
integer
has_more
Has More
boolean
next_cursor
Any of:
string
Example
{
  "app_ready": false,
  "data": [
    {
      "need_source": "ai_handoff"
    }
  ],
  "has_more": false
}

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