Chilkat Online Tools

SQL Server / Plivo REST API / Play Text During a Call

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{auth_id}}'
    EXEC sp_OASetProperty @http, '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"
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'text', 'Hello world'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'voice', 'WOMAN'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'language', 'en-US'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'legs', 'aleg'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'loop', 'false'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'mix', 'true'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/Speak/', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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