Skip to content
vocapable.Docs

A call ringing for you: still yours, or taken?

GET
/v1/workspace/shared-phone/offers/{offer_id}
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/shared-phone/offers/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
offer_id
required
Offer Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SharedPhoneOfferStatus

One ringing offer as its recipient sees it. The app reads this after its ring is reported (CallKit / the incoming-call screen) and after Answer, so “Connected” is shown only once the server says the custody is this person’s.

state:

  • ringing - still offered to you; nobody has answered.
  • connecting - you answered and the server gave you the caller; the bridge is being confirmed at the carrier.
  • connected - the carrier confirmed you and the caller are in the same call.
  • answered_elsewhere - a teammate (or your other device) answered first.
  • declined - you declined it.
  • missed - the ring ended unanswered (the caller stays in the queue for the next person or device).
  • ended - the caller left, or the call you had has finished.
object
offer_id
required
Offer Id
string
ticket_id
required
Ticket Id
string
generation
required
Generation
integer
kind
required
Kind
string
Allowed values: browser mobile verified_phone
state
required
State
string
Allowed values: ringing connecting connected answered_elsewhere declined missed ended
yours
required
Yours
boolean
caller_display
required
Caller Display
string
line_name
required
Line Name
string
business_number
required
Business Number
string
observed_at
required
Observed At
string format: date-time
workspace_call_id
Any of:
string
Example
{
  "kind": "browser",
  "state": "ringing"
}

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