AXaxilioai
Phones

List sessions

Changed on

Returns one page of the org's phone sessions for the Session Inspector table: active/unbilled sessions pinned on top, terminal history paginated beneath. Covers agents' runs and interactive leases; each row links to a session. Filters: search, agent_id, status.

get/phones/sessions

Request

Query parameters

limitinteger

max rows to return

offsetinteger

rows to skip for pagination

searchstring

case-insensitive match on phone/session/agent

agent_idstring

only sessions of this agent's runs

statusstring[] nullable

only sessions at one of these statuses; repeatable

sourcestring[] nullable

only sessions from one of these sources; repeatable

dedicatedstring[] nullable

only sessions on shared and/or dedicated phones; repeatable

allocated_afterstring date-time

only sessions allocated at/after this time (RFC 3339)

allocated_beforestring date-time

only sessions allocated at/before this time (RFC 3339)

deallocated_afterstring date-time

only sessions de-allocated at/after this time (RFC 3339)

deallocated_beforestring date-time

only sessions de-allocated at/before this time (RFC 3339)

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc; field is allocated_at, deallocated_at, status, duration_seconds or source.

Response

OK

history_unavailableboolean

True when older sessions could not be read in time: this page holds only live and recently ended sessions, and total counts only those. Retry shortly.

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of sessions matching the query.

Changes

  • 62aa324803a7Revision changes
    • breaking

      removed the enum value workflow from the property items/ of the query request parameter source

    • warning

      deleted the query request parameter workflow_id

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new agent enum value to the // response property for the response status

    • info

      added the new optional query request parameter agent_id

    • info

      added the enum value agent to the property items/ of the query request parameter source

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the workflow enum value from the // response property for the response status

    • info

      removed the workflow_editor enum value from the // response property for the response status

  • ecca093572e0Revision changes
    • breaking

      for the query request parameter limit, default value 50 was added

    • breaking

      for the query request parameter offset, default value 0 was added

    • warning

      for the query request parameter limit, the max was set to 100.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter offset, the min was set to 0.00

    • warning

      deleted the query request parameter ended_after

    • warning

      deleted the query request parameter ended_before

    • warning

      deleted the query request parameter order

    • warning

      deleted the query request parameter sort

    • warning

      deleted the query request parameter started_after

    • warning

      deleted the query request parameter started_before

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter allocated_after

    • info

      added the new optional query request parameter allocated_before

    • info

      added the new optional query request parameter deallocated_after

    • info

      added the new optional query request parameter deallocated_before

    • info

      added the new optional query request parameter order_by

    • info

      added the enum value active to the property items/ of the query request parameter status

    • info

      added the enum value cancelled to the property items/ of the query request parameter status

    • info

      added the enum value completed to the property items/ of the query request parameter status

    • info

      added the enum value dedicated to the property items/ of the query request parameter dedicated

    • info

      added the enum value expired to the property items/ of the query request parameter status

    • info

      added the enum value interactive to the property items/ of the query request parameter source

    • info

      added the enum value shared to the property items/ of the query request parameter dedicated

    • info

      added the enum value workflow to the property items/ of the query request parameter source

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status