Skip to main content
POST
/
v1
/
voice
/
calls
/
tts
Voice Call Tts
curl --request POST \
  --url https://karibu.briq.tz/v1/voice/calls/tts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "receiver_number": "<string>",
  "text": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-API-Key
string
required

Body

application/json

Request to place a voice call that speaks the given text (text-to-speech).

​
receiver_number
string
required

E.164 or national number to call (e.g. 255788344348).

Example:

"255788344348"

​
text
string
required

Text to be spoken to the recipient (text-to-speech).

Minimum string length: 1
Example:

"Hello, this is a message from Briq."

Response

Successful Response