Headers

• Authorization string

  The Authorization HTTP request header

Query parameters

• SegmentId string

  To unique id of the segment

• ReservationId array[string]

  The list of reservation Ids

  Minimum length of each is 34, maximum length of each is 34. Format of each should match the following pattern: ^WR[0-9a-fA-F]{32}$.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • segments array[object]
    Hide segments attributes Show segments attributes object

    • segment_id string | null

      To unique id of the segment

    • external_id string | null

      The unique id for the conversation.

    • queue string | null
    • external_contact string | null
    • external_segment_link_id string | null

      The uuid for the external_segment_link.

    • date string | null

      The date of the conversation.

    • account_id string | null

      The unique id for the account.

    • external_segment_link string | null

      The hyperlink to recording of the task event.

    • agent_id string | null

      The unique id for the agent.

    • agent_phone string | null

      The phone number of the agent.

    • agent_name string | null

      The name of the agent.

    • agent_team_name string | null

      The team name to which agent belongs.

    • agent_team_name_in_hierarchy string | null

      he team name to which agent belongs.

    • agent_link string | null

      The link to the agent conversation.

    • customer_phone string | null

      The phone number of the customer.

    • customer_name string | null

      The name of the customer.

    • customer_link string | null

      The link to the customer conversation.

    • segment_recording_offset string | null

      The offset value for the recording.

    • media

      The media identifiers of the conversation.

    • assessment_type

      The type of the assessment.

    • assessment_percentage

      The percentage scored on the Assessments.

    • url string(uri) | null
  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)