Chilkat Online Tools

Swift3 / Plivo REST API / Send digits on an active call

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{auth_id}}"
    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.

    // {
    //   "digits": "1234",
    //   "leg": "aleg"
    // }

    let json = CkoJsonObject()!
    json.update("digits", value: "1234")
    json.update("leg", value: "aleg")

    var resp: CkoHttpResponse? = http.postJson3("https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/DTMF/", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "digits":"1234",
    "leg":"aleg"
}'
https://api.plivo.com/v1/Account/<auth_id>/Call/{call_uuid}/DTMF/

Postman Collection Item JSON

{
  "name": "Send digits on an active call",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"digits\":\"1234\",\n    \"leg\":\"aleg\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/DTMF/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Call",
        "{call_uuid}",
        "DTMF",
        ""
      ]
    },
    "description": "This endpoint allows you to send DTMF digits on 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/dtmf#send-digits-on-a-call)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| digits      | Set of digits that need to be sent over the call.| Required  |\n| leg      | This is the leg of the call in which the DTMF should be sent. This can take the values aleg (the current call) or bleg (the other party in a Dial). Defaults to aleg.| Optional  |"
  },
  "response": [
    {
      "name": "Send digits on an active call",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"digits\":\"1234\",\n    \"leg\":\"aleg\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Call/{call_uuid}/DTMF/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Call",
            "{call_uuid}",
            "DTMF",
            ""
          ]
        }
      },
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"digits sent\",\n    \"api_id\": \"07abfd94-58c0-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}