Additional APIs

Move a chat to pending

This API allows you to move chats for a Bot to an Agent via a POST request to the Haptik Platform.

Example URL: https://<base-url>/integration/external/v1.0/send_chat_to_agent/

Note: The base-url will be provided by Haptik at the time of integration.

Headers

Authorization: Bearer <TOKEN>
client-id: <CLIENT_ID>
Content-Type: application/json
Authorization -

The Authorization header of each HTTP request should be “Bearer” followed by a token. This token can be copied from the Business Manager, as shown below

token

Client-id -

The client id can be found in the View Credentials section. You can view the credentials on Conversation Studio as shown below

clientid

Content-Type - application/json

Request

{
    "team_name": "<Name of the team>",
    "user_name": "<haptik user name>",
    "business_id": "<business_id>",
    "countdown": "<time_in_seconds>"
}
  • user_name (string): Identifier for the User provided by Haptik when invoking the Integration API
  • business_id (number): This is a numeric identifier for the channel where the User is messaging
  • team_name (string): Name of the team to which the chat is to be assigned. Can be fetched from the Teams page of Agent Chat Tool.
  • countdown (number): If value is set to 5, then after 5 seconds chat will be moved to the queue. Otherwise, the chat will be moved to the queue after 10 seconds (default), value can be from range 5 to 10 seconds.

Response

A successful request to the API will return a 200 status code with a JSON response object.

{
    "success": true
}
  • success: Indicates if the API was a success or failure

Error Response

If there is any error in the Headers or the Request body, then the Error message will be returned in a JSON as shown below:

{
  "error_message": "user is not registered"
}

Here is a list of some possible error messages

Error MessageDetails
client_id missing in headersclient-id is not passed in the Headers of the request
invalid client_id in headersIncorrect client-id is passed in the headers
invalid authorization in headersThe Authorization header is not correct
token missing in headersThe Authorization token is not provided
invalid token providedThe Authorization token provided is incorrect
user_name missing in the requestThe user_name is not provided in the request body
business_id missing in the requestThe business_id is not provided in the request body
team_name missing in the requestThe team_name is not provided in the request body
invalid user_nameThe user_name provided is not valid for the Partner
invalid business_id providedThe business_id provided is not valid for the Partner
business "<business_id>" is inactiveThe business is inactive for the Partner
invalid team_name providedThe team_name is not valid for the Partner
team "<team_name>" is inactiveThe associated Team is inactive
user has not sent a messageThe user has not had any chat on that Business

Sample CURL command

curl -X POST \
    https://<base-url>/integration/external/v1.0/send_chat_to_agent/ \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'client-id: <CLIENT_ID>' \
  -H 'Content-Type: application/json' \
  -d '{
    "team_name": "<Name of the team>",
    "user_name": "<haptik user name>",
    "business_id": <business_id>
}

Get Chat Transcripts

v1.0

Note: This API will soon be deprecated. Consider using the v2.0 API instead!

This API allows you to get the chat history of the user for a conversation via a GET request to the Haptik Platform.

Example URL: https://<base-url>/integration/external/v1.0/get_chat_history/

Note: The base-url will be provided by Haptik at the time of integration.

Headers

Authorization: Bearer <TOKEN>
client-id: <CLIENT_ID>
Content-Type: application/json
Authorization -

The Authorization header of each HTTP request should be “Bearer” followed by a token. This token can be copied from the Business Manager, as shown below

token

Client-id -

The client id can be found in the View Credentials section. You can view the credentials on Conversation Studio as shown below

clientid

Content-Type - application/json

Request Params

{
    "conversation_no": "<Conversation no of the chat for the user>",
    "user_name": "<haptik user name>",
    "business_id": "<business_id>",
    "limit": "<number of messages (optional)>"
    "respose_type": "<response_type> (optional)"
}

Note: Supported response types are json and text. The default response type is json.

Response

A successful request to the API will return a 200 status code with a default JSON response object containing chat data.

{  
  "chat_json": [
        {
            "text": "Search places to visit{task}",
            "sender": "user",
            "message_id": 1742,
            "timestamp": "06/22/20 07:24:25 AM UTC"
        },
        {
            "text": "TEXT",
            "sender": "bot",
            "message_id": 1743,
            "timestamp": "06/22/20 07:24:26 AM UTC"
        }
    ]
}

Text type response

{  
  "chat_text": "user: Search places to visit{task}\nbot: TEXT\n"
}
  • success: Indicates if the API was a success or failure
  • sender values:
    • bot: message is sent by the bot
    • user: message is sent by the user
    • agent(<AGENT_NAME>): message is sent by the agent <AGENT_NAME>, i.e, name of the agent who sent the message

