Get Conferences
GET {{baseUrl}}/accounts/:accountId/conferences?name=<string>&minCreatedTime=<string>&maxCreatedTime=<string>&pageSize=1000&pageToken=<string>
Returns a max of 1000 conferences, sorted by createdTime
from oldest to newest.
NOTE: If the number of conferences in the account is bigger than pageSize
, a Link
header (with format <{url}>; rel="next"
) will be returned in the response. The url can be used to retrieve the next page of conference records.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
name | string | Filter results by the name field. | |
minCreatedTime | string | Filter results to conferences which have a createdTime after or at minCreatedTime (in ISO8601 format). | |
maxCreatedTime | string | Filter results to conferences which have a createdTime before or at maxCreatedTime (in ISO8601 format). | |
pageSize | number | Specifies the max number of conferences that will be returned. | |
pageToken | string | Not intended for explicit use. To use pagination, follow the links in the Link header of the response, as indicated in the endpoint description. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","createdTime":"\u003cdateTime\u003e","completedTime":"\u003cdateTime\u003e","conferenceEventUrl":"\u003curi\u003e","conferenceEventMethod":"POST","tag":"\u003cstring\u003e","activeMembers":[{"callId":"\u003cstring\u003e","conferenceId":"\u003cstring\u003e","memberUrl":"\u003cstring\u003e","mute":"\u003cboolean\u003e","hold":"\u003cboolean\u003e","callIdsToCoach":["\u003cstring\u003e","\u003cstring\u003e"]},{"callId":"\u003cstring\u003e","conferenceId":"\u003cstring\u003e","memberUrl":"\u003cstring\u003e","mute":"\u003cboolean\u003e","hold":"\u003cboolean\u003e","callIdsToCoach":["\u003cstring\u003e","\u003cstring\u003e"]}]},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","createdTime":"\u003cdateTime\u003e","completedTime":"\u003cdateTime\u003e","conferenceEventUrl":"\u003curi\u003e","conferenceEventMethod":"POST","tag":"\u003cstring\u003e","activeMembers":[{"callId":"\u003cstring\u003e","conferenceId":"\u003cstring\u003e","memberUrl":"\u003cstring\u003e","mute":"\u003cboolean\u003e","hold":"\u003cboolean\u003e","callIdsToCoach":["\u003cstring\u003e","\u003cstring\u003e"]},{"callId":"\u003cstring\u003e","conferenceId":"\u003cstring\u003e","memberUrl":"\u003cstring\u003e","mute":"\u003cboolean\u003e","hold":"\u003cboolean\u003e","callIdsToCoach":["\u003cstring\u003e","\u003cstring\u003e"]}]}]