For the complete documentation index, see llms.txt. This page is also available as Markdown.

Profile API

Get List of Profiles By Channel, Account Id, Intent, Entity

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles?account=*&channel=*&intent=*&entity=*&start=0&count=1

Header

Authorization : Bearer [generatedToken]

Body

Status

200

Response

{ “status”: “success”, “data”: [ { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1598855852591, “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “modifiedDate”: 1598855852591, “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “accountId”: “[accountId]”, “accountName”: “[accountName]”, “channelName”: “[channelName]”, “channelType”: “[channelType]”, “status”: “PROMPT”, “entityName”: “[entity_name]”, “entityValue”: “[entity_value]”, “intent”: “[intent]”, “message”: “[message]”, “ticketNumber”: “[ticketNumber]”, “intentType”: “DOMAIN”, “answer”: true, “master”: false } ], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Profiles

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles/data?start=0&count=1

Header

Authorization : Bearer [generatedToken]

Body

Status

200

Response

{ “status”: “success”, “data”: [ { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1598856235880, “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “modifiedDate”: 1598856235880, “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “accountId”: “[accountId]”, “accountName”: “[accountName]”, “channelName”: “[channelName]”, “channelType”: “[channelType]”, “status”: “PROMPT”, “entityName”: “[entity_name]”, “entityValue”: “[entity_value]”, “intent”: “[intent]”, “message”: “[message]”, “ticketNumber”: “[ticketNumber]”, “intentType”: “DOMAIN”, “answer”: true, “master”: false } ], “hasMore”: true, “nextIndex”: 1, “prevIndex”: 0, “totalResults”: 83649 }

Get List of Profiles by Intent

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles/intent/[intent]?start=0&count=1

Header

Authorization : Bearer [generatedToken] Intent : [intent]

Body

Status

200

Response

{ “status”: “success”, “data”: [], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Profiles by Entity

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles/entity/[entity]?start=0&count=1

Header

Authorization : Bearer [generatedToken] Entity : [entity]

Body

Status

200

Response

{ “status”: “success”, “data”: [], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Profiles By Channel and Account Id

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles/channel/[channel]/account/[accountId]?start=0&count=1

Header

Authorization : Bearer [generateToken] Channel : [channelType] Account : [accountId]

Body

Status

200

Response

{ “status”: “success”, “data”: [ { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1551145833236, “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “modifiedDate”: 1551145833236, “modifiedBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “botId”: “[botId]”, “accountId”: “[accountId]”, “accountName”: “[accountName]”, “channelName”: “[channelName]”, “channelType”: “[channelType]”, “status”: “success”, “entityName”: “[entity_name]”, “entityValue”: “[entity_value]”, “intent”: “[intent]”, “message”: “[message]”, “ticketNumber”: “[ticketNumber]”, “intentType”: “DOMAIN”, “answer”: false, “master”: false } ], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Profiles by Engagement Id

Method

GET

Media Type

application/json

URL

http://[server]/dolphin/apiv1/graph/profiles/[engagementId]?start=0&count=1

Header

Authorization : Bearer [generatedToken] EngagementId : [engagementId]

Body

Status

200

Response

{ “status”: “success”, “data”: [ { “id”: “[id]”, “createdDate”: 1581576300573, “botId”: “[botId]”, “accountId”: “[accountId]”, “accountName”: “[accountName]”, “channelName”: “[channelName]”, “channelType”: “[channelType]”, “status”: “SUCCESS”, “intent”: “[intent]”, “message”: “[message]”, “ticketNumber”: “[ticketNumber]”, “intentType”: “DIALOG”, “answer”: true, “master”: false “master”: false “engagementId”: “[engagementId]” } ], “hasMore”: true, “nextIndex”: 1, “prevIndex”: 0, “totalResults”: 4 }

Last updated

Was this helpful?