WAKATODOCS

Phone

GET
/phone/numbers

Required scope: phone:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Response Body

application/json

{}
GET
/phone/calls

Required scope: phone:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Response Body

application/json

{}
POST
/phone/sms

Required scope: phone:run

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
GET
/phone/campaigns

Required scope: phone:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Query Parameters

status?string
limit?integer

Response Body

application/json

{}
POST
/phone/campaigns

Required scope: phone:write

Drafting never requires a connected phone number — the sender defaults to the space's first SMS-capable number when one exists, else stays null until set. Sending is a separate run-scoped action.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
GET
/phone/campaigns/{id}

Required scope: phone:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Response Body

application/json

{}
PATCH
/phone/campaigns/{id}

Required scope: phone:write

Passing steps REPLACES all drip steps.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
POST
/phone/campaigns/{id}/send

Required scope: phone:run

Broadcast: schedules the send (scheduled_at defaults to now); the scheduler delivers it. Drip: starts the sequence. Requires a sender number, an audience, and message content.

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
GET
/phone/templates

Required scope: phone:read

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Response Body

application/json

{}
POST
/phone/templates

Required scope: phone:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}
PATCH
/phone/templates/{id}

Required scope: phone:write

Authorization

bearerAuth
AuthorizationBearer <token>

A Space API key, e.g. wks_live_….

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

{}