### Get Configuration Example Source: https://www.infobip.com/docs/api/platform/numbers/my-numbers/voice-recording/remove-recording-configuration This JSON object shows an example of a voice recording configuration that can be retrieved. It is provided for context related to the delete operation. ```json { "numberKey": "2838023A778DFAECDC212708F721B788", "recording": { "enabled": true } } ``` -------------------------------- ### Get Domains Response Example Source: https://www.infobip.com/docs/api/channels/email/get-domains This is an example of a successful response from the Get Suppression Domains API, showing the structure of the returned domain data and pagination details. ```json { "results": [ { "domainName": "another.example.com", "dataAccess": "OWNER", "readBounces": true, "createBounces": true, "deleteBounces": true, "readComplaints": true, "createComplaints": true, "deleteComplaints": true, "readOverquotas": true, "deleteOverquotas": true }, { "domainName": "example.com", "dataAccess": "GRANTED", "readBounces": true, "createBounces": true, "deleteBounces": false, "readComplaints": true, "createComplaints": false, "deleteComplaints": false, "readOverquotas": false, "deleteOverquotas": false } ], "paging": { "page": 0, "size": 100 } } ``` -------------------------------- ### Example Instructions for Hello World Agent Source: https://www.infobip.com/docs/ai-agents/build/configure-agent.md These instructions define the behavior for a simple demo agent. They specify the agent's persona, greeting, and core functionalities, including tool usage. ```javascript You are *Hello world agent*, a simple and cheerful demo assistant. When an end user sends a message, respond with a warm greeting, introduce yourself, and explain that you are here to demonstrate basic agent functionality. Mention that you can call tools to fetch example data or coordinate simple tasks. You should always: - Greet end users warmly and introduce yourself on first contact - Explain that you are a "Hello world" demo agent - Optionally add a lighthearted joke to make the interaction fun. Keep responses concise, friendly, and clear. ``` -------------------------------- ### C# Example for API Client Configuration Source: https://www.infobip.com/docs/essentials/api-authentication Shows how to configure the Infobip API client in C# by setting the base path, username, and password for authentication. ```csharp var configuration = new Configuration() { BasePath = "BASE_URL", Username = "USERNAME", Password = "PASSWORD" }; ``` -------------------------------- ### Time Picker - Start Time Example Source: https://www.infobip.com/docs/answers/chatbot-elements/channels.md Example of how to reference an iteration label and field name for the start time in a Time Picker element. The iteration label 'it_label' and the field 'identifier' are used here. ```handlebars {{it_label.identifier}} ``` -------------------------------- ### Response Example for Push Configurations Source: https://www.infobip.com/docs/api/channels/webrtc-calls/webrtc/webrtc-push-configuration/get-push-configurations This JSON response shows an example of push configurations for different applications, including their IDs, names, and platform configuration status. ```json { "results": [ { "id": "454d142b-a1ad-239a-d231-227fa335aadc3", "name": "Android Push Config Production", "androidConfigured": true, "iosConfigured": false }, { "id": "894c822b-d7ba-439c-a761-141f591cace7", "name": "Test Push Config", "androidConfigured": true, "iosConfigured": true } ], "pageInfo": { "page": 0, "size": 2, "totalPages": 1, "totalResults": 2 } } ``` -------------------------------- ### cURL Request Example Source: https://www.infobip.com/docs/api/channels/voice/number-masking/number-masking-configurations/get-number-masking-configurations Example of how to make a GET request to retrieve number masking configurations using cURL. ```bash curl -L -g 'https://{baseUrl}/voice/masking/2/config' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Get Brand Vets cURL Example Source: https://www.infobip.com/docs/api/platform/numbers/number-registration/brands/get-brand-vets Example of how to call the Get Brand Vets API using cURL. Includes placeholders for base URL, brand ID, and authorization token. Demonstrates sorting by vetted date in descending order. ```bash curl -L -g 'https://{baseUrl}/number-registration/1/brands/{brandId}/vets?sort=vettedDate%2Cdesc' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Simple Prompt Template Example Source: https://www.infobip.com/docs/ai-hub/ai-assistant/create-ai-assistant.md Use this simple prompt template for basic assistant configurations. It includes mandatory variables for context and query. ```text This is your context:{context_str}, answer the question:{query_str} using context. ``` -------------------------------- ### Create Sending Strategy - Go Example Source: https://www.infobip.com/docs/api/platform/sending-strategy/create-sending-strategy-v2 Example of creating a sending strategy using Go. ```go sendingStrategyRequest := &sendingstrategy.SendingStrategyRequest{ Platform: &sendingstrategy.Platform{ ApplicationId: "default", }, } resp, _, err := sendingStrategyApi.CreateSendingStrategyExecute(sendingStrategyRequest) if err != nil { fmt.Printf("Error: %v\n", err) return } fmt.Printf("Sending Strategy ID: %s\n", *resp.SendingStrategyId) ``` -------------------------------- ### Get Voice Setup on Number Source: https://www.infobip.com/docs/api/platform/numbers/my-numbers/number-management/get-voice-setup-on-number Retrieves the voice setup configuration for a specified number. This includes details such as voice number masking configurations. ```APIDOC ## GET /numbers/2/numbers/{numberKey}/voice ### Description Fetches the voice setup on a number. ### Method GET ### Endpoint /numbers/2/numbers/{numberKey}/voice ### Parameters #### Path Parameters - **numberKey** (string) - Required - Unique ID of a number. #### Query Parameters None #### Request Body None ### Request Example ```curl curl -L -g 'https://{baseUrl}/numbers/2/numbers/{numberKey}/voice' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` ### Response #### Success Response (200) OK - **action** (object) - Contains the voice setup configuration. - **voiceNumberMaskingConfigKey** (string) - The key for the voice number masking configuration. - **type** (string) - The type of configuration, e.g., VOICE_NUMBER_MASKING. #### Response Example ```json { "action": { "voiceNumberMaskingConfigKey": "C6A5995CBF4D2DF2ADE29963B3BB00E6", "type": "VOICE_NUMBER_MASKING" } } ``` #### Error Responses - **401** Unauthorized - **403** Forbidden - **404** Not Found - **500** Internal Server Error ``` -------------------------------- ### List All Configurations cURL Example Source: https://www.infobip.com/docs/api/channels/mobile-app-messaging/push-configurations-and-actions/list-all-configurations This snippet shows how to list all push configurations for a given application using cURL. Ensure you replace placeholders like {baseUrl}, {authorization}, and my_app_code with your actual values. ```bash curl -L -g 'https://{baseUrl}/push/1/applications/my_app_code/configurations' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Get Conversation cURL Example Source: https://www.infobip.com/docs/api/customer-engagement/conversations/conversation-management/get-conversation Example of how to retrieve a conversation using cURL. Ensure you replace placeholders like {baseUrl} and {conversationId} with your actual values. ```shell curl -L -g 'https://{baseUrl}/ccaas/1/conversations/{conversationId}' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Sample Theme Configuration Source: https://www.infobip.com/docs/live-chat/advanced-customization.md A practical example of a theme configuration, demonstrating overrides for colors and font settings in both 'default' and 'dark' themes. The 'default' theme includes custom font settings. ```json { "default": { "styles": { "lc-header-container-background-color": "#4169E1", "lc-chat-message-user-bubble-background-color": "#4169E1", "lc-chat-message-user-bubble-text-color": "#FFFFFF" }, "fonts": { "fontFaceUrl": "https://fonts.googleapis.com/css2?family=Inter:wght@400;700&display=swap", "fontFamily": "Inter" } }, "dark": { "styles": { "lc-chat-background-color": "#181A20", "lc-header-container-background-color": "#3552B3" } } } ``` -------------------------------- ### Example: Minute Function Source: https://www.infobip.com/docs/expression-language/expression-language-reference.md Demonstrates the output of the minute function with a sample datetime. ```text minute(toDateTime("1981-07-12 12:34:56", "yyyy-M-d HH:mm:ss")) ``` -------------------------------- ### Get Regions Response Example Source: https://www.infobip.com/docs/api/channels/voice/calls/sip-trunks/get-regions This is an example of a successful JSON response when retrieving regions. It lists region names, codes, and their associated country codes. ```json [ { "name": "Dubrovnik-Neretva County", "code": "HR-19", "countryCode": "HRV" }, { "name": "Međimurje County", "code": "HR-20", "countryCode": "HRV" }, { "name": "City of Zagreb", "code": "HR-21", "countryCode": "HRV" } ] ``` -------------------------------- ### Capture User Input with Multiple Keyphrases Source: https://www.infobip.com/docs/voice-and-video/interactive-voice-response-ivr.md This example shows how to capture user input using multiple keyphrases. It's recommended to instruct users to speak after a sound signal for better capture accuracy. ```json { "say": "If you want more info, say: info. If you want to reach our agent, say: agent" }, { "capture": "myVar", "timeout": 5, "speechOptions": { "language": "en-US", "maxSilence": 3, "keyPhrases": ["info", "agent"] } }, { "if": "${myVar == 'info'}", "then": [ { "say": "Ok. I will send you more details" } ], "else": [] } ``` ```json { "say": "If you want more info, after the beep signal say: info. If you want to reach our agent, after the beep signal say: agent" }, { "capture": "myVar", "timeout": 5, "speechOptions": { "language": "en-US", "maxSilence": 3, "keyPhrases": ["info", "agent"] } }, { "if": "${myVar == 'info'}", "then": [ { "say": "Ok. I will send you more details" } ], "else": [] } ``` -------------------------------- ### Conference Page Response Example Source: https://www.infobip.com/docs/api/channels/voice/calls/conference-calls/get-conferences An example JSON response for a successful request to get conference calls, showing the structure of results and pagination details. ```json { "results": [ { "id": "e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001", "name": "Example conference", "participants": [ ], "callsConfigurationId": "dc5942707c704551a00cd2ea", "platform": { "applicationId": "61c060db2675060027d8c7a6" } } ], "paging": { "page": 0, "size": 1, "totalPages": 1, "totalResults": 1 } } ``` -------------------------------- ### Get Scheduled Email Statuses Response Example Source: https://www.infobip.com/docs/api/channels/email/scheduled-email/get-scheduled-email-statuses This is an example of a successful response when retrieving the status of a scheduled email bulk, indicating a 'PAUSED' status. ```JSON { "externalBulkId": "BULK-ID-123-xyz", "bulks": [ { "bulkId": "2033247207450906897", "status": "PAUSED" } ] } ``` -------------------------------- ### Get Files Response Sample Source: https://www.infobip.com/docs/api/channels/webrtc-calls/webrtc/webrtc-files/get-files Example JSON response for a successful request to the get files API, showing a list of files and pagination information. ```json { "results": [ { "id": "5f4e8861-8ed7-4521-b8c8-f26346726716", "name": "5f4e8861-8ed7-4521-b8c8-f26346726716_alice_1680266280000.png", "fileFormat": "PNG", "size": 10780, "creationTime": "2023-03-31T12:38:00.000+0000" } ], "pageInfo": { "page": 0, "size": 1, "totalPages": 1, "totalResults": 1 } ``` -------------------------------- ### Example: Second Function Source: https://www.infobip.com/docs/expression-language/expression-language-reference.md Demonstrates the output of the second function with a sample datetime. ```text second(toDateTime("1981-07-12 12:34:56", "yyyy-M-d HH:mm:ss")) ``` -------------------------------- ### Successful Bot Setup Response Example Source: https://www.infobip.com/docs/api/customer-engagement/conversations/bots/setup-bot This is an example of a successful response when a bot is created. It includes the unique ID assigned to the bot and echoes the provided configuration. ```JSON { "id": "309BB921757DEAC9BE79EC6259B31C8A", "displayName": "My Whatsapp Bot", "webhookUrl": "www.webhookurl.com/link1", "destination": "447492263897", "channel": "WHATSAPP", "messagePersistencePolicy": "PERSIST_ALL", "enabled": true, "sessionTimeoutInSec": 120 } ``` -------------------------------- ### HTTP FORWARD Action Setup Source: https://www.infobip.com/docs/mobile-push/mobile-push-over-api/receive-mobile-app-users-responses-over-api.md Defines the properties for setting up an HTTP FORWARD action. ```APIDOC ## HTTP FORWARD Action ### Description Defines the properties for setting up an HTTP FORWARD action. ### Properties - **key** (string) - The action's key. - **type** (string) - Constant value -HTTP_FORWARD - **forwardUrl** (string) - URL to which the received message will be forwarded to. - **callbackData** (string) - Optional. The string that will be forwarded alongside the usual fields posted toforwardUrl. ``` -------------------------------- ### Example: Month Function Source: https://www.infobip.com/docs/expression-language/expression-language-reference.md Demonstrates the output of the month function with a sample date. ```text month(toDate("1981-07-12", "yyyy-MM-dd")) ``` -------------------------------- ### cURL Request Example Source: https://www.infobip.com/docs/api/customer-engagement/conversations/working-hours/get-filtered-working-hours Example of how to make a cURL request to the get filtered working hours endpoint. Replace placeholders with your actual base URL and authorization token. ```bash curl -L -g 'https://{baseUrl}/ccaas/1/working-hours' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Get Applications cURL Example Source: https://www.infobip.com/docs/api/platform/application-entity/application/get-applications This snippet shows how to make a GET request to the applications endpoint using cURL. Ensure you replace {baseUrl} and {authorization} with your specific values. ```bash curl -L -g 'https://{baseUrl}/provisioning/1/applications' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ``` -------------------------------- ### Get All Templates Source: https://www.infobip.com/docs/api/customer-engagement/conversations/get-templates This cURL example demonstrates how to retrieve all available templates. Ensure you replace `{baseUrl}` and `{authorization}` with your actual Infobip API credentials and base URL. ```bash curl -L -g 'https://{baseUrl}/ccaas/1/templates' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json' ```