Delphi (DLL) / Plivo REST API / Hold a member
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'{{auth_id}}');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(json,'action','hold');
Curl Command
curl -X POST
-u '{{auth_id}}:password'
-d '{
"action": "hold"
}'
https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}/members/{member_address}
Postman Collection Item JSON
{
"name": "Hold a member",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"hold\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}/members/{member_address}",
"protocol": "https",
"host": [
"phlorunner",
"plivo",
"com"
],
"path": [
"v1",
"phlo",
"{phlo_id}",
"multi_party_call",
"{node_id}",
"members",
"{member_address}"
]
},
"description": "Places a member in the Multi-Party Call on hold. When a member places the call on hold, the member will be muted and the other members will hear the hold music. Agent Hold music and Customer hold music can be configured in the component.\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/phlo/api/phlo/multi-party-call/member#hold-a-member)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| action | Set this parameter to \"hold\"| Required |"
},
"response": [
{
"name": "Hold a member",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"hold\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://phlorunner.plivo.com/v1/phlo/{phlo_id}/multi_party_call/{node_id}/members/{member_address}",
"protocol": "https",
"host": [
"phlorunner",
"plivo",
"com"
],
"path": [
"v1",
"phlo",
"{phlo_id}",
"multi_party_call",
"{node_id}",
"members",
"{member_address}"
]
}
},
"code": 200,
"_postman_previewlanguage": "json",
"header": [
],
"cookie": [
],
"body": "{\n \"api_id\": \"11d8c251-d7bf-4aba-9763-985f21bcb455\",\n \"error\": \"\"\n}"
}
]
}