{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants WebChat API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "WebChat",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create an ACD chat conversation from an external customer.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations"
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resou"
        },
        {
          "info": {
            "name": "Get a WebChat deployment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/deployments/:deploymentId",
            "params": [
              {
                "name": "deploymentId",
                "value": "",
                "type": "path",
                "description": "Deployment Id"
              }
            ]
          },
          "docs": "Get a WebChat deployment"
        },
        {
          "info": {
            "name": "Update a WebChat deployment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/webchat/deployments/:deploymentId",
            "params": [
              {
                "name": "deploymentId",
                "value": "",
                "type": "path",
                "description": "Deployment Id"
              }
            ]
          },
          "docs": "Update a WebChat deployment"
        },
        {
          "info": {
            "name": "Delete a WebChat deployment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/webchat/deployments/:deploymentId",
            "params": [
              {
                "name": "deploymentId",
                "value": "",
                "type": "path",
                "description": "Deployment Id"
              }
            ]
          },
          "docs": "Delete a WebChat deployment"
        },
        {
          "info": {
            "name": "List WebChat deployments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/deployments"
          },
          "docs": "List WebChat deployments"
        },
        {
          "info": {
            "name": "Create WebChat deployment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/webchat/deployments"
          },
          "docs": "Create WebChat deployment"
        },
        {
          "info": {
            "name": "Get WebChat deployment settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/settings"
          },
          "docs": "This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings."
        },
        {
          "info": {
            "name": "Update WebChat deployment settings",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/webchat/settings"
          },
          "docs": "This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings."
        },
        {
          "info": {
            "name": "Remove WebChat deployment settings",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/webchat/settings"
          },
          "docs": "This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings."
        },
        {
          "info": {
            "name": "Get a media request in the conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/mediarequests/:mediaRequestId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "mediaRequestId",
                "value": "",
                "type": "path",
                "description": "mediaRequestId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/"
        },
        {
          "info": {
            "name": "Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/mediarequests/:mediaRequestId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "mediaRequestId",
                "value": "",
                "type": "path",
                "description": "mediaRequestId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/"
        },
        {
          "info": {
            "name": "Get all media requests to the guest in the conversation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/mediarequests",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Get a web chat conversation member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/members/:memberId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "memberId",
                "value": "",
                "type": "path",
                "description": "memberId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Remove a member from a chat conversation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/members/:memberId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "memberId",
                "value": "",
                "type": "path",
                "description": "memberId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Send a message in a chat conversation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/members/:memberId/messages",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "memberId",
                "value": "",
                "type": "path",
                "description": "memberId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Send a typing-indicator in a chat conversation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/members/:memberId/typing",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "memberId",
                "value": "",
                "type": "path",
                "description": "memberId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Get the members of a chat conversation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/members",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of entries to return per page, or omitted for the default."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "The page number to return, or omitted for the first page."
              },
              {
                "name": "excludeDisconnectedMembers",
                "value": "",
                "type": "query",
                "description": "If true, the results will not contain members who have a DISCONNECTED state."
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Get a web chat conversation message",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/messages/:messageId",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "messageId",
                "value": "",
                "type": "path",
                "description": "messageId"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        },
        {
          "info": {
            "name": "Get the messages of a chat conversation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/webchat/guest/conversations/:conversationId/messages",
            "params": [
              {
                "name": "conversationId",
                "value": "",
                "type": "path",
                "description": "conversationId"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "If available, get the messages chronologically after the id of this message"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "If available, get the messages chronologically before the id of this message"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query",
                "description": "Limit the returned number of messages, up to a maximum of 100"
              }
            ]
          },
          "docs": "This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/"
        }
      ]
    }
  ],
  "bundled": true
}