{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Conference Commands API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Conference Commands",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List conferences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/conferences",
            "params": [
              {
                "name": "region",
                "value": "",
                "type": "query",
                "description": "Region where the conference data is located"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]"
              }
            ]
          },
          "docs": "Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`."
        },
        {
          "info": {
            "name": "Create conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.\n\n**Expected Webhooks:**\n\n- `conference.created`\n- `conference.participant.joined`\n- `conference.participant.left`\n- `conference.ended`\n- `conference.recording.saved`\n- `conference"
        },
        {
          "info": {
            "name": "List conference participants",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/conferences/:conference_id/participants",
            "params": [
              {
                "name": "conference_id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id"
              },
              {
                "name": "region",
                "value": "",
                "type": "query",
                "description": "Region where the conference data is located"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[muted], filter[on_hold], filter[whispering]"
              }
            ]
          },
          "docs": "Lists conference participants"
        },
        {
          "info": {
            "name": "Retrieve a conference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/conferences/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id"
              },
              {
                "name": "region",
                "value": "",
                "type": "query",
                "description": "Region where the conference data is located"
              }
            ]
          },
          "docs": "Retrieve an existing conference"
        },
        {
          "info": {
            "name": "End a conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/end",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "End a conference and terminate all active participants."
        },
        {
          "info": {
            "name": "Gather DTMF using audio prompt in a conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/gather_using_audio",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Play an audio file to a specific conference participant and gather DTMF input."
        },
        {
          "info": {
            "name": "Hold conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/hold",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Hold a list of participants in a conference call"
        },
        {
          "info": {
            "name": "Join a conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/join",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the `call_control_id` of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the `max_participants` parameter in conference creation request. \n\n**Expected Webhooks:**\n\n- `conference.participant.joined`\n- `conference.participant.left`\n"
        },
        {
          "info": {
            "name": "Leave a conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/leave",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Removes a call leg from a conference and moves it back to parked state. \n\n**Expected Webhooks:**\n\n- `conference.participant.left`\n"
        },
        {
          "info": {
            "name": "Mute conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/mute",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Mute a list of participants in a conference call"
        },
        {
          "info": {
            "name": "Play audio to conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/play",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Play audio to all or some participants on a conference call."
        },
        {
          "info": {
            "name": "Conference recording pause",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_pause",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Specifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Pause conference recording."
        },
        {
          "info": {
            "name": "Conference recording resume",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_resume",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Specifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resume conference recording."
        },
        {
          "info": {
            "name": "Conference recording start",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_start",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Specifies the conference to record by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`"
        },
        {
          "info": {
            "name": "Conference recording stop",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_stop",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Specifies the conference to stop the recording for by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stop recording the conference.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`\n"
        },
        {
          "info": {
            "name": "Send DTMF to conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/send_dtmf",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send DTMF tones to one or more conference participants."
        },
        {
          "info": {
            "name": "Speak text to conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/speak",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Specifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Convert text to speech and play it to all or some participants."
        },
        {
          "info": {
            "name": "Stop audio being played on the conference",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/stop",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stop audio being played to all or some participants on a conference call."
        },
        {
          "info": {
            "name": "Unhold conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/unhold",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unhold a list of participants in a conference call"
        },
        {
          "info": {
            "name": "Unmute conference participants",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/unmute",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unmute a list of participants in a conference call"
        },
        {
          "info": {
            "name": "Update conference participant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/conferences/:id/actions/update",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference by id or name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update conference participant supervisor_role"
        },
        {
          "info": {
            "name": "Retrieve a conference participant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/conferences/:id/participants/:participant_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference."
              },
              {
                "name": "participant_id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the participant by their ID or label."
              }
            ]
          },
          "docs": "Retrieve details of a specific conference participant by their ID or label."
        },
        {
          "info": {
            "name": "Update a conference participant",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/conferences/:id/participants/:participant_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the conference."
              },
              {
                "name": "participant_id",
                "value": "",
                "type": "path",
                "description": "Uniquely identifies the participant."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update properties of a conference participant."
        }
      ]
    }
  ],
  "bundled": true
}