채널 활성화 API

봇에 대한 채널 활성화를 시작하는 데 사용됩니다.

이 API를 사용하려면 앱은 ChannelManagement 아래의 채널 관리의 관리자 API 범위가 필요합니다.

POST https://{{host}}/api/public/bot/channels

쿼리 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)

본문 매개 변수

매개 변수	필수/선택 사항	설명
BotId	필수	봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.
AppName	필수	이 봇과 연결된 앱은 봇의 앱 관리 페이지에서 확인할 수 있습니다
ClientId	필수	이 봇과 연결된 앱의 클라이언트 ID로, 봇의 앱 관리 페이지에서 확인할 수 있습니다
type	필수	이 봇에 대해 활성화할 채널입니다. 채널 유형 세부 정보는 다음과 같습니다. rtm – 웹/모바일용 SDK slack – Slack용 Webhook – Webhook용 Msteams – MS 팀용

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "botId":"{{bot Id}}",
    "channelDetails":{
        	"app": {
          	"appName": "App Name",
          	"clientId": "cs-fxxxfxd-bxee-xaxx-bxaf-dxxxxe2c26e3"
        	},
        	"createInstance": false,
        	"displayName": "Web / Mobile Client",
        	"enable": true,
        	"isAsync": false,
        	"type": "rtm"
    	},
	"type":"rtm"
}'

샘플 응답

플랫폼의 응답은 활성화 중인 채널에 따라 다릅니다. 웹/모바일 SDK에 대한 샘플 응답은 다음과 같습니다.

{
	"displayName": "Web / Mobile Client",
	"type": "rtm",
	"name": "Web / Mobile Client",
	"isAlertsEnabled": false,
	"enable": true,
	"sttEnabled": false,
	"sttEngine": "kore"
}

Webhook 채널에 대한 샘플 응답은 다음과 같습니다.

{
    "displayName": "webhook",
    "enable": true,
    "isAsync": false,
    "type": "ivr",
    "url": "<webhook-url>"
}

Slack 채널에 대한 샘플 응답은 다음과 같습니다.

{
    "streamUserAccountId": "su-bxxxxfax-exba-xxeb-xxxc-xxxacxxxxxx",
    "type": "slack",
    "enable": false,
    "verificationToken": "mxSxdWXcQxEFxrRPEdeoCC"
}

msteams 채널에 대한 샘플 응답은 다음과 같습니다.

{
    "type": "msteams",
    "enable": false,
    "accountId": "su-bcf9xxxfc-dxxx-xxxc-xexa-bxxexxxxxxx",
    "app_id": "xxebcfxf-xxxd-xxca-xxea-bxxxxxxaxxx"
}

On this Page