Chilkat Online Tools

PureBasic / Plivo REST API / Posting Call Quality Feedback Using API

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{auth_id}}")
    CkHttp::setCkPassword(http, "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.

    ; {
    ;   "call_uuid": "9834029e-58b6-11e1-b8b7-a5bd0e4e126f",
    ;   "rating": "3",
    ;   "issues": "ECHO",
    ;   "Notes": "It's intermittent"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"call_uuid","9834029e-58b6-11e1-b8b7-a5bd0e4e126f")
    CkJsonObject::ckUpdateString(json,"rating","3")
    CkJsonObject::ckUpdateString(json,"issues","ECHO")
    CkJsonObject::ckUpdateString(json,"Notes","It's intermittent")

    resp.i = CkHttp::ckPostJson3(http,"https://stats.plivo.com/v1/Call/{call_uuid}/Feedback/","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "call_uuid":"9834029e-58b6-11e1-b8b7-a5bd0e4e126f",
    "rating":"3",
    "issues":"ECHO",
    "Notes":"It\'s intermittent"
}'
https://stats.plivo.com/v1/Call/{call_uuid}/Feedback/

Postman Collection Item JSON

{
  "name": "Posting Call Quality Feedback Using API",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"call_uuid\":\"9834029e-58b6-11e1-b8b7-a5bd0e4e126f\",\n    \"rating\":\"3\",\n    \"issues\":\"ECHO\",\n    \"Notes\":\"It's intermittent\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://stats.plivo.com/v1/Call/{call_uuid}/Feedback/",
      "protocol": "https",
      "host": [
        "stats",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Call",
        "{call_uuid}",
        "Feedback",
        ""
      ]
    },
    "description": "This method allows you to post feedback for calls. Call quality feedback information received through this API is accessible on the Call Debug UI. Aggregated reports are available for analyses on the Call Insights Reporting Dashboard.\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#post-feedback)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| call_uuid      |The call uuid of the call for which feedback is being posted.| Required  |\n| rating   | Quality rating for the call, allowed values are, float between [1,5]. PS: for integer values both ‘x’ or ‘x.`0’ are accepted.  | Required |\n| issues   | List of issues observed on the call. One or more of the following:<br />'AUDIO_LAG','BROKEN_AUDIO','CALL_DROPPED','CALLERID_ISSUE','DIGITS_NOT_CAPTURED','ECHO','HIGH_CONNECT_TIME','LOW_AUDIO_LEVEL','ONE_WAY_AUDIO','OTHERS','ROBOTIC_AUDIO' | Required only if rating is <5 <br />|\n| Notes   | This is an optional free text field. It can be used to send descriptive feedback for the call.| Optional |"
  },
  "response": [
    {
      "name": "Posting Call Quality Feedback Using API",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"call_uuid\":\"9834029e-58b6-11e1-b8b7-a5bd0e4e126f\",\n    \"rating\":\"3\",\n    \"issues\":\"ECHO\",\n    \"Notes\":\"It's intermittent\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://stats.plivo.com/v1/Call/{call_uuid}/Feedback/",
          "protocol": "https",
          "host": [
            "stats",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Call",
            "{call_uuid}",
            "Feedback",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"Feedback has been Posted\",\n    \"api_id\": \"97ceeb52-58b6-11e1-86da-77300b68f8bb\",\n    \"status\": \"success\"\n}"
    }
  ]
}