API Explorer 1 endpoints

Get Chat Config

GET /obp/v7.0.0/public/chat-config

OBPv7.0.0-getChatConfig No role required API

Returns the chat configuration this instance enforces.

  • allowed_link_hosts — chat message content is rejected with OBP-39015 when it contains an http(s) link to a host not in this list (exact match or subdomain). The list is derived from this instance's own host, the hosts of the apps in its App Directory (public_*_url props), and the chat.allowed_link_hosts prop (defaulting to tesobe.com and openbankproject.com when that prop is not defined).
  • max_message_length — content longer than this is rejected with OBP-39016 (prop chat.max_message_length, default 10000 characters).

Chat clients should apply the same policy at render time and in composers: show links to hosts outside the list as plain text rather than making them clickable, and cap input at the maximum length.

No Authentication is Required.

User Authentication is Optional. The User need not be logged in.

JSON response body fields (2)
allowed_link_hosts
allowed_link_hosts
max_message_length
max_message_length
Example success response
{
  "allowed_link_hosts": [
    "apisandbox.openbankproject.com",
    "openbankproject.com",
    "tesobe.com"
  ],
  "max_message_length": 10000
}
Possible errors (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getChatConfig