# Table of Contents - [API Access | Bird API Docs](#api-access-bird-api-docs) - [API Authorization | Bird API Docs](#api-authorization-bird-api-docs) - [Access Policies | Bird API Docs](#access-policies-bird-api-docs) - [Access Roles | Bird API Docs](#access-roles-bird-api-docs) - [Conversations API | Bird API Docs](#conversations-api-bird-api-docs) - [Common API usage | Bird API Docs](#common-api-usage-bird-api-docs) - [Update conversations configuration | Bird API Docs](#update-conversations-configuration-bird-api-docs) - [API reference | Bird API Docs](#api-reference-bird-api-docs) - [Channel configuration | Bird API Docs](#channel-configuration-bird-api-docs) - [Conversations messaging | Bird API Docs](#conversations-messaging-bird-api-docs) - [Delete conversation message | Bird API Docs](#delete-conversation-message-bird-api-docs) - [Get conversations configuration | Bird API Docs](#get-conversations-configuration-bird-api-docs) - [Conversations management | Bird API Docs](#conversations-management-bird-api-docs) --- # API Access | Bird API Docs In order to use any of our APIs, you must authenticate your HTTP requests using an access key. HTTP requests using no authentication or invalid access keys will result in 401 Unauthorized. To access our APIs using an access key you will need to: 1. Create or use an existing access policy 2. Attach a new or existing access policy to a role 3. Create or use an existing access key that is attached to a role Last updated 1 year ago Was this helpful? Was this helpful? --- # API Authorization | Bird API Docs HTTP requests can be authorized using access keys. Access keys are attached to roles to limit the scope of what they provide access to. Access keys can be managed via [https://app.bird.com/settings/security/access-keys](https://app.bird.com/settings/security/access-keys) Keep in mind to always limit the access keys permissions by assigning the minimum required access roles to it [](https://docs.bird.com/api/api-access/api-authorization#creating-an-access-key) Creating an access key ------------------------------------------------------------------------------------------------------------- In this example we will create an access key that will attach the access role that was created in the [access roles](https://docs.bird.com/api/api-access/access-roles#creating-an-access-role) example ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252FGF69pVuGzNXl0LnZdhzL%252FWork%2520Here%2520-%2520Horizontal%2520Frame%2520%288%29.png%3Falt%3Dmedia%26token%3De6210d28-75c0-463e-8080-3c71a892b994&width=768&dpr=4&quality=100&sign=dce9c961&sv=2) Generate a new access key 1. The first step is to give the access key a meaningful **name** and **description.** 2. Next attach one or more roles to the access key 3. Finally create the access key ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252Ffz3YdgztdlwLrJZuqyKC%252FWork%2520Here%2520-%2520Squared%2520Frame%2520%286%29.png%3Falt%3Dmedia%26token%3Dbf733957-0526-4211-b1a0-bc08a08688cf&width=768&dpr=4&quality=100&sign=2434069e&sv=2) Create an access key [](https://docs.bird.com/api/api-access/api-authorization#authorize-http-requests-with-access-keys) Authorize HTTP requests with access keys ------------------------------------------------------------------------------------------------------------------------------------------------- In order to authenticate HTTP requests with an access key, you must provide it in the [Authorization HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) with the following format. Replace with your valid access key. Last updated 1 year ago Was this helpful? * [Creating an access key](https://docs.bird.com/api/api-access/api-authorization#creating-an-access-key) * [Authorize HTTP requests with access keys](https://docs.bird.com/api/api-access/api-authorization#authorize-http-requests-with-access-keys) Was this helpful? Copy Authorization: AccessKey --- # Access Policies | Bird API Docs [](https://docs.bird.com/api/api-access/access-policies#access-policies) Access policies --------------------------------------------------------------------------------------------- An access policy is a set of rules and each one determines the access to one or multiple resources. Access policies can be managed via [https://app.bird.com/settings/security/access-policies](https://app.bird.com/settings/security/access-policies) . When creating access policies you should give access only to the resources you need to access via the API. ### [](https://docs.bird.com/api/api-access/access-policies#creating-an-access-policy) Creating an access policy In this example we will create an access policy that will allow you to send and retrieve messages sent to any channels in your workspace ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252F61yv5J6wA3ZI7EMrmeIq%252FWork%2520Here%2520-%2520Horizontal%2520Frame%2520%286%29.png%3Falt%3Dmedia%26token%3D299f5dd8-d427-4006-b23c-9d653be0dc58&width=768&dpr=4&quality=100&sign=b6354498&sv=2) Create a custom policy 1. The first step is to give your access policy a meaningful **name** and **description.** ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252F3w2cwo3BeVMxWOGpEtVm%252FWork%2520Here%2520-%2520Squared%2520Frame%2520%281%29.png%3Falt%3Dmedia%26token%3D4c335af0-77c9-46d7-b954-41972453a6d4&width=768&dpr=4&quality=100&sign=c05ea35b&sv=2) Access Policy Name and Description 2. Next define a policy definition. The one shown will **Allow** you to **Create** (POST/Send) messages to the /channels endpoint and also create media for sending image messages ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252Fwgq24zhQ6Tt3EKEGcHae%252FWork%2520Here%2520-%2520Squared%2520Frame%2520%282%29.png%3Falt%3Dmedia%26token%3D3f14825a-ba87-48eb-87ef-12e75f67ffaf&width=768&dpr=4&quality=100&sign=c85b0b20&sv=2) Access Policy Create Definition 3. The second policy definition will **Allow** you to **View** (GET) all messages and specific messages on channels 4. Finally Create Policy ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252FNnPWVgJaMGQtZrsZGvk9%252FWork%2520Here%2520-%2520Squared%2520Frame%2520%283%29.png%3Falt%3Dmedia%26token%3D18de8353-fdad-413f-bef6-dd813f3f559c&width=768&dpr=4&quality=100&sign=ae187214&sv=2) Access Policy Get Definition ### [](https://docs.bird.com/api/api-access/access-policies#understanding-policy-definitions) Understanding policy definitions Policy definitions provide extremely fine grained control over the endpoints in your workspace. Each of your access policies can have one or more definitions. By default any endpoints that do not have explicit allow access (will result in access denied when trying to access them). Examining a definition in detail: Field Name Description Values Effect Allow or deny permission to a list of resources Allow Deny Action Allow any or specific actions on the attached resource(s) Any Create (POST) View (GET|HEAD|OPTIONS) Delete (DELETE) Update (PUT|PATCH) Resource(s) Path of the resource. Policy definitions can contain one or more resources Path of the resource. Example: /workspaces/{workspaceID}/channels **Valid wildcards:** \* - Any value for a specific part of the path e.g. /workspaces/\*/channels (applies to all workspaces in an organisation) \*\* - Any value for all child paths e.g. /workspaces/\*/channels/\*\* (access to all paths below /channels) Last updated 1 year ago Was this helpful? * [Access policies](https://docs.bird.com/api/api-access/access-policies#access-policies) * [Creating an access policy](https://docs.bird.com/api/api-access/access-policies#creating-an-access-policy) * [Understanding policy definitions](https://docs.bird.com/api/api-access/access-policies#understanding-policy-definitions) Was this helpful? --- # Access Roles | Bird API Docs An access role is a set of one or more access policies that can be assigned to one or more users, or one or more access keys. Access roles can be managed via [https://app.bird.com/settings/security/access-roles](https://app.bird.com/settings/security/access-roles) When creating access policies you should give access only to the resources you need to access via the API. [](https://docs.bird.com/api/api-access/access-roles#creating-an-access-role) Creating an access role ---------------------------------------------------------------------------------------------------------- In this example we will create an access role that will attach the access policy that was created in the [access policies](https://docs.bird.com/api/api-access/access-policies#creating-an-access-policy) example ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252F7VdjeAKLFpNfdvnqkWax%252FWork%2520Here%2520-%2520Horizontal%2520Frame%2520%287%29.png%3Falt%3Dmedia%26token%3Dcc05f838-1744-408d-84a1-af9c4ad05e45&width=768&dpr=4&quality=100&sign=6218f4d2&sv=2) Create a new role 1. The first step is to give the role a meaningful **name** and **description**. 2. Next attach one or more policy definitions. To select a custom policy make sure type is set to **organization.** 3. Finally Create Role ![](https://docs.bird.com/api/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Fuploads%252FWauoKHXaPWKvi6tOBMiH%252FWork%2520Here%2520-%2520Squared%2520Frame%2520%285%29.png%3Falt%3Dmedia%26token%3Dd40f4e71-3803-4267-b88e-01931fdca055&width=768&dpr=4&quality=100&sign=caab6961&sv=2) Create an access role [](https://docs.bird.com/api/api-access/access-roles#understanding-role-policies) Understanding role policies ------------------------------------------------------------------------------------------------------------------ When creating a role you can add one or more access policies to provide (or deny) access a role access to certain API endpoints. As well as attaching custom policies that you have created, MessageBird has provided a number of managed policies to carry out common actions. Field Name Description Values Type Select from either custom or managed policies Organization Managed Policy Select the policy Any Organization or Managed policy that has been created Last updated 1 year ago Was this helpful? * [Creating an access role](https://docs.bird.com/api/api-access/access-roles#creating-an-access-role) * [Understanding role policies](https://docs.bird.com/api/api-access/access-roles#understanding-role-policies) Was this helpful? --- # Conversations API | Bird API Docs Bird's Conversations API allows you to manage messages exchanged between two or more participants in a centralized manner. Imagine one of your contacts starts a customer service chat by interacting with a flow and eventually gets transferred to a human agent, the concept of a conversation helps keep track of the history of messages so you have a full context of the contact's interactions throughout their journey. Keep in mind using the Conversations API is not strictly necessary to send and receive messages. If you'd like to send and receive messages in a simplified manner, please refer to the [Channels messaging API](https://docs.bird.com/api/channels-api/api-reference/messaging) . ### [](https://docs.bird.com/api/conversations-api#api-access-authorizations-and-usage) API Access, Authorizations and Usage For detailed instructions on obtaining access, please refer to the [API Access section](https://docs.bird.com/api/api-access) . There, you'll find guidance on acquiring access tokens and the base URL required for subsequent requests. If you already finished setting your access, please refer to subsection [Common API usage](https://docs.bird.com/api/api-access/common-api-usage) to understand how to send requests to Bird and how to work with our responses. [API reference](https://docs.bird.com/api/conversations-api/api-reference) Last updated 1 year ago Was this helpful? Was this helpful? --- # Common API usage | Bird API Docs [](https://docs.bird.com/api/api-access/common-api-usage#base-url) Base URL -------------------------------------------------------------------------------- All paths referenced for MessageBird services in the API references uses the following base URL: Copy https://api.bird.com/ [](https://docs.bird.com/api/api-access/common-api-usage#base-media-url) Base media URL -------------------------------------------------------------------------------------------- All paths referenced for retrieving media uses the following base URL: Copy https://media.api.bird.com [](https://docs.bird.com/api/api-access/common-api-usage#authentication) Authentication -------------------------------------------------------------------------------------------- In order to authenticate HTTP requests with an access key, you must provide it in the [Authorization HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) with the following format. Replace with your valid access key. Copy Authorization: AccessKey [](https://docs.bird.com/api/api-access/common-api-usage#authorization) Authorization ------------------------------------------------------------------------------------------ Access key Authorization is determined by the [access roles](https://docs.bird.com/api/api-access/access-roles) attached to your access key [](https://docs.bird.com/api/api-access/common-api-usage#formats-and-headers) Formats and Headers ------------------------------------------------------------------------------------------------------ All HTTP responses are in JSON. It's advised to send the Accept HTTP header with the value application/json with each request. Both POST and PUT requests to the API must contain a JSON-formatted payload in the request body. [](https://docs.bird.com/api/api-access/common-api-usage#errors) Errors ---------------------------------------------------------------------------- MessageBird uses standard HTTP status codes to indicate success or failure of API requests. * HTTP response codes in the 2xx range indicate the request was successfully processed * HTTP response codes in the 4xx range indicate that there was a client error - for example: authentication error, not enough balance or wrong/missing parameters. Don't worry, the HTTP response body includes a JSON-formatted response that tells you exactly what went wrong. If you're stuck, feel free to [contact support](https://messagebird.com/en/help) , we're happy to help you out * HTTP response codes in the 5xx range indicate a server error. It's considered safe to retry the same request, preferably with a delay [](https://docs.bird.com/api/api-access/common-api-usage#pagination) Pagination ------------------------------------------------------------------------------------ When retrieving data via a request, the default page size is 10. This means the response will include a maximum of 10 items per page. If you need more items, you can set a custom value for the limit parameter, up to a maximum of 100. Name Description Example limit Limits the number of results to return. 10 pageToken Tracks the current position in the list. Use it as the `pageToken` in the next request to continue fetching data. WzE3MzIyMTIxNTU1NTAsIjY3MzEyNjAxLWQ4NjUtNGI1YS1hMmRmLTQ2ZGRiOWQ2NmUwOCJd If a response includes a `nextPageToken`, it indicates there are additional items available to fetch from the API. To retrieve the next set of items, provide the `nextPageToken` value as the `pageToken` parameter in the subsequent request. > **Important:** Pages can occasionally be empty or contain fewer items than expected, even when more items are available. To reliably determine the end of the list, always check for the presence of the `nextPageToken` field in the response. If `nextPageToken` is present, you should perform another request using the provided token, regardless of the current page's content. A follow-up request would look like this: In this example, the value of `abc123` from the `nextPageToken` in the previous response is passed as the `pageToken` parameter to fetch the next set of items. [](https://docs.bird.com/api/api-access/common-api-usage#rate-limits) Rate Limits -------------------------------------------------------------------------------------- 50 retrieval calls per second burst or 2,000 retrieval calls per minute steady. Last updated 1 month ago Was this helpful? * [Base URL](https://docs.bird.com/api/api-access/common-api-usage#base-url) * [Base media URL](https://docs.bird.com/api/api-access/common-api-usage#base-media-url) * [Authentication](https://docs.bird.com/api/api-access/common-api-usage#authentication) * [Authorization](https://docs.bird.com/api/api-access/common-api-usage#authorization) * [Formats and Headers](https://docs.bird.com/api/api-access/common-api-usage#formats-and-headers) * [Errors](https://docs.bird.com/api/api-access/common-api-usage#errors) * [Pagination](https://docs.bird.com/api/api-access/common-api-usage#pagination) * [Rate Limits](https://docs.bird.com/api/api-access/common-api-usage#rate-limits) Was this helpful? Copy { "results": [], "nextPageToken": "WzE3MzIyMTIxNTU1NTAsIjY3MzEyNjAxLWQ4NjUtNGI1YS1hMmRmLTQ2ZGRiOWQ2NmUwOCJd" } Copy GET /endpoint?limit=10&pageToken=abc123 --- # Update conversations configuration | Bird API Docs ### [](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration#patch-workspaces-workspaceid-channels-channelid-conversational) Set channel's conversations configuration patch https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational This endpoint can be used to enable conversations for a channel. You should enable this option if you'd like incoming messages on this channel to start conversations. Authorizations accessKey accessKey HTTPRequired Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj') Path parameters workspaceIdstring · uuidRequired The workspace ID Example: `b4e02c85-c6d2-4b15-8885-e09671799c61` channelIdstring · uuidRequired The channel ID Example: `ab651378-579a-4491-abe6-eec97d4c0fa3` Body application/json application/json statusstring · enumRequired Conversation status. If enabled, creates conversations for incoming messages. Possible values: `active``inactive` Responses 200 The channel's conversations configuration application/json Responseobject Show properties 404 The resource specified in the URL was not found application/json 422 The request body did not pass validation application/json patch /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP HTTPcURLJavaScriptPython Test it 200 The channel's conversations configuration [](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration#examples) Examples --------------------------------------------------------------------------------------------------------------------------------------------- Request Response (200 - OK) Copy curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/channels/9673b291-2f71-43c1-a07c-6f2ff0926818/conversational" \ -H "Content-Type: application/json" \ -H "Authorization: AccessKey abcd" \ -d '{ "status": "active" }' Copy { "status": "active" } Last updated 4 months ago Was this helpful? * [PATCHSet channel's conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration#patch-workspaces-workspaceid-channels-channelid-conversational) * [Examples](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration#examples) Was this helpful? Copy PATCH /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP/1.1 Host: api.bird.com Authorization: AccessKey YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 19 { "status": "active" } Copy { "status": "active" } --- # API reference | Bird API Docs [Channel configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration) [Conversations messaging](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging) [Conversations management](https://docs.bird.com/api/conversations-api/api-reference/conversations-management) [Conversation Participants](https://docs.bird.com/api/conversations-api/api-reference/conversation-participants) [Workspace settings](https://docs.bird.com/api/conversations-api/api-reference/workspace-settings) Last updated 1 year ago Was this helpful? Was this helpful? --- # Channel configuration | Bird API Docs In order to use the Conversations API, you need to ensure conversations are enabled for your channel. This can be done in the channel settings through the UI or programatically by referring to [Update conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration) . [](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration#api-reference-guide) API Reference Guide -------------------------------------------------------------------------------------------------------------------------------- 1. [Get conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration) 2. [Update conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/update-conversations-configuration) Last updated 1 year ago Was this helpful? Was this helpful? --- # Conversations messaging | Bird API Docs Conversations represent a sequence of messages with a set of participants. In the following APIs, you can manage messages belonging to a conversation. Handling messages from the perspective of a conversation can be more convenient because it gives you the full context of a contact's interactions, they might have started off interacting with a flow and then gotten transferred to a customer service agent, so a conversation paints the full picture of their journey by aggregating all messages sent to and from the contact. [](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging#api-reference-guide) API Reference Guide ---------------------------------------------------------------------------------------------------------------------------------- 1. [Create conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/create-conversation-message) 2. [List conversation messages](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/list-conversation-messages) 3. [Get conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/get-conversation-message) 4. [Update conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/update-conversation-message) 5. [Delete conversation message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message) 6. [Create pre-signed upload](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/create-pre-signed-upload) Last updated 1 year ago Was this helpful? Was this helpful? --- # Delete conversation message | Bird API Docs ### [](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message#delete-workspaces-workspaceid-conversations-conversationid-messages-messageid) Delete a message delete https://api.bird.com/workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId} Delete a conversation message Authorizations accessKey accessKey HTTPRequired Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj') Path parameters workspaceIdstring · uuidRequired The workspace ID Example: `b4e02c85-c6d2-4b15-8885-e09671799c61` conversationIdstring · uuidRequired The conversation ID Example: `67e4d358-ca94-421e-98b7-448860df9d33` messageIdstring · uuidRequired The message ID Example: `f303d128-0619-49ce-9e2a-669098d7d78b` Responses 204 Deleted 404 The resource specified in the URL was not found application/json delete /workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId} HTTP HTTPcURLJavaScriptPython Test it 204 Deleted No content [](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message#examples) Examples ---------------------------------------------------------------------------------------------------------------------------------------- Request Copy curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/02ec2ac2-ebec-42d3-a5f4-e6f3a9edf418/messages/29d3a7f4-841d-4702-a495-20cab72f2865" \ -H "Authorization: AccessKey abcd" Last updated 4 months ago Was this helpful? * [DELETEDelete a message](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message#delete-workspaces-workspaceid-conversations-conversationid-messages-messageid) * [Examples](https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/delete-conversation-message#examples) Was this helpful? Copy DELETE /workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId} HTTP/1.1 Host: api.bird.com Authorization: AccessKey YOUR_SECRET_TOKEN Accept: */* --- # Get conversations configuration | Bird API Docs ### [](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration#get-workspaces-workspaceid-channels-channelid-conversational) Get channel's conversations configuration get https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/conversational 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 accessKey HTTPRequired Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj') 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 200 The channel's conversations configuration application/json Responseobject Show properties 404 The resource specified in the URL was not found application/json get /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP HTTPcURLJavaScriptPython Test it 200 The channel's conversations configuration [](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration#examples) Examples ------------------------------------------------------------------------------------------------------------------------------------------ Request Response (200 - OK) Copy curl "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/channels/9673b291-2f71-43c1-a07c-6f2ff0926818/conversational" \ -H "Authorization: AccessKey abcd" Copy { "status": "active" } Last updated 4 months ago Was this helpful? * [GETGet channel's conversations configuration](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration#get-workspaces-workspaceid-channels-channelid-conversational) * [Examples](https://docs.bird.com/api/conversations-api/api-reference/channel-configuration/get-conversations-configuration#examples) Was this helpful? Copy GET /workspaces/{workspaceId}/channels/{channelId}/conversational HTTP/1.1 Host: api.bird.com Authorization: AccessKey YOUR_SECRET_TOKEN Accept: */* Copy { "status": "active" } --- # Conversations management | Bird API Docs The following APIs can be used to perform operations over conversations. [](https://docs.bird.com/api/conversations-api/api-reference/conversations-management#api-reference-guide) API Reference Guide ----------------------------------------------------------------------------------------------------------------------------------- 1. [Create conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/create-conversation) 2. [List conversations](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/list-conversations) 3. [Get conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/get-conversation) 4. [Update conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/update-conversation) 5. [Delete conversation](https://docs.bird.com/api/conversations-api/api-reference/conversations-management/delete-conversation) Last updated 1 year ago Was this helpful? Was this helpful? ---