Skip to main content

Settings API

Reads and updates a channel's consultation settings (consultation hours, chat feature, inbound domain).

  • Reads (GET) require BrandRead; updates (POST) require BrandWrite.
  • Base URL: https://api.talkbridge.io
  • Response envelope: { "ok": boolean, "code": string, "message": string, "data": object }

Consultation hours​

GET /api/agent/channel/schedule?brand=mybrand
POST /api/agent/channel/schedule

Update body:

FieldTypeRequiredDescription
brandKeystring✅Brand key
weekTimetablearray✅Consultation-hour slots per day of the week

weekTimetable[] items:

FieldTypeDescription
daystringDay of the week
startAtstringStart time
endAtstringEnd time
curl -X POST https://api.talkbridge.io/api/agent/channel/schedule \
-H "Authorization: Bearer blumnb-..." -H "Content-Type: application/json" \
-d '{
"brandKey": "mybrand",
"weekTimetable": [
{ "day": "MON", "startAt": "09:00", "endAt": "18:00" },
{ "day": "TUE", "startAt": "09:00", "endAt": "18:00" }
]
}'
note

If weekTimetable is empty, the request is rejected with 400 EMPTY.


Chat feature toggle​

Turns the consultation chat feature on or off.

POST /api/agent/channel/chat
FieldTypeRequiredDescription
brandKeystring✅Brand key
activeboolean✅Enabled / disabled

Inbound domain​

GET /api/agent/channel/domain?brand=mybrand
POST /api/agent/channel/domain
FieldTypeRequiredDescription
brandKeystring✅Brand key
domainstring✅Inbound domain
warning

Changing the inbound domain changes the channel's actual inbound path. In a setup that uses the bypass Gateway, do not change this value arbitrarily — inbound consultations may stop arriving.


Sender profile · System messages (read)​

GET /api/agent/profile?brand=mybrand
GET /api/agent/sysmsg?brand=mybrand

These return the sender profile and the registered system messages, respectively. The response data contains Kakao's original format.