Open Context Protocol is live! 🚀 Read the launch post

listConference

Retrieve a list of conferences belonging to the account used to make the request

Details

  • Method: GET
  • Path: /2010-04-01/Accounts/{AccountSid}/Conferences.json
  • Operation ID: ListConference

Parameters

{
  "AccountSid": {
    "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to read.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "DateCreated": {
    "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "DateCreated<": {
    "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "DateCreated>": {
    "description": "Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read conferences that were created on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "DateUpdated": {
    "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "DateUpdated<": {
    "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "DateUpdated>": {
    "description": "Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last updated on or before midnight of this date, and `DateUpdated>=YYYY-MM-DD` to read conferences that were last updated on or after midnight of this date.",
    "required": false,
    "location": "query",
    "type": "string",
    "format": "date"
  },
  "FriendlyName": {
    "description": "The string that identifies the Conference resources to read.",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "Status": {
    "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.",
    "required": false,
    "location": "query",
    "type": "string",
    "enum": [
      "init",
      "in-progress",
      "completed"
    ]
  },
  "PageSize": {
    "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "Page": {
    "description": "The page index. This value is simply for client state.",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "PageToken": {
    "description": "The page token. This is provided by the API.",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "title": "ListConferenceResponse",
  "type": "object",
  "properties": {
    "conferences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "account_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^AC[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Conference resource."
          },
          "date_created": {
            "type": "string",
            "format": "date-time-rfc-2822",
            "nullable": true,
            "description": "The date and time in UTC that this resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
          },
          "date_updated": {
            "type": "string",
            "format": "date-time-rfc-2822",
            "nullable": true,
            "description": "The date and time in UTC that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
          },
          "api_version": {
            "type": "string",
            "nullable": true,
            "description": "The API version used to create this conference."
          },
          "friendly_name": {
            "type": "string",
            "nullable": true,
            "description": "A string that you assigned to describe this conference room. Maximum length is 128 characters."
          },
          "region": {
            "type": "string",
            "nullable": true,
            "description": "A string that represents the Twilio Region where the conference audio was mixed. May be `us1`, `us2`, `ie1`,  `de1`, `sg1`, `br1`, `au1`, and `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference audio will be mixed nearest to the majority of participants."
          },
          "sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^CF[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The unique, Twilio-provided string used to identify this Conference resource."
          },
          "status": {
            "type": "string",
            "enum": [
              "init",
              "in-progress",
              "completed"
            ],
            "description": "The status of this conference. Can be: `init`, `in-progress`, or `completed`."
          },
          "uri": {
            "type": "string",
            "nullable": true,
            "description": "The URI of this resource, relative to `https://api.twilio.com`."
          },
          "subresource_uris": {
            "type": "object",
            "format": "uri-map",
            "nullable": true,
            "description": "A list of related resources identified by their URIs relative to `https://api.twilio.com`."
          },
          "reason_conference_ended": {
            "type": "string",
            "enum": [
              "conference-ended-via-api",
              "participant-with-end-conference-on-exit-left",
              "participant-with-end-conference-on-exit-kicked",
              "last-participant-kicked",
              "last-participant-left"
            ],
            "description": "The reason why a conference ended. When a conference is in progress, will be `null`. When conference is completed, can be: `conference-ended-via-api`, `participant-with-end-conference-on-exit-left`, `participant-with-end-conference-on-exit-kicked`, `last-participant-kicked`, or `last-participant-left`."
          },
          "call_sid_ending_conference": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^CA[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The call SID that caused the conference to end."
          }
        }
      }
    },
    "end": {
      "type": "integer"
    },
    "first_page_uri": {
      "format": "uri",
      "type": "string"
    },
    "next_page_uri": {
      "format": "uri",
      "nullable": true,
      "type": "string"
    },
    "page": {
      "type": "integer"
    },
    "page_size": {
      "type": "integer"
    },
    "previous_page_uri": {
      "format": "uri",
      "nullable": true,
      "type": "string"
    },
    "start": {
      "type": "integer"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('twilio')

# Call this tool
result = await agent.call_tool('listConference', {
    # Add required parameters here
})