Error Response

If there is any error in the Headers or the Request body, then the Error message will be returned in a JSON as shown below:

{
  "error_message": "user has not sent a message"
}

Here is a list of some possible error messages

Error MessageDetails
invalid client_idIncorrect client-id is passed in the headers
invalid tokenThe Authorization token provided is incorrect
user_name missingThe user_name is not provided in the request params
business_id missingThe business_id is not provided in the request params
conversation_no missingThe conversation_no is not provided in the request params
invalid user_nameThe user_name provided is not valid for the Partner
user has not sent a messageThe user has not had any chat on that Business

Sample CURL command

curl -X GET \
  https://<base-url>/integration/external/v1.0/get_chat_history/?user_name=<user_name>
  &conversation_no=<conversation_no>&business_id=<business_id>&limit=<limit> \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'client-id: <CLIENT_ID>' \
  -H 'Content-Type: application/json' \
}

v2.0

This API allows you to get the chat history of the user for a conversation via a GET request to the Haptik Platform.

Example URL: https://<base-url>/integration/external/v2.0/get_chat_history/

Note: The base-url will be provided by Haptik at the time of integration.

Headers

Authorization: Bearer <TOKEN>
Client-ID: <CLIENT_ID>
Content-Type: application/json
Authorization -

The Authorization header of each HTTP request should be “Bearer” followed by a token. This token can be copied from the Business Manager, as shown below

token

Client-id -

The client id can be found in the View Credentials section. You can view the credentials on Conversation Studio as shown below

clientid

Content-Type - application/json

Request parameters

parametertyperequiredgroupdescription
business_idstr(int)grouped1Business ID for
user_namestrgrouped1Haptik user name.
conversation_nointtrue1/2Conversation number of user's chat.
pxutstrgrouped2TRACT Packed eXtensible User Token.
limitstr(int)optionaln/aLimit on number of messages that the API should return.
response_typestroptionaln/aEither json (default) or text.

This API allows for fetching the transcripts using either:

  • Group 1: for native Haptik consumers

    • business_id
    • user_name
    • conversation_no
    {
  "business_id": "1234",
  "user_name": "ab112468917fgghdebc",
  "conversation_no": 2
}

  • Group 2: for TRACT consumers

    • pxut
    • conversation_no
    {
  "pxut": "tw389ysgd._aksdjknsk-545641964-B",
  "conversation_no": 2
}

NOTE: All arguments within a group are required. If both groups' arguments are provided, first will be preferred.

Response

A successful request to the API will return a 200 status code with a default JSON response object containing chat data.

JSON response
{  
  "chat_json": [
        {
            "text": "Search places to visit{task}",
            "sender": "user",
            "message_id": 1742,
            "timestamp": "06/22/20 07:24:25 AM UTC"
        },
        {
            "text": "TEXT",
            "sender": "bot",
            "message_id": 1743,
            "timestamp": "06/22/20 07:24:26 AM UTC"
        }
    ]
}
Text response
{  
  "chat_text": "user: Search places to visit{task}\nbot: TEXT\n"
}
Sender values
valuedescription
botmessage was sent by the bot
usermessage was sent by the user
<agent_name>message is sent by an agent, <agent_name> is the name of the agent who sent the message

Error Response

If there is any error in the Headers or the Request body, then the Error message will be returned in a JSON as shown below:

{
  "error_message": "<error_message>"
}

Error messages

Error MessageDetails
Invalid business_idbusiness_id was not a valid string representation of an integer.
Invalid tokenThe Authorization token provided is incorrect
Either the user has not sent a message yet, or the provided user_name-business_id pair is invalid.Check that the user_name matches the business_id that you are requesting data for, or wait for the user to send a response before sending this request.
Unable to decode pxut-client_id pairThe TRACT PXUT is mismatched with the client_id provided in the request headers, or one of them is incorrect. Please recheck both.
Argument group validation: no valid group.Verify that parameters have been provided to fulfil at least one request group specified above. See response data for more details.
Argument group validation: invalid group found.Verify that parameters provided are of valid type. See response data for more details.
An unknown error occurredPlease contact Haptik team for support.

FAQ Node Creation APIs for KMS

We have many clients who need FAQ bots. Every time when we want to change the content of these FAQs (Q&As), a new CSV with Node name, Question and Answer in a defined format needs to be uploaded. (Format given below)

We have developed an API that can be integrated with the client KMS(Knowledge Management Systems) via any intermediate layer and every time when data gets changed in KMS, it should call this API to keep data in sync with the Haptik systems.

This API allows you to create/update/delete faq nodes via a POST request to Haptik Platform.

