To get conversation with segment id

GET /v1/Insights/Conversations

To get conversation with segment id

Headers

  • Authorization string

    The Authorization HTTP request header

Query parameters

  • SegmentId string

    Unique Id of the segment for which conversation details needs to be fetched

  • 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
    • conversations array[object]
      Hide conversations attributes Show conversations attributes object
      • account_id string | null

        The id of the account.

      • conversation_id string | null

        The unique id of the conversation

      • segment_count integer

        The count of segments for a conversation

        Default value is 0.

      • segments array | null

        The Segments of a conversation

    • 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)
GET /v1/Insights/Conversations
curl \
 --request GET 'https://flex-api.twilio.com/v1/Insights/Conversations' \
 --user "username:password" \
 --header "Authorization: string"
Response examples (200)
{
  "meta": {
    "key": "conversations",
    "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "conversations": []
}
{
  "meta": {
    "key": "conversations",
    "url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "conversations": [
    {
      "segments": [
        {
          "order": 0,
          "offset": 1.542,
          "talk_time": 18,
          "timestamp": "2022-05-11T16:02:27.659Z",
          "agent_name": "First Agent",
          "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a4"
        },
        {
          "order": 0,
          "offset": 1.211,
          "talk_time": 10,
          "timestamp": "2022-05-21T16:02:27.659Z",
          "agent_name": "Second Agent",
          "segment_id": "02dd8a65-c9e3-550b-9e98-5b11abb9b3a5"
        }
      ],
      "account_id": "76e4c1c3-6f93-5d08-ae66-aad4b9092f2d",
      "segment_count": 2,
      "conversation_id": "2cb2452a-c6d9-564d-b285-b5404f073031"
    }
  ]
}