Skip to main content
POST
/
conversations
/
{id}
/
parse-text
Parse a text with placeholders. Context from conversation and profile. Currently supported placeholders are: $name$ -> profile.name $geburtsdatum$ -> profile.date_of_birth $telefon$ -> profile.phone_number $email$ -> profile.email $adresse$ -> profile.address $datum$ -> current date (e.g. 15.01.2020) $zeit$ -> current time (e.g. 18:30) 
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/parse-text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Name of profile is $name$.",
  "nullable_fields": [
    "geburtsdatum",
    "adresse"
  ]
}
'
{
  "data": {
    "text": "Name of profile is John Doe."
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Body

application/json
​
text
string
Example:

"Name of profile is $name$."

​
nullable_fields
string[]

Optional list of fields which can be null. Otherwise a validation error will be thrown for fields which cannot be resolved. When a field is allowed to be null / empty, it will be replaced by an empty string. Field names may not contain the "$" delimiter.

Example:
["geburtsdatum", "adresse"]

Response

200 - application/json

Success

​
data
object