### HTTP GET Request Example Source: https://docs.bird.com/applications/automation/flows/concepts/actions/core-actions/how-to-use-the-filter-array-step This example demonstrates how to query documentation dynamically by performing an HTTP GET request with an 'ask' query parameter. Use this to get specific answers or clarifications not explicitly present on the page. ```http GET https://docs.bird.com/applications/automation/flows/concepts/actions/core-actions/how-to-use-the-filter-array-step.md?ask= ``` -------------------------------- ### Query Documentation Dynamically - GET Request Example Source: https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/create-attribute-definition This example shows how to dynamically query the documentation using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly stated on the page. ```http GET https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/create-attribute-definition.md?ask= ``` -------------------------------- ### HTTP GET Request Example Source: https://docs.bird.com/api/channels-api/api-reference/channel-groups To query documentation dynamically, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://docs.bird.com/api/channels-api/api-reference/channel-groups.md?ask= ``` -------------------------------- ### Query Documentation Example Source: https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/list-allow-block-rules To get more information not present on the page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://docs.bird.com/api/conversations-api/api-reference/workspace-settings/list-allow-block-rules.md?ask= ``` -------------------------------- ### Query Documentation Example Source: https://docs.bird.com/api/accounts-api/api-reference/region-groups Demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page. ```http GET https://docs.bird.com/api/accounts-api/api-reference/region-groups.md?ask= ``` -------------------------------- ### Query Documentation API Example Source: https://docs.bird.com/connectivity-platform/messaging/add-an-embeddable-whatsapp-button-to-your-website Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to dynamically query documentation. The question should be specific and self-contained. ```http GET https://docs.bird.com/connectivity-platform/messaging/add-an-embeddable-whatsapp-button-to-your-website.md?ask= ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://docs.bird.com/api/api-access/common-api-usage Perform an HTTP GET request with the 'ask' query parameter to dynamically query the documentation for information not explicitly present on the page. The question should be specific and self-contained. ```http GET https://docs.bird.com/api/api-access/common-api-usage.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/sending-sms-messages This example shows how to perform an HTTP GET request to query documentation dynamically using the 'ask' query parameter. This is useful for retrieving specific information or clarifications not explicitly present on the page. ```http GET https://docs.bird.com/api/channels-api/supported-channels/programmable-sms/sending-sms-messages.md?ask= ``` -------------------------------- ### Example GET Request for Destination Management Source: https://docs.bird.com/api/numbers-api/api-reference/destination-management-api This is an example of a GET request to retrieve the destination management configuration for the 'sms' capability within a workspace. ```http GET /workspaces/{workspaceId}/destination-management/capability/sms ``` -------------------------------- ### Example Delivery Status Report GET Request Source: https://docs.bird.com/connectivity-platform/troubleshooting/i-am-missing-my-delivery-reports This is an example of a GET request that your platform will receive for a delivery status report. Ensure your server is set up to handle these requests. ```http GET http://your-own.url/script?id=e8077d803532c0b5937c639b60216938&reference=YouReference123&recipient=31612345678&status=delivered&statusDatetime=2016-05-03T08%3A58%3A10%2B00%3A00 ``` -------------------------------- ### Example GET Request with Pagination Parameters Source: https://docs.bird.com/api/api-access/common-api-usage This example demonstrates how to construct a GET request to fetch the next set of items using the pageToken obtained from a previous response. ```http GET /endpoint?limit=10&pageToken=abc123 ``` -------------------------------- ### Example GET Request with 'ask' Parameter Source: https://docs.bird.com/connectivity-platform/customizing-the-omnichannel-widget/can-i-upload-a-custom-logo-as-my-omnichannel-widget-icon Perform an HTTP GET request to the current page URL with the 'ask' query parameter to get a specific answer. The question should be clear and self-contained. ```http GET https://docs.bird.com/connectivity-platform/customizing-the-omnichannel-widget/can-i-upload-a-custom-logo-as-my-omnichannel-widget-icon.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.bird.com/api/voice-api/voice-webhooks Demonstrates how to query documentation dynamically by appending an 'ask' query parameter to a GET request. This is useful for retrieving specific information or clarifications not explicitly stated on the page. ```http GET https://docs.bird.com/api/voice-api/voice-webhooks.md?ask= ``` -------------------------------- ### Query Documentation API Example Source: https://docs.bird.com/connectivity-platform/troubleshooting/my-template-application-has-been-rejected To get additional information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language. ```http GET https://docs.bird.com/connectivity-platform/troubleshooting/my-template-application-has-been-rejected.md?ask= ``` -------------------------------- ### Voice Inbound Event Example Source: https://docs.bird.com/api/voice-api/voice-webhooks Example JSON payload for a voice inbound webhook event. This event can be filtered by channel ID and specific call statuses like 'completed' or 'starting'. ```json { "service": "channels", "event": "voice.inbound", "url": "https://yoururl.com", "signingKey": "mysecretkey", "eventFilters": [ { "key": "channelId", "value": "b827924e-9789-4c2f-a4d5-b352175354f6" }, { "key": "status", "value": "completed" }, { "key": "status", "value": "starting" } ] } ``` -------------------------------- ### Query Documentation with GET Request Source: https://docs.bird.com/api/reporting-api Perform an HTTP GET request to query the documentation dynamically. Include your question in the `ask` query parameter. The response will contain an answer and relevant excerpts. ```http GET https://docs.bird.com/api/reporting-api.md?ask= ``` -------------------------------- ### Example Response for Channel Groups Source: https://docs.bird.com/api/touchpoints-api/supported-projects/whatsapp-approved-message-templates/creating-whatsapp-message-templates This is an example JSON response for the GET /workspaces/{workspaceId}/projects/channel-templates/channel-groups endpoint. It shows the structure of enriched channel group data, including IDs, platform details, and associated channels. ```json { "results": [ { "id": "3f979241-dea3-4f55-b7bb-d769eec27e51", "platformId": "whatsapp", "platformGroupId": "114128184961630", "platformGroupName": "Bird WABA", "channelIds": [ "7b87eea0-631e-576d-a849-ecf58e837b6a" ], "createdAt": "2025-09-19T15:00:15.849Z", "updatedAt": "2025-09-19T15:00:15.849Z" } ] } ``` -------------------------------- ### Query Documentation with 'ask' Parameter Source: https://docs.bird.com/applications/content/external-data-sources/create-an-external-data-source Perform an HTTP GET request to query the documentation dynamically. Replace `` with your specific query. ```http GET https://docs.bird.com/applications/content/external-data-sources/create-an-external-data-source.md?ask= ``` -------------------------------- ### Example Apple Messages for Business API Output Source: https://docs.bird.com/applications/channels/channels/supported-channels/apple-messages-for-business/how-to/route-messages This is an example of the output received when using the 'Get Message' action in MessageBird Flows for an Apple Messages for Business conversation. It shows the structure from which biz-intent-id and biz-group-id can be extracted. ```json { "requestId": "0d87bfa9-0d83-4835-b5c8-8bf7a0936607", "result": { "body": { "text": { "text": "Start a return" }, "type": "text" } }, "conversationId": "d21340ea-9fac-46e4-aa6b-2f3fbfb65fd", "createdAt": "2023-12-15T18:20:43.712", "draft": false, "id": "e4d7026b-30f5-4f63-be4f-dcf9e1f1e0a", "interactions": null, "meta": { "referral": { "group": "returns_department", "metadata": { "sourceId": "question" }, "source": "intent" } } } ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.bird.com/api/channels-api/send-batch-messages Perform an HTTP GET request with the 'ask' query parameter to get answers to specific questions about the documentation. The response includes the answer and relevant sources. ```http GET https://docs.bird.com/api/channels-api/send-batch-messages.md?ask= ``` -------------------------------- ### Get Channel Call Response Example Source: https://docs.bird.com/api/voice-api/voice-calls-api/get-a-call This is an example JSON response when successfully retrieving call details. It includes information such as call ID, channel ID, originator and receiver details, call status, duration, and quality insights. ```json { "id": "6b6f6675-2992-4959-b875-66001e442423", "channelId": "7c8f344a-4fc1-40b7-99a0-91a57b3ef365", "originator": { "contact": { "id": "408ce24d-25b3-47b7-b273-05ff96d6d5ad", "identifierKey": "phonenumber", "identifierValue": "+351211123123" }, "number": { "type": "pstn", "number": "+351211123123", "callerIdName": "PRD", "countryIsoCode": "PT" } }, "receiver": { "number": { "type": "pstn", "number": "+3197004499437", "countryIsoCode": "NL" } }, "from": "+351211123123", "to": "+3197004499437", "direction": "incoming", "status": "no-answer", "type": "pstn", "duration": 0, "hangupCauseCode": 16, "hangupSource": "none", "sipInsights": { "hangupSipCode": "487" }, "qualityInsights": { "mos": "0.00", "pdd": "0.00" }, "createdAt": "2024-02-28T16:54:33.241Z", "updatedAt": "2024-02-28T16:54:34.465Z", "endedAt": "2024-02-28T16:54:33.264Z" } ``` -------------------------------- ### Query Documentation via GET Request Source: https://docs.bird.com/connectivity-platform/how-to-guides/set-up-telegram-account-masking Perform an HTTP GET request to query documentation dynamically. Append the `ask` query parameter with your question. ```http GET https://docs.bird.com/connectivity-platform/how-to-guides/set-up-telegram-account-masking.md?ask= ``` -------------------------------- ### GET /workspaces/{workspaceId}/channels/{channelId}/calls Source: https://docs.bird.com/api/voice-api/voice-calls-api/list-calls-from-a-channel Lists calls from a specific workspace and channel, with optional filtering by start and end times. ```APIDOC ## GET /workspaces/{workspaceId}/channels/{channelId}/calls ### Description Lists calls from a specific workspace and channel, filtered by startAt and endAt. ### Method GET ### Endpoint /workspaces/{workspaceId}/channels/{channelId}/calls ### Query Parameters - **startAt** (string) - Optional - The start date and time for filtering calls. - **endAt** (string) - Optional - The end date and time for filtering calls. ### Request Example ```curl curl "GET /workspaces/{workspaceId}/channels/{channelId}/calls?startAt=2024-02-28T16%3A54%3A33.241Z&endAt=2024-03-01T16%3A54%3A33.241Z" \ -H 'Authorization: AccessKey YOUR_SECRET_TOKEN' ``` ### Response #### Success Response (200) - **nextPageToken** (string) - Token for the next page of results. - **results** (array) - An array of call objects. - **id** (string) - The unique identifier for the call. - **channelId** (string) - The ID of the channel the call belongs to. - **originator** (object) - Information about the call originator. - **contact** (object) - Contact details of the originator. - **id** (string) - The unique identifier for the contact. - **identifierKey** (string) - The type of identifier (e.g., 'phonenumber'). - **identifierValue** (string) - The value of the identifier. - **number** (object) - The phone number details of the originator. - **type** (string) - The type of number (e.g., 'pstn'). - **number** (string) - The phone number. - **callerIdName** (string) - The caller ID name. - **countryIsoCode** (string) - The ISO country code. - **receiver** (object) - Information about the call receiver. - **number** (object) - The phone number details of the receiver. - **type** (string) - The type of number (e.g., 'pstn'). - **number** (string) - The phone number. - **countryIsoCode** (string) - The ISO country code. - **from** (string) - The originating phone number. - **to** (string) - The destination phone number. - **direction** (string) - The direction of the call ('incoming' or 'outgoing'). - **status** (string) - The status of the call (e.g., 'completed', 'no-answer'). - **type** (string) - The type of call (e.g., 'pstn'). - **duration** (integer) - The duration of the call in seconds. - **hangupCauseCode** (integer) - The hangup cause code. - **hangupSource** (string) - The source of the hangup (e.g., 'api', 'none'). - **sipInsights** (object) - SIP-related insights. - **hangupSipCode** (string) - The SIP hangup code. - **qualityInsights** (object) - Quality-related insights. - **mos** (string) - Mean Opinion Score. - **pdd** (string) - Post-dial delay. - **createdAt** (string) - The timestamp when the call was created. - **updatedAt** (string) - The timestamp when the call was last updated. - **ringingAt** (string) - The timestamp when the call started ringing. - **answeredAt** (string) - The timestamp when the call was answered. - **endedAt** (string) - The timestamp when the call ended. - **callFlow** (object) - Details about the call flow. - **id** (string) - The ID of the call flow. - **commands** (array) - An array of commands executed in the call flow. - **id** (string) - The ID of the command. - **callId** (string) - The ID of the call associated with the command. - **command** (string) - The name of the command. - **status** (string) - The status of the command. - **callFlowId** (string) - The ID of the call flow the command belongs to. #### Response Example ```json { "nextPageToken": "WzE3MDkzMTA5MDgyNjksIjcxMTgwYjNlLWI1MDktNDRiNS1iN2IzLTIyNjQwNTI1ZTU4MCJd", "results": [ { "id": "861bb6cf-3edd-4ed2-837a-5cdf7b88a59c", "channelId": "db53c357-92e3-4f3d-babe-159573940a50", "originator": { "contact": { "id": "1ea5d8c8-3f5e-4cc0-bb92-47b099d317c0", "identifierKey": "phonenumber", "identifierValue": "+351910648518" }, "number": { "type": "pstn", "number": "+351910648518", "callerIdName": "Jose G", "countryIsoCode": "PT" } }, "receiver": { "number": { "type": "pstn", "number": "+3197058016589", "countryIsoCode": "NL" } }, "from": "+351910648518", "to": "+3197058016589", "direction": "incoming", "status": "no-answer", "type": "pstn", "duration": 0, "hangupCauseCode": 19, "hangupSource": "none", "sipInsights": { "hangupSipCode": "480" }, "qualityInsights": { "mos": "0.00", "pdd": "9.32" }, "createdAt": "2024-03-01T16:48:48.873Z", "updatedAt": "2024-03-01T16:49:48.254Z", "ringingAt": "2024-03-01T16:48:58.194Z", "answeredAt": "2024-03-01T16:48:58.191Z", "endedAt": "2024-03-01T16:49:48.082Z" } ] } ``` ``` -------------------------------- ### Query Documentation with 'ask' Parameter Source: https://docs.bird.com/connectivity-platform/integrations/connecting-inbox-to-zendesk-using-flow-builder Perform an HTTP GET request to query documentation dynamically. Include your question as the value for the 'ask' query parameter. The response will contain a direct answer and relevant excerpts. ```http GET https://docs.bird.com/connectivity-platform/integrations/connecting-inbox-to-zendesk-using-flow-builder.md?ask= ``` -------------------------------- ### Successful response for getting a message Source: https://docs.bird.com/api/conversations-api/api-reference/conversations-messaging/get-conversation-message This is an example of a successful (200 OK) response when retrieving a message. It contains details about the message, sender, recipients, and body. ```json { "id": "f48ee7ff-45b1-42a2-838b-ea7632180e80", "conversationId": "907798f8-fd72-44d5-8042-fcc05c1bb570", "reference": "", "sender": { "id": "68b80b8d-8060-42df-bda3-73505a8fdb84", "type": "accessKey", "status": "active", "displayName": "My first email key", "avatarUrl": "" }, "draft": false, "recipients": [ { "type": "to", "id": "8f0b5377-2edc-4116-a8e8-6a475f245a04", "identifierKey": "emailaddress", "identifierValue": "john.doe@bird.com", "platformAddress": "john.doe@bird.com", "contactAnnotation": { "name": "John Doe" } } ], "status": "accepted", "source": "conversations", "body": { "type": "text", "text": { "text": "Hey, listen!" } }, "interactions": null, "createdAt": "2024-11-28T19:58:03.999Z", "updatedAt": "2024-11-29T13:14:11.55Z" } ``` -------------------------------- ### Query Documentation with 'ask' Parameter Source: https://docs.bird.com/connectivity-platform/getting-started/when-will-customers-receive-the-abandoned-cart-recovery-message Perform an HTTP GET request to query documentation dynamically. The question should be specific and self-contained. The response includes a direct answer and relevant excerpts. ```http GET https://docs.bird.com/connectivity-platform/getting-started/when-will-customers-receive-the-abandoned-cart-recovery-message.md?ask= ``` -------------------------------- ### Example Conversation Attributes JSON Source: https://docs.bird.com/api/client-sdks/chat-widget-attributes This JSON structure represents the output of a 'Get Conversation' step in Bird Flows, showing available conversation attributes. ```json { "attributes": { "currentPage": "https://example.com/pricing", "userPlan": "premium", "userEmail": "demo@example.com", "source": "support-page" }, "featuredParticipants": [ { "displayName": "Demo User", "type": "contact" } ] } ``` -------------------------------- ### Query Documentation Dynamically Source: https://docs.bird.com/api/collaborations-api/api-reference/capacity-rules Perform an HTTP GET request with the 'ask' query parameter to get dynamic answers and relevant documentation excerpts. Use this when information is not explicitly present or clarification is needed. ```http GET https://docs.bird.com/api/collaborations-api/api-reference/capacity-rules.md?ask= ``` -------------------------------- ### Get All MessageBird Conversations Batch Source: https://docs.bird.com/connectivity-platform/salesforce-sales-service-cloud/sync-messagebird-conversations-to-salesforce Use this Apex batch class to retrieve all existing MessageBird conversations and sync them to Salesforce. This is typically run once during the initial plugin installation. ```apex mbird.GetAllConversationsBatch c1 = new mbird.GetAllConversationsBatch(); c1.configurationName = ‘mbird__MessageBird'; //QualifiedApiName of the configuration created in the setup screen. Database.executeBatch(c1); ``` -------------------------------- ### Query Documentation Source: https://docs.bird.com/api/client-sdks/event-tracking/track-events/app Perform an HTTP GET request to dynamically query documentation. Use the 'ask' query parameter with a specific question. ```http GET https://docs.bird.com/api/client-sdks/event-tracking/track-events/app.md?ask= ``` -------------------------------- ### Agent Instructions: Querying This Documentation Source: https://docs.bird.com/api/knowledge-base-kb-api/api-reference/search Instructions on how to dynamically query the documentation using the 'ask' parameter. ```APIDOC ## Querying Documentation Dynamically ### Description If you need additional information not directly available on the page, you can query the documentation dynamically by asking a question. ### Method GET ### Endpoint `GET https://docs.bird.com/api/knowledge-base-kb-api/api-reference/search.md?ask=` ### Parameters #### Query Parameters - **ask** (string) - Required - Your question in natural language. It should be specific and self-contained. ### Response The response will contain a direct answer to your question, along with relevant excerpts and sources from the documentation. ### Usage Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections. ```