For AI agents: visit https://developers.karte.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
KARTE Developer Portal
HomeGuidesReference
KARTE Developer Portal
Reference
HomeGuidesReference

API v2

  • API v2 概要
    • Request
    • Response
    • API のリクエスト回数制限
    • 提供ステータス

Insight

  • Event
    • Send event to KARTEpost
    • Send event to KARTE and exec serverside-action.post
    • Get events by user_idpost
  • RefTable
    • Upsert refTable row.post
    • Delete refTable row.post
  • User
    • Get user statistics.post
  • Segment

Action

  • Action Table
    • Set recordpost
    • Delete recordspost
  • Campaign
    • Toggle campaign's enabled status.post
    • Fetch a campaign by idpost
    • Fetch settings and stats for all servicespost
    • Create campaignpost
    • Update campaignpost
  • Action
    • Create actionpost
    • Update actionpost
    • Find actionpost
  • アクションAPIにおける利用を推奨されない値

Datahub

  • Jobflow
    • Get jobflow.post
    • Execute a specific job.post

Talk

  • Message
    • Send message from an operator.post
    • Send message from a user.post
    • Get messages for a specific user.post
  • Assignee
    • assign operator.post
    • Unassign operator.post
    • Get assigneepost
  • Operator
    • Get operator info.post
    • Get a list of operator info.post
  • Status
    • Change status for talk userpost
  • Note
    • Send note messagepost
    • Get notes for a specific user.post

Account

  • Account
    • Get account listpost
    • Create account with invitationpost
    • Delete an account from a projectpost

Project

  • Role
    • Get a list of rolepost
    • Create a rolepost
    • Delete a rolepost
  • APIにおける権限グループの表示

Operation

  • Status

RightSupport

  • ContactData
    • Upsert contact datapost
    • Delete contact data by IDpost
  • CallContact
    • Get visitor id from call identity numberpost
    • Refresh connect board of operator by related information of call contact.post
  • SMS
    • Send SMSpost
  • ContactCase
    • Get contact case by IDpost
  • FAQ
    • create a job to import FAQ from CSVpost
    • create a job to import FAQ Category from CSVpost
  • JOBS
    • Get the status of the jobpost

RightVoicebot

  • CallInfo
    • Get call infopost

CMS Assets

  • Assets
    • Get an imageget
    • Get any assetget

CMS CDN

  • CDN
    • Get contentsget
    • Get a contentget

CMS Preview

  • Preview
    • Get preview contentsget
    • Get preview contentget

CMS Management

  • Assets
    • Upload Cross CMS assets filepost
    • List assetspost
    • Get an assetpost
    • Update an assetpost
    • Delete an assetpost
    • Publish an assetpost
    • Unpublish an assetpost
  • Contents
    • Get contents listpost
    • Get a contentpost
    • Create a contentpost
    • Update a contentpost
    • Delete a contentpost
    • Publish a contentpost
    • Unpublish a contentpost
    • Patch a content with JSON Patchpost
  • Collections
    • Get a collectionpost
    • List collectionspost
    • Create collectionpost
    • Update collectionpost
    • Delete collectionpost
  • Models
    • Get a modelpost
    • List modelspost
    • Create a modelpost
    • Update a modelpost
    • Delete a modelpost
  • CustomFieldTypes
    • Get custom field typepost
    • List custom field typespost
    • Create custom field typepost
    • Update custom field typepost
    • Delete custom field typepost

Craft

  • Sites
    • Get Craft Sites contentpost
    • Remove Craft Sites filepost
    • Remove Craft Sites directorypost
    • (Deprecated) Remove Craft Sites contentpost
    • Upload Craft Sites contentpost
    • Invalidate Craft Sites contentpost
    • Update Craft Sites content's visibilitypost
    • Update Craft Sites content's visibility by directorypost
    • Upload Craft Sites filepost
    • Set Craft Sites content metadatapost
    • List Craft sitespost
  • Craft Function
    • Find Craft function's metadata by namepost
    • Find Craft function's metadata by idpost
    • Create Craft Functionpost
    • Update Craft Functionpost
    • Delete Craft Functionpost
    • Find Craft function's code by versionpost
    • List Craft Functionspost
  • RAG
    • Craft RAG Import By Filepost
    • Craft RAG Import By Directorypost
    • Craft RAG Delete Filespost
    • Craft RAG Get Operationpost
    • Craft RAG List Operationspost
    • List RAG Filespost
    • Get RAG File By Pathpost

Hook v2

  • Hook v2 概要
  • Webhook 概要
    • Request
    • Response
    • HMAC認証
  • Amazon EventBridge 連携
    • Request
  • KARTE Craft関連Hook
  • KARTE Talk関連Hook
    • Message Hook
    • Message Operator Hook
    • Assign Hook
  • KARTE Datahub関連Hook
    • Jobflow Hook
  • Action関連Hook
    • Campaign Enable Hook

JS SDK

  • JS SDK(計測タグ)について
  • krt
    • krt('send')
    • krt('set')
    • krt('renew_visitor_id')
    • krt('talk')

Native SDK (iOS)

  • Reference
  • v1 Reference (Legacy)

Native SDK (Android)

  • Reference
  • v1 Reference (Legacy)

Widget API

  • Widget API とは
  • HTML ディレクティブ
    • krt-text
    • krt-html
    • krt-if / krt-else
    • krt-show
    • krt-for
    • krt-on
    • krt-bind
    • krt-model
  • HTML クラス
    • karte-close
  • widget
    • widget.show
    • widget.hide
    • widget.setVal
    • widget.getVal
    • widget.onChangeVal
    • widget.method
    • widget.on
    • widget.setState
    • widget.getState
    • widget.collection
    • widget.addChoiceAnswer
    • widget.addFreeAnswer
    • widget.removeAnswer
    • widget.getAnsweredQuestion
    • widget.getAnsweredQuestionIds
    • widget.sendAnswer
    • widget.sendAnswers
    • widget.storage.memory.store
    • widget.storage.memory.restore
    • widget.storage.local.store
    • widget.storage.local.restore
  • chat
    • chat.option
    • chat.open
    • chat.close
    • chat.activate
    • chat.deactivate
    • chat.send
    • chat.sendTagMessageFromUser
    • chat.fetchProjectStatus
    • chat.getUnreadMessageCount
    • chat.setMetadata
    • chat.emitter.on
  • chat message
    • Buttons UI
    • Links UI
    • Confirm Card UI
    • Button Object
    • Link Object
    • Action Object
  • collection
    • table.get(key)
    • table.get(keys)
    • table.getByQuery()
    • table.query()
    • record.field()
    • [deprecated] table.set()
    • [deprecated] record.set()
    • [deprecated] field.set()

Action API

  • Action APIとは
  • テンプレート変数
    • 静的変数
    • プリセット変数
    • ユーザー情報変数
  • テンプレート構文(Nunjucks)
    • 変数
    • if
    • for
    • set
    • Filters
    • 算術演算子
    • 比較演算子
    • 論理演算子
  • Pluginの静的変数
    • Line

Blocks

  • builder.js概要
    • Block API

API v1

  • Campaign
  • User

VOC

  • VOC
    • Import sources from CSVpost

Message

  • Message

Message

Updated about 9 hours ago


Import sources from CSV

Updated about 9 hours ago


Import sources from CSV
KARTE © 2015 PLAID, Inc.
  • Guides
  • Reference