Skip to main content
POST
/
wokus
/
create-voicemail
Create a voice review
curl --request POST \
  --url https://clientapi.woku.app/wokus/create-voicemail \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form wokuId=507f1f77bcf86cd799439011 \
  --form qualification=5 \
  --form [email protected] \
  --form clientPhone=56912345678 \
  --form anonymous=false
{
  "_id": "507f1f77bcf86cd799439019",
  "wokuId": "507f1f77bcf86cd799439011",
  "qualification": {
    "qualification": 4
  },
  "file": {
    "filename": "voicemail.mp4",
    "url": "<string>"
  },
  "transcription": "<string>",
  "anonymous": false,
  "clientId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys.

Body

multipart/form-data
​
file
file
required

Audio file for the voicemail (MP3, WAV, M4A, WebM, etc.). Will be automatically converted to MP4.

​
wokuId
string<objectid>
required

MongoDB ObjectId of the woku to add the review to

Example:

"507f1f77bcf86cd799439011"

​
qualification
enum<string>
required

Star rating from 1 to 5 (as string for form-data)

Available options:
1,
2,
3,
4,
5
Example:

"5"

​
clientEmail
string<email>

Email address of the reviewer

Example:

"[email protected]"

​
clientPhone
string

Phone number of the reviewer

Example:

"56912345678"

​
anonymous
enum<string>

Whether the review should be anonymous (as string for form-data)

Available options:
true,
false
Example:

"false"

Response

Voicemail created successfully

​
_id
string<objectid>

Unique identifier of the voicemail

Example:

"507f1f77bcf86cd799439019"

​
wokuId
string<objectid>

Woku ID the voicemail belongs to

Example:

"507f1f77bcf86cd799439011"

​
qualification
object
​
file
object
​
transcription
string

AI-generated transcription

​
anonymous
boolean
Example:

false

​
clientId
string<objectid>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>