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

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

channelIdstring · uuidRequired

The channel ID

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

Responses

200

The channel's conversations configuration

application/json

statusstring · enumRequired

Conversation status. If enabled, creates conversations for incoming messages.

Possible values:

404

The requested resource was not found.

application/json

get/workspaces/{workspaceId}/channels/{channelId}/conversational

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "active"
}

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)