The properties of the Activities API is described below:
POST/forms
The body should be in JSON format and include the following properties:
Request
id REQUIRED
System generated form ID
-
header REQUIRED
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.
key:value
The body of Message Types can be viewed here in CIM Messages for inspiration.
Example:
"type": "FNB",
"markdownText": "hello", "custom1": "DummyValue1", "custom2": "DummayVlaue2"
200
Code 200 implies that the activity has been accepted.
{ "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
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.
