Skip to content
vocapable.Docs

Email calls, texts or usage as CSV or JSON to yourself (owners)

POST
/v1/workspace/phone/exports
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/phone/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "calls", "format": "csv", "period": "7d" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PhoneDataExportRequest
object
kind
required
Kind
string
Allowed values: calls texts usage
format
Format
string
default: csv
Allowed values: csv json
period
Period
string
default: 30d
Allowed values: 7d 30d month 90d

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
PhoneDataExport
object
id
required
Id
string
status
required
Status
string
Allowed value: sent
sent_to
required
Sent To
string
kind
required
Kind
string
Allowed values: calls texts usage
format
required
Format
string
Allowed values: csv json
period
required
Period
string
Allowed values: 7d 30d month 90d
row_count
required
Row Count
integer
created_at
required
Created At
string format: date-time
Example
{
  "status": "sent",
  "kind": "calls",
  "format": "csv",
  "period": "7d"
}

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