Chilkat Online Tools

Go / Plivo REST API / Play text to a member

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("{{auth_id}}")
    http.SetPassword("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"
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("text","Hello World")
    json.UpdateString("voice","WOMAN")
    json.UpdateString("language","en-US")

    resp := http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/Member/{member_id}/Speak/","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    fmt.Println(resp.StatusCode())
    fmt.Println(resp.BodyStr())
    resp.DisposeHttpResponse()

    http.DisposeHttp()
    json.DisposeJsonObject()

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "text":"Hello World",
    "voice":"WOMAN",
    "language":"en-US"
}'
https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/Member/{member_id}/Speak/

Postman Collection Item JSON

{
  "name": "Play text to a member",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"text\":\"Hello World\",\n    \"voice\":\"WOMAN\",\n    \"language\":\"en-US\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/Member/{member_id}/Speak/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Conference",
        "{conference_name}",
        "Member",
        "{member_id}",
        "Speak",
        ""
      ]
    },
    "description": "This API will play text to a member in a conference.\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/conference/member#play-text-to-a-member)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| text      | The text that should be played to the members in the conference.| Required  |\n| voice      | The voice to be used. Can be MAN or WOMAN. Defaults to 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 Languages supported section.| Optional  |"
  },
  "response": [
    {
      "name": "Play text to a member",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"text\":\"Hello World\",\n    \"voice\":\"WOMAN\",\n    \"language\":\"en-US\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/Member/{member_id}/Speak/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Conference",
            "{conference_name}",
            "Member",
            "{member_id}",
            "Speak",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"speak queued into conference\",\n    \"api_id\": \"8dd6820e-fe83-11e6-b6f4-061564b78b75\",\n    \"member_id\": \"[u'all']\"\n}"
    }
  ]
}