Note: The base-url will be provided by Haptik at the time of integration.

FAQ Node creation process API consists of two parts:

  1. Submit the CSV: To handle the large csv files, this API takes the request data and after validation submit it to celery worker and returns the task id, which executes the task asynchronously.

  2. Polling API to fetch the status of submitted task id

Example URL: https://<base-url>/mogambo_api/nodes/faq/create/

CSV Format

1. node_name: Name of the node, node name should be unique

2. Question(User Says): Independent Responses under User Says to detect this FAQ node. Multiple user says for single node can be passed as pipe(|) separated values(refer the sample row in image above)

3. answer(bot says): A node can have single or multiple bot says, to pass multiple bot says use `<m>` tag as delimiter

Headers

Authorization: Bearer <TOKEN>
client-id: <CLIENT_ID>
Content-Type: multipart/form-data
Authorization -

The Authorization header of each HTTP request should be “Bearer” followed by a token. This token can be copied from the Business Manager, as shown below

token

Client-id -

The client id can be found in the View Credentials section. You can view the credentials on Conversation Studio as shown below

clientid

Content-Type - multipart/form-data

Request Body

"domain_name": "<Name of the Domain/Bot>",
"csv_file": filename.csv,

Response

A successful request to the API will return a 200 status code with a JSON response object.

{
    "success": true,
    "body": {
        "task_id": "fe139ce5-f4c3-4383-bacb-64a546cb0b6c"
    },
    "error": "",
    "meta": {}
}
  • success flag Indicates if the API was a success or failure
  • task_id: Job id for the submitted task

Error Response

If there is any error in the Headers or the Request body, then the Error message will be returned in a JSON as shown below:

{
  "error_message": "invalid doman"
}
Error CodeError Message
401Unauthorized Access or invalid token
400Invalid or bad request body
403Access Forbidden

Sample Curl Command to submit csv file and get job id

curl -X POST \
  https://<base-url>/mogambo_api/nodes/faq/create/ \
  -H 'authorization: Bearer <token>' \
  -H 'client-id: <client-id>' \
  -H 'content-type: multipart/form-data; 
  -F 'domain_name=<domain_name>' \
  -F csv_file=@filename.csv

Note: This API follows the upsert [UPDATE and INSERT] behaviour i.e. every time when new CSV gets uploaded it makes the existing FAQ nodes for that domain inactive, creates new nodes for the rows mentioned in the CSV and updates Nodes with same names with the new User Says and Bot Says from the CSV.

Polling API to fetch submitted task Status

This API allows you to see the status of submitted task id via a GET request to Haptik Platform.

Example URL: https://<base-url>/mogambo_api/nodes/faq/create/status/<task_id>/

task_id: Id of task which gets created when we submit csv to node creation api

Headers

Authorization: Bearer <TOKEN>
client-id: <CLIENT_ID>
Authorization -

The Authorization header of each HTTP request should be “Bearer” followed by a token. This token can be copied from the Business Manager, as shown below

token

Client-id -

The client id can be found in the View Credentials section. You can view the credentials on Conversation Studio as shown below

clientid

Response

A successful request to the API will return a 200 status code with a JSON response object.

{
    "success": true,
    "body": {
        "status": "all nodes has been created successfully"
    },
    "error": "",
    "meta": {}
}
  • success flag Indicates if the API was a success or failure

Sample Curl Command to get the task status

curl -X GET \
  https://<base-url>/mogambo_api/nodes/faq/create/status/<task_id>/ \
  -H 'authorization: Bearer <TOKEN>' \
  -H 'client-id: <CLIENT ID>' \

Possible Statuses:

Error/Exception: shows the exception/error occured for the last node and stops the execution

In Progress: Node Creation is in progress

Success: Nodes has been created successfully

Best Practices

1. Assign Chat to Agent In some scenarios, where integration response fails or some unknown exception occurs then instead of sending bot break message we can also directly assign chat to an agent for better user experience.

2.Handle textual content - Everytime we want to change bot's response, a code change is required. To avoid that pain, we can use key value stores. Any person with zero to little tech knowledge can change bot response from key value store (with GUI) by updating the message copy corresponding to that unique message key or ID. This message key can be shared with the developer and fetch the response using that key.

3. HSLs - Haptik defines a superset of UI elements that are available across multiple platforms. These UI elements are then converted to their platform equivalent (js-sdk, android, ios, facebook-messenger, etc..) if they are not available on that specific platform. Eg. Forms are converted to quick replies on the Facebook platform and collected over free form. for more detail read here

Last updated on 4/16/2021
← Integrating with External BotMultilingual Virtual Assistants →