Chilkat Online Tools

Foxpro / Plivo REST API / Play Text During a Call

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "{{auth_id}}"
loHttp.Password = "password"

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "text": "Hello world",
*   "voice": "WOMAN",
*   "language": "en-US",
*   "legs": "aleg",
*   "loop": "false",
*   "mix": "true"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("text","Hello world")
loJson.UpdateString("voice","WOMAN")
loJson.UpdateString("language","en-US")
loJson.UpdateString("legs","aleg")
loJson.UpdateString("loop","false")
loJson.UpdateString("mix","true")

loResp = loHttp.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Speak/","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "text":"Hello world",
    "voice":"WOMAN",
    "language":"en-US",
    "legs":"aleg",
    "loop":"false",
    "mix":"true"
}'
https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Speak/

Postman Collection Item JSON

{
  "name": "Play Text During a Call",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"text\":\"Hello world\",\n    \"voice\":\"WOMAN\",\n    \"language\":\"en-US\",\n    \"legs\":\"aleg\",\n    \"loop\":\"false\",\n    \"mix\":\"true\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Speak/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        "{call_uuid}",
        "Speak",
        ""
      ]
    },
    "description": "This endpoint allows you to speak text in an active call.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/voice/api/call/speak-text-on-calls#speak-text-on-a-call)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| text      | The text that needs to be spoken in the ongoing call.| Required  |\n| voice      | The voice in which the text should be spoken. The two allowed values are MAN and WOMAN. The default voice used is WOMAN.| Optional  |\n| language      | The language that needs to be used to speak the text. The default language is US English (en-US). The complete list of supported languages can be found in List of Languages Supported section..| Optional  |\n| legs      | The call leg in which the text has to be spoken. This can take three values aleg (first leg of the call), bleg(second leg of the call) or both. The default value is aleg.| Optional  |\n| loop      | If set to true, the text will be spoken repeatedly unless stopped. The default value is set to false.| Optional  |\n| mix      | This flag is used to determine the behaviour of current call audio when the file is being played. If this is set to ‘false’ then participants of the call would not be able to hear anyone speaking in the call until the Play is stopped. If set to ‘true’ both call audio and the Play audio will be mixed and played. Defaults to true.| Optional  |"
  },
  "response": [
    {
      "name": "Play Text During a Call",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"text\":\"Hello world\",\n    \"voice\":\"WOMAN\",\n    \"language\":\"en-US\",\n    \"legs\":\"aleg\",\n    \"loop\":\"false\",\n    \"mix\":\"true\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/Speak/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            "{call_uuid}",
            "Speak",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"speak started\",\n    \"api_id\": \"07abfd94-58c0-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}