Get conversations configuration

Get channel's conversations configuration

get

This endpoint can be used to verify whether conversations are enabled for a channel, causing incoming messages to start new conversations. If it isn't, you'll need enable it in order to use conversations APIs. This can be done through the UI or by performing a PATCH request.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

channelIdstring · uuidrequired

The channel ID

Example: ab651378-579a-4491-abe6-eec97d4c0fa3

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "status": "active"
}

The channel's conversations configuration

Examples

Request

curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/channels/9673b291-2f71-43c1-a07c-6f2ff0926818/conversational" \
-H "Authorization: AccessKey abcd"

Response (200 - OK)

{
  "status": "active"
}