Webex · Example Payload

Webex Listsummaries Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Listsummaries Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "listSummaries",
  "method": "POST",
  "path": "/generated-summaries/search",
  "summary": "List summaries",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "listByOrganization",
      "example": {
        "searchType": "ORGANIZATION",
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da"
      }
    },
    {
      "contentType": "application/json",
      "name": "listByInteraction",
      "example": {
        "searchType": "INTERACTION",
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
        "interactionId": "9d2a7879-8957-4cd6-a39c-46d4f21eaea5"
      }
    },
    {
      "contentType": "application/json",
      "name": "listByAgentCiUserId",
      "example": {
        "searchType": "AGENT",
        "agentCiUserId": "77e70d79-64b1-402e-9b84-b113ad71b06d",
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "listByOrganization",
      "example": {
        "interactionId": null,
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
        "searchType": "ORGANIZATION",
        "agentCiUserId": null,
        "summaries": {
          "POST_CALL": {
            "acc80d18-b1fb-4261-b44e-a46435eea1da:1bf3bd99-633b-401a-a3d4-61157a446809:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
              "initialContactReason": "Broken tools appointment request",
              "additionalContext": "Customer mentioned they had previously tried to fix the tools themselves but were unsuccessful.",
              "additionalContactReasons": "Customer also asked about warranty coverage for the broken tools.",
              "keyActionsTaken": "Scheduled an appointment with Doctor Petrophe for the caller",
              "nextSteps": "Confirm appointment details via email and follow up on warranty inquiry.",
              "chosenWrapUpCode": "Appointment Scheduled",
              "proposedWrapUpCodes": [
                {
                  "name": "Appointment Scheduled"
                },
                {
                  "name": "Service Request"
                }
              ]
            }
          },
          "MID_CALL": {
            "acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
              "reasonForTransferOrConsult": "The caller wants to purchase fifteen tickets for an upcoming match but the current agent needs to check with teammates for ticket availability, requiring a transfer to another agent who can assist with ticket sales.",
              "additionalContext": "The match will take place next weekend at 6 PM, and the caller is part of a group looking to buy a large number of tickets.",
              "keyActionsTaken": "Checked the match schedule\\nInquired about the number of tickets needed\\nInitiated a transfer to check ticket availability with teammates"
            }
          }
        },
        "queueId": null
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "listByInteraction",
      "example": {
        "interactionId": "9d2a7879-8957-4cd6-a39c-46d4f21eaea5",
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
        "searchType": "INTERACTION",
        "agentCiUserId": null,
        "summaries": {
          "POST_CALL": {
            "acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
              "initialContactReason": "The caller wants to buy tickets for a match.",
              "additionalContext": "The match is next weekend and the caller represents a group looking for tickets.",
              "additionalContactReasons": "The caller also inquired about group discount options.",
              "keyActionsTaken": "The agent checked ticket availability with teammates.\\nThe agent engaged with the caller about their request.",
              "nextSteps": "Agent will confirm ticket availability for fifteen tickets and get back to the caller.",
              "chosenWrapUpCode": "Ticket Inquiry",
              "proposedWrapUpCodes": [
                {
                  "name": "Ticket Inquiry"
                },
                {
                  "name": "Group Booking"
                }
              ]
            }
          },
          "MID_CALL": {
            "acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
              "reasonForTransferOrConsult": "The caller wants to purchase fifteen tickets for an upcoming match but the current agent needs to check with teammates for ticket availability, requiring a transfer to another agent who can assist with ticket sales.",
              "additionalContext": "The match will take place next weekend at 6 PM, and the caller is part of a group looking to buy a large number of tickets.",
              "keyActionsTaken": "Checked the match schedule\\nInquired about the number of tickets needed\\nInitiated a transfer to check ticket availability with teammates"
            }
          }
        },
        "queueId": null
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "listByAgentCiUserId",
      "example": {
        "interactionId": null,
        "orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
        "searchType": "AGENT",
        "agentCiUserId": "77e70d79-64b1-402e-9b84-b113ad71b06d",
        "summaries": {
          "POST_CALL": {
            "acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:77e70d79-64b1-402e-9b84-b113ad71b06d": {
              "initialContactReason": "Customer wants to buy tickets for an upcoming match.",
              "additionalContext": "Customer has a group of fifteen people and needs the tickets to be together.",
              "additionalContactReasons": "Customer asked about group seating arrangements.",
              "keyActionsTaken": "Checked availability of fifteen tickets for the match.\\nConfirmed grouped discount for the tickets.\\nProcessed the ticket purchase and confirmed ticket sending via email.",
              "nextSteps": "Send the tickets to the customer's email.",
              "chosenWrapUpCode": "Ticket Purchase",
              "proposedWrapUpCodes": [
                {
                  "name": "Ticket Purchase"
                },
                {
                  "name": "Group Booking"
                }
              ]
            }
          }
        },
        "queueId": null
      }
    }
  ]
}