Chilkat Online Tools

DataFlex / Plivo REST API / Add user to a Multi-Party Call

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Set ComBasicAuth Of hoHttp To True
    Set ComLogin Of hoHttp To "{{auth_id}}"
    Set ComPassword Of hoHttp To "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.

    // {
    //   "action": "call",
    //   "to": "+14152225555",
    //   "role": "agent",
    //   "trigger_source": "+14152223333"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "action" "call" To iSuccess
    Get ComUpdateString Of hoJson "to" "+14152225555" To iSuccess
    Get ComUpdateString Of hoJson "role" "agent" To iSuccess
    Get ComUpdateString Of hoJson "trigger_source" "+14152223333" To iSuccess

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "action": "call",
    "to": "+14152225555",
    "role": "agent",
    "trigger_source": "+14152223333"
}'
https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}

Postman Collection Item JSON

{
  "name": "Add user to a Multi-Party Call",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"action\": \"call\",\n    \"to\": \"+14152225555\",\n    \"role\": \"agent\",\n    \"trigger_source\": \"+14152223333\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}",
      "protocol": "https",
      "host": [
        "phlorunner",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "phlo",
        "{phlo_id}",
        "multi_party_call",
        "{node_id}"
      ]
    },
    "description": "Dials a phone number or a SIP endpoint and adds the user to the Multi-Party Call. Below is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/phlo/api/phlo/multi-party-call/update-a-multi-party-call#add-user-to-call)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| action      | Set this parameter \"call\".| Required  |\n| to   | Phone number or SIP endpoint address of the user to add to the Multi-party Call| Required      |\n| role   | Role of the user added to the Multi-Party Call. Allowed values are 'customer' and 'agent'. Defaults to agent. | Required |\n| trigger_source   | Phone number or SIP endpoint address of the user (agent) initiating the trigger      | Required      |"
  },
  "response": [
    {
      "name": "Add user to a Multi-Party Call",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"action\": \"call\",\n    \"to\": \"+14152225555\", // Phone number or SIP endpoint address of the user to add to the Multi-party Call.\n    \"role\": \"agent\", // Role of the user added to the Multi-Party Call. Allowed values are 'customer' and 'agent'. Defaults to agent.\n    \"trigger_source\": \"+14152223333\" //Phone number or SIP endpoint address of the user (agent) initiating the trigger.\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}",
          "protocol": "https",
          "host": [
            "phlorunner",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "phlo",
            "{phlo_id}",
            "multi_party_call",
            "{node_id}"
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"073e36d4-fd1e-4be3-b00b-ab33105011a7\",\n    \"error\": \"\"\n}"
    }
  ]
}