First Project Guide
  • 24 Jul 2023
  • 1 Minute to read
  • Contributors
  • PDF

First Project Guide

  • PDF

Article summary

After getting tenant credentials for both UI (admin) and API, the user can authorize with given user name (client_id for API) and password (client_secret for API).

Creating Department and Agent (API)

  1. Post Department
    {
    "name": "firstProjectGuide",
    }

postDepartment

Posting the department of 'firstProjectGuide'

After clicking on 'Execute', server response code should be 200.

  1. Post Agent (Users)
    {
    "userName": "doc360",
    "name": "docs",
    "surname": "knovvu",
    "email": "doc360@knovvu.com",
    "password": "123456789knoVVu.",
    "department": {
    "externalId": "3a0c8434-983a-0f2c-f2df-3d04aa16eff4"
    },
    "roleIds": [
    "3a0bc68f-e09e-ba46-c081-b66bf7979315"
    ],

    "isActive": true
    }

*externalId of the department ('firstProjectGuide') and roleId of the user (agent) can be found using Get command for Departments and Roles.

postAgent

Posting the agent of 'doc360'

After clicking on 'Execute', server response code should be 200. Then the agent page of 'doc360' gets activated on UI and the user can login typing user name and password defined above.

Importing Call (API)

  1. Post Call
    {
    "externalId": "doc360FirstCall",
    "callerNumber": "123",
    "calledNumber": "456",
    "agent": {
    "agentId": "3a0c7a5c-4c8c-2509-e47c-7a7a55ee8624"
    },

    "startTime": "2023-07-19T08:07:52.341Z",
    "endTime": "2023-07-19T08:07:52.341Z",
    "sourceName": "Default Api Source",
    }

agentID of 'doc360' can be found using Get command for Users.

postCall

Posting a call

After clicking on 'Execute', server response code should be 200.

  1. Put Call
    "externalId": "doc360FirstCall",
    upload file (An audio file is chosen.)

putCall

Putting a call

After clicking on 'Execute', server response code should be 200 and the call is uploaded. Results of the analysis can be checked on both admin and agent pages on UI.

putCallUI

Analysis of the call on UI

Importing Chat (API)

  1. Post Chat
    {
    "externalId": "doc360FirstChat",
    "agent": {
    "agentId": "3a0c7a5c-4c8c-2509-e47c-7a7a55ee8624"
    },

    "startTime": "2023-07-19T08:07:52.341Z",
    "endTime": "2023-07-19T08:07:52.341Z",
    "chatLines": [
    {
    "time": "2023-07-19T08:07:52.341Z",
    "text": "hello",
    "sideId": 1
    },
    {
    "time": "2023-07-19T08:08:52.341Z",
    "text": "hi",
    "sideId": 2
    }
    ],
    "sourceName": "Default Api Source",
    }

agentID of 'doc360' can be found using Get command for Users.

postChat

Posting a chat

After clicking on 'Execute', server response code should be 200 and the chat is uploaded. Results of the analysis can be checked on both admin and agent pages on UI.

postChatUI

Analysis of the chat on UI


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.