Chilkat Online Tools

PureBasic / Plivo REST API / Retrieve a conference

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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")

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

    success = CkHttp::ckQuickGetSb(http,"https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Conference/{conference_name}/

Postman Collection Item JSON

{
  "name": "Retrieve a conference",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Conference",
        "{conference_name}",
        ""
      ]
    },
    "description": "Retrieves the details of a particular conference.\n\nMore information can be found [here](https://www.plivo.com/docs/voice/api/conference#retrieve-a-conference)"
  },
  "response": [
    {
      "name": "Retrieve a conference",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Conference/{conference_name}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Conference",
            "{conference_name}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"conference_name\": \"My Conf Room\",\n    \"conference_run_time\": \"590\",\n    \"conference_member_count\": \"1\",\n    \"members\": [\n        {\n            \"muted\": false,\n            \"member_id\": \"17\",\n            \"deaf\": false,\n            \"from\": \"1456789903\",\n            \"to\": \"1677889900\",\n            \"caller_name\": \"John\",\n            \"direction\": \"inbound\",\n            \"call_uuid\": \"acfbf0b5-12e0-4d74-85f7-fce15f8f07ec\",\n            \"join_time\": \"590\"\n        }\n    ],\n    \"api_id\": \"816e903e-58c4-11e1-86da-adf28403fe48\"\n}"
    }
  ]
}