API Directory

This API is to integrate Jinie with third-party bots. It processes the user query using NLP and responds basis the user intent.

Request

POST https://domain.peoplestrong.com/api/bot/v1/chat

Request body

The request body takes a complete Request Object resource, containing the following writable properties:

{
    "apiSessionId": "string",
    "orgCode": "string",
    "replayData": {
        "action": "string",
        "category": "string",
        "formName": "string",
        "refresh": "boolean",
        "ssoToken": "string"
    },
    "replayDataId": "string",
    "reply": "boolean",
    "text": "string",
    "userName": "string"
}

Properties

Name Type Description Additional
apiSessionId string

This filed will be blank. if it was not recieved from the API in previous response else value recieved in the previous response has to be send.

Optional
orgCode string

The code will be shared by peoplestroiing as part of integration process

Optional
replayData object

This object will has to be passesd as Is in the user request as it was recieved in the previous response

Optional
replayData.action string Optional
replayData.category string Optional
replayData.formName string Optional
replayData.refresh boolean Optional
replayData.ssoToken string Optional
replayDataId string

This filed will be blank. if it was not recieved from the API in previous response else value recieved in the previous response has to be send.

Optional
reply boolean

If the request id bases on prevoius response type Question by api then value will be true

Optional
text string

request generated by the user. If the request id bases on prevoius response type Question by api then valye will be Yes/No

Optional
userName string

User loginId that was used to authenticate the app

Optional

Authorisation

This request requires the use of one of following authorisation methods: API key OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
read read records
write modify records

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

Response Object
401 Unauthorized

No API key found in request

Token Error
403 Forbidden

Your IP address is not allowed

Forbidden
404 Not Found

no route and no API found with those values

API rate limit exceeded
405 Method Not Allowed

API rate limit exceeded

API rate limit exceeded
426

Please use HTTPS protocol

Use HTTPS

Explore this API

body
Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Access Token Access token to be used for request
Try it out!