Skip to main content
Skip table of contents

Conversations API (3rd-party apps)

The properties of the Activities API is described below:

POST/forms

The body should be in JSON format and include the following properties:

Request

ParameterDescriptionTypeProperties

id REQUIRED 

System generated form ID

String

-

header REQUIRED

Details of the header are explained in CIM Messages.Object-

body REQUIRED

The message body can change with respect to the type of activity being defined by 3rd-party. Any attribute can be added in the form of key:value pair.

The body of Message Types can be viewed here in CIM Messages for inspiration.

String

Example: 

"type""FNB",

"markdownText""hello",
 "custom1""DummyValue1",
 "custom2""DummayVlaue2"

CodeDescription

200

Code 200 implies that the activity has been accepted.

CODE
{
    "id": "{{$guid}}",
    "header": {
    "sender": {
      "id": "460df46c-adf9-11ed-afa1-0242ac120002",
      "type": "APP",
      "senderName": "APPName",
      "additionalDetail": null
    },
    "channelData": {
      "channelCustomerIdentifier": "",
      "serviceIdentifier": "",
      "requestPriority": 0,
      "additionalAttributes": []
    },
    "language": {},
    "timestamp": 1677151053951,
    "securityInfo": {},
    "stamps": [],
    "intent": null,
    "entities": {},
    "channelSessionId": null,
    "conversationId": "642b51a7d9ba694f5ba0ba7f",
    "customer": {"_id": "642b51a661e49d5776378711"},
    "replyToMessageId": null,
    "providerMessageId": null
  },
    "body": {
        "type": "FNB",
        "markdownText": "hello",
        "custom1": "DummyValue1",
        "custom2": "DummayVlaue2"
    }
}

Quick Links

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.