Chilkat Online Tools

VB.NET / Plivo REST API / Add user to a Multi-Party Call

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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.

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

Dim json As New Chilkat.JsonObject
json.UpdateString("action","call")
json.UpdateString("to","+14152225555")
json.UpdateString("role","agent")
json.UpdateString("trigger_source","+14152223333")


Dim resp As Chilkat.HttpResponse = http.PostJson3("https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

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}"
    }
  ]
}