Desk360

https://whatsapp.desk360.com
Admin
Desk360 is an official WhatsApp Business solution provider that allows businesses to manage all...
Tokens:44,042
Snippets:159
Trust Score:7.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### AI Agent Setup and Configuration Guide

Source: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

A comprehensive guide to setting up and configuring the Desk360 AI Agent, covering its introduction, activation scenarios, and various configuration tabs.

```APIDOC
AI Agent Setup and Configuration:
  URL: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

  Introduction:
    The AI Agent by Desk360 automates customer support, reduces representative workload, and improves customer experience by providing 24/7 service.

  AI Agent Activation Scenarios:
    1. When representatives are offline: AI Agent handles customer queries when no human agent is active.
    2. Always active mode: AI Agent responds in all situations, regardless of agent online status.

  Configuration Tabs:
    - General Tab: AI Agent Basic Settings
    - Knowledge Base Tab: Creating Information Database for AI Agent
    - Commands Tab: Custom Response Creation and Optimization
    - Agent Redirections Tab: Trigger Settings and Redirection
    - Testing Area Tab: Testing and Publishing
```

--------------------------------

### WhatsApp Business API Setup Guide

Source: https://whatsapp.desk360.com/whatsapp-business-api-setup

Provides a step-by-step guide for setting up the WhatsApp Business API with Desk360. It outlines prerequisites, considerations, and the five key steps involved in the process.

```APIDOC
WhatsApp Business API Setup:
  Overview: Allows quick and easy setup for receiving Business API service on a phone number.
  Steps:
    1. Connecting your Facebook Business Account
    2. Determining Phone Number and Display Name
    3. Invoicing
    4. Phone Number Verification
    5. Completion of the setup
  Prerequisites & Considerations:
    - Verified Facebook Business Account is mandatory.
    - A phone number cannot be used for both Business API and Business App simultaneously.
    - If the phone number is registered with WhatsApp, delete the account from WhatsApp settings (Account section) and wait 5 minutes.
    - Previous messages cannot be transferred.
    - If the phone number is registered with a different Business API provider, disable 2-Step Verification in Facebook Business Manager before setup.
    - All steps must be completed successfully; skipping is not possible.
  Step 1: Connecting the Facebook Account:
    - Requirement: Verified Facebook Business Account.
    - Action: Click 'Continue' and sign in with your Facebook Business Manager Account in the pop-up window.
    - Reference: [Facebook Business Account Guide](https://www.facebook.com/business/tools/business-manager/get-started-guide)
```

--------------------------------

### Virtual Number Setup - Completing the Setup

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

Describes the final steps of the WABA setup after clicking the 'Complete' button, including OTP verification and progression to the 'Setup Completing' screen.

```en
4) Completing the Setup
After clicking the "Complete" button:
  * An OTP (verification code) is received from Meta via SMS in the background.
  * The code is automatically verified.
  * The user proceeds to the "Setup Completing" screen, which is the final step of the setup.
```

--------------------------------

### Retrieve Media Message - Java Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using Java with OkHttpClient.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(JSON, "{}");
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId")
  .method("GET", body)
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Virtual Number Setup - Selection and Summary Screen

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

Explains the number selection and summary screen, where the chosen number is displayed and reserved for 15 minutes.

```en
3) Number Selection and Summary Screen
When the "Select Number" button is clicked, the user is directed to a summary screen.
  * The selected number is displayed here.
  * The selected number is reserved for the user for 15 minutes. If the user waits more than 15 minutes on this screen, the number reservation will be cancelled.
```

--------------------------------

### Send Location Request - Java Example

Source: https://whatsapp.desk360.com/api-documentation

Java code example using OkHttpClient to send a location request. It sets up the request URL, headers, and JSON request body for the POST operation.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"to\": \"+90xxxxxxxxxx\",\n    \"body\": \"<i>Send Location</i>\"\n}");
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Retrieve Media Message - C# Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using C# with RestSharp.

```C#
var options = new RestClientOptions("https://public-api.desk360.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/integrations/:integrationId/conversations/messages/medias/:mediaId", Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Virtual Number Setup - Number Selection Screen

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

Describes the number selection screen during WhatsApp Business API setup, including the functionality of the 'Click to Purchase Number' button.

```en
1) Number Selection Screen
During the WABA setup process, all users encounter the following screen.
  * When the "Click to Purchase Number" button is pressed, the number addition field opens.
```

--------------------------------

### Send WhatsApp Message (Python)

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a GET request to the WhatsApp Desk360 API to retrieve message data. Requires the 'requests' library.

```python
import requests

url = "YOUR_API_ENDPOINT"
payload = ""
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

--------------------------------

### WhatsApp Desk360 API Response Example

Source: https://whatsapp.desk360.com/api-documentation

Example of a successful response from the WhatsApp Desk360 API, typically indicating that a message has been processed.

```APIDOC
200 
{
    "message_id": "gBEGkFBXUQRnAgkCL1xSaIMoDz0"
}
```

--------------------------------

### Retrieve Media Message - JavaScript Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using JavaScript with Axios.

```JavaScript
const axios = require('axios');
const FormData = require('form-data');
let data = new FormData();
let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...data.getHeaders()
  },
  data : data
};
axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Desk360 API Documentation

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

This section provides API documentation for Desk360, detailing available endpoints, methods, and parameters for integrating with the platform.

```APIDOC
API Documentation:
  Access point for programmatic interaction with Desk360 features.
  Details on endpoints, request/response formats, and authentication are provided.
  Refer to https://whatsapp.desk360.com/api-documentation for specifics.
```

--------------------------------

### Send Media Message - Java

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using Java with OkHttpClient.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("to","+90xxxxxxxxxx")
  .addFormDataPart("attachments[]","file",
    RequestBody.create(MediaType.parse("application/octet-stream"),
    new File("/path/to/file")))
  .build();
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias")
  .method("POST", body)
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### WhatsApp Template Message Creation Guide

Source: https://whatsapp.desk360.com/whatsapp-template-messages

Provides a step-by-step guide on how to create WhatsApp Message Templates within Desk360. It covers prerequisites, category selection, naming conventions, language selection, and the process of creating template content. It also highlights important rules for template naming and the impact of category selection on Meta's approval.

```APIDOC
WhatsApp Template Messages:

Creating a Message Template:
  Prerequisites:
    - Logged in with a Desk360 account.
    - At least one WhatsApp Account set up.

  Steps:
    1. Navigate to 'Message Templates' from the left menu.
    2. If multiple WhatsApp accounts exist, select the desired account.
    3. Click the 'Create Template' button.
    4. Complete the following fields:
       - Category selection: Choose the most suitable category for the template content. Incorrect selection may lead to rejection by Meta.
       - Name: 
         - Allowed characters: lowercase letters, English characters, and '_'.
         - Maximum length: 255 characters.
         - Restrictions: Cannot be named 'test'. Cannot reuse the name of a deleted template.
       - Language: Select at least one language; multiple languages can be chosen.
    5. Click 'Continue' to proceed to create the message template content.

Editing Message Template:
  - Details on how to edit existing message templates.

Deleting Message Template:
  - Information on how to delete message templates.

Sending Message Template:
  - Guidance on sending message templates.
```

--------------------------------

### Retrieve Media Message - cURL Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using cURL.

```cURL
curl --location --request GET 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId' \
--header 'Authorization: Bearer YOUR_API_TOKEN'
```

--------------------------------

### Retrieve Media Message - Python Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using Python with the requests library.

```Python
import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId"
payload = {}
files={}
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.request("GET", url, headers=headers, data=payload, files=files)
print(response.text)
```

--------------------------------

### Send Location Request - Python Example

Source: https://whatsapp.desk360.com/api-documentation

Python code example using the requests library to send a location request. It constructs the URL, headers, and JSON payload for the POST request.

```Python
import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request"
payload = json.dumps({
  "to": "+90xxxxxxxxxx",
  "body": "<i>Send Location</i>"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```

--------------------------------

### Retrieve Message Templates (Java)

Source: https://whatsapp.desk360.com/api-documentation

Example using Java with OkHttpClient to fetch message templates from the WhatsApp Desk360 API. Demonstrates setting the Authorization header.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates")
  .method("GET", null)
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Send Location Request - C# Example

Source: https://whatsapp.desk360.com/api-documentation

C# code example using RestClient to send a location request. It configures the request with headers, JSON body, and executes the POST request asynchronously.

```C#
var options = new RestClientOptions("https://public-api.desk360.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/integrations/:integrationId/conversations/messages/interactive/location-request", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
var body = @"{{\"to\": \"+90xxxxxxxxxx\",\n\"body\": \"<i>Send Location</i>\"}}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Send Location Request - cURL Example

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a location request using cURL, demonstrating the POST request with JSON payload and necessary headers.

```cURL
curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{ \
    "to": "+90xxxxxxxxxx", \
    "body": "<i>Send Location</i>" \
}'
```

--------------------------------

### Retrieve Media Message - PHP Example

Source: https://whatsapp.desk360.com/api-documentation

Example of how to retrieve media messages using PHP with cURL.

```PHP
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_API_TOKEN'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

--------------------------------

### Retrieve Message Templates (Python)

Source: https://whatsapp.desk360.com/api-documentation

Example using Python with the requests library to fetch message templates from the WhatsApp Desk360 API. Demonstrates setting the Authorization header.

```Python
import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates"
payload={}
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
```

--------------------------------

### Send Location Request - JavaScript Example

Source: https://whatsapp.desk360.com/api-documentation

JavaScript example using axios to send a location request. It defines the request configuration including URL, headers, and the JSON data payload.

```JavaScript
const axios = require('axios');
let data = JSON.stringify({
  "to": "+90xxxxxxxxxx",
  "body": "<i>Send Location</i>"
});
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer YOUR_API_TOKEN'
  },
  data : data
};
axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Send Media Message - Python

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using Python with requests.

```Python
import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias"
payload = {'to': '+90xxxxxxxxxx'}
files=[
  ('attachments[]',('file',open('/path/to/file','rb'),'application/octet-stream'))
]
headers = {
  'Authorization': 'Bearer YOUR_API_TOKEN'
}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
```

--------------------------------

### Send Media Message - C#

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using C# with RestSharp.

```C#
var options = new RestClientOptions("https://public-api.desk360.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/integrations/:integrationId/conversations/messages/medias", Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
request.AlwaysMultipartFormData = true;
request.AddParameter("to", "+90xxxxxxxxxx");
request.AddFile("attachments[]", "/path/to/file");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Retrieve Message Templates (C#)

Source: https://whatsapp.desk360.com/api-documentation

Example using C# with RestClient to fetch message templates from the WhatsApp Desk360 API. Includes setting the API token for authorization.

```C#
var client = new RestClientRestClient("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Send WhatsApp Message (Java)

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a text message using Java with OkHttp to the WhatsApp Desk360 API.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("to","+90xxxxxxxxxx")
  .addFormDataPart("text","Hello!")
  .build();
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages")
  .method("POST", body)
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Mark Messages as Read - Java

Source: https://whatsapp.desk360.com/api-documentation

Example of how to mark messages as read using Java with OkHttpClient. This code demonstrates building the request with multipart form data and headers.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("to","+90xxxxxxxxxx")
  .addFormDataPart("message_ids[]","xxxxxxxxxxxxxxxx")
  .build();
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads")
  .method("POST", body)
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Retrieve Message Templates (PHP)

Source: https://whatsapp.desk360.com/api-documentation

Example using PHP with cURL to fetch message templates from the WhatsApp Desk360 API. Includes setting the Authorization header.

```PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_API_TOKEN',
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

?>
```

--------------------------------

### Retrieve Message Templates (JavaScript)

Source: https://whatsapp.desk360.com/api-documentation

Example using JavaScript with axios to fetch message templates from the WhatsApp Desk360 API. Shows how to configure the request with the Authorization header.

```JavaScript
var axios = require('axios');
var config = {
  method: 'get',
  url: 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates',
  headers: { 
    'Authorization': 'Bearer YOUR_API_TOKEN', 
  }
};
axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

```

--------------------------------

### Send Interactive Message (Java)

Source: https://whatsapp.desk360.com/api-documentation

Example of sending an interactive message using OkHttp in Java. This involves building a request with the URL, method, headers, and a JSON body.

```Java
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Send Location Message using C#

Source: https://whatsapp.desk360.com/api-documentation

C# code example using RestClient to send a location message. Includes setting up the client, request, headers, and JSON body.

```csharp
var options = new RestClientOptions("https://public-api.desk360.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/integrations/:integrationId/conversations/messages/locations", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
var body = @"{{\"to\": \"+90xxxxxxxxxx\",\n    \"location\": {{\n        \"longitude\": -122.425332,\n        \"latitude\": 37.758056,\n        \"name\": \"Facebook HQ\",\n        \"address\": \"1 Hacker Way, Menlo Park, CA 94025\"\n    }}\n}}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Mark Messages as Read - C#

Source: https://whatsapp.desk360.com/api-documentation

Example of how to mark messages as read using C# with RestClient. This code snippet demonstrates setting up the client, request, headers, and form data.

```C#
var options = new RestClientOptions("https://public-api.desk360.com")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/integrations/:integrationId/conversations/messages/reads", Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_API_TOKEN");
request.AlwaysMultipartFormData = true;
request.AddParameter("to", "+90xxxxxxxxxx");
request.AddParameter("message_ids[]", "xxxxxxxxxxxxxxxx");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
```

--------------------------------

### Send Location Message using Python

Source: https://whatsapp.desk360.com/api-documentation

Python code example using the requests library to send a location message. Shows how to construct the URL, headers, and JSON payload.

```python
import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations"
payload = json.dumps({
  "to": "+90xxxxxxxxxx",
  "location": {
    "longitude": -122.425332,
    "latitude": 37.758056,
    "name": "Facebook HQ",
    "address": "1 Hacker Way, Menlo Park, CA 94025"
  }
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```

--------------------------------

### META Processes: Business Portfolio Setup

Source: https://whatsapp.desk360.com/meta-processes

Details the requirements and steps for creating a business portfolio on Meta, which is necessary for managing WhatsApp Business API and other Meta services. This includes having a personal Facebook account, understanding portfolio limits, and providing business details.

```APIDOC
META Processes: Business Portfolio Setup

Before you begin:
  * Requirement: A personal Facebook account is mandatory for logging into Meta Business Suite or Business Manager.
  * Portfolio Limit: You can create up to 2 business portfolios. This does not limit the number of portfolios you can belong to.
  * Permissions: Business Manager permissions take precedence over all other permissions.

Create a business portfolio:
  1. Navigate to business.facebook.com in a desktop browser.
     * Alternatively, if already logged into Meta Business Suite/Manager, use the dropdown in the left navigation bar and skip to Step 4.
  2. Click "Create an account."
  3. Log in using your personal Facebook account. If you don't have one, create it first.
  4. Click "Create an account" again.
  5. Enter business details:
     * Business portfolio name: Must match the public business name, cannot contain special characters, and will be visible across Meta.
     * Your name: The name of the user creating the portfolio.
     * Business email: Used for business-related communications from Meta, not visible to customers.
  6. Click "Submit" or "Create" to finalize portfolio creation.
     * Confirmation: An email will be sent to verify your business email address.
```

--------------------------------

### Website Addition Limits

Source: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

Outlines the constraints for adding websites to the AI Agent's knowledge base, including the maximum number of websites and the functionality of the 'Crawl' method.

```APIDOC
Website Addition:
  Max Websites: 20
  Crawl Method: Lists connected pages, allows selection/removal.
  'Add' Button Disabled: If more than 20 links are present.
```

--------------------------------

### Virtual Number Advantages

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

Highlights the benefits of using virtual numbers for WhatsApp Business API setup, such as no SIM card requirement, faster setup, and lower entry barrier.

```en
Why Virtual Number?
The virtual number feature provides the following advantages:
  * Does not require a physical SIM card.
  * Accelerates the WABA setup process.
  * Offers a low entry barrier for users who want to try the platform.
```

--------------------------------

### Desk360 Registration Guide

Source: https://whatsapp.desk360.com/register

Instructions for registering on the Desk360 platform. Covers manual registration with email, name, phone, country, and password, as well as Google account integration. Includes password and name field requirements.

```APIDOC
Registration Process:
  - Access registration via https://my.desk360.com/register.
  - Fields required: email, first name, last name, phone number, country, password.
  - Option to 'Continue with Google' for streamlined signup using Google account details.

Field Requirements:
  - Name and Surname: Minimum 3 characters.
  - Password: Minimum 8 characters, including uppercase and lowercase letters, and at least one number.
```

--------------------------------

### Virtual Number Setup - Number Display

Source: https://whatsapp.desk360.com/virtual-number-setup-and-configuration

Details the fields present on the number display screen during WABA setup, including phone number, refresh button, and self-selection option. Notes the current limitation to US-compatible numbers.

```en
2) Number Display
The following fields are located within the relevant area:
  * Phone Number: An automatic number is displayed to the user.
  * Refresh button: When clicked, a random new number is displayed to the user.
  * "I Will Choose My Own Number" button: Allows the user to select their own number.
  * Currently, only US-compatible phone numbers can be obtained.
```

--------------------------------

### AI Agent Knowledge Base Management

Source: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

Details the process of creating the AI Agent's information database by uploading various data types to train the AI and enhance its knowledge capacity for customer inquiries.

```APIDOC
AI_Agent_Knowledge_Base:
  upload_data: "(data_type: string, data_source: string | file_path) -> status: string"
    # Uploads various data types to train the AI Agent.
    # data_type: Type of data being uploaded (e.g., 'text', 'faq', 'document').
    # data_source: Path to the file or a string containing the data.
    # Returns: Status of the upload operation.

  data_processing: "(data_id: string) -> status: string"
    # Processes uploaded data for AI Agent's use.
    # data_id: Identifier for the uploaded data.
    # Returns: Status of the data processing.

  # Rules for knowledge base creation:
  # - Provide accurate and diverse data sources.
  # - AI Agent's algorithm processes all added information.
  # - Flexibility in uploading different data formats is supported.

```

--------------------------------

### WhatsApp Desk360 API Documentation Overview

Source: https://whatsapp.desk360.com/api-documentation

Provides an overview of the Desk360 API, including general concepts like HTTP methods, rate limiting, authentication, attachments, error handling, pagination, and best practices.

```APIDOC
Introduction:
  Covers the fundamental aspects of using the Desk360 API.

HTTP Methods:
  Details the supported HTTP request methods (e.g., GET, POST, PUT, DELETE).

Rate Limit:
  Explains the API rate limits and how to manage them to avoid throttling.

Getting Started:
  Guides users through the initial steps of integrating with the API.

Authentication:
  Describes the authentication mechanisms required to access the API, likely API keys or OAuth.

Attachments:
  Information on how to handle and send attachments via the API.

Errors:
  Details common error codes, their meanings, and troubleshooting steps.

Pagination:
  Explains how to paginate through large datasets returned by the API.

Best Practices:
  Provides recommendations for efficient and effective API usage.
```

--------------------------------

### AI Agent General Settings Configuration

Source: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

Defines the basic working principles and communication style of the AI Agent. Includes selecting a WhatsApp Business account, determining response conditions, setting conversation tone, emoji usage preference, and choosing the GPT model.

```APIDOC
AI_Agent_Configuration:
  General_Settings:
    whatsapp_business_account: "string (required)"  # The WhatsApp Business account for the AI Agent to respond from. Auto-assigned if only one account exists.
    response_condition: "enum (required)"           # Determines when the AI Agent responds.
      - Always: AI Agent always responds.
      - Only_when_operator_is_offline: AI Agent responds only when customer representatives are offline.
      # Default: Always
    conversation_tone: "enum (required)"             # The AI's communication tone.
      - Neutral
      - Friendly
      - Formal
      # Default: Neutral
    emoji_usage: "boolean (optional)"                # Preference for emoji usage in messages.
      # Default: false
    gpt_model: "string (required)"                 # The AI Agent's basic language model.
      # Default: GPT-4o Mini

  # Actions:
  save_and_continue: "()" # Saves current tab settings and proceeds to the next tab.
  activate_agent: "()"    # Activates the AI Agent.
  deactivate_agent: "()"  # Deactivates the AI Agent.
  delete_agent: "()"      # Initiates the deletion process for the AI Agent.

```

--------------------------------

### Send Message Template using Java

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a WhatsApp message template using Java with OkHttp. This code demonstrates how to build a multipart POST request, including authentication headers and form data for template parameters and attachments.

```Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("template_id","1")
  .addFormDataPart("language_id","1")
  .addFormDataPart("destinations[0][phone]","+905555555555")
  .addFormDataPart("destinations[0][parameters][header-1]","Header 1")
  .addFormDataPart("destinations[0][parameters][body-1]","Body 1")
  .addFormDataPart("destinations[0][parameters][body-2]","Body 2")
  .addFormDataPart("attachment","test_image.jpg",
    RequestBody.create(MediaType.parse("application/octet-stream"),
    new File("/test_image.jpg")))
  .build();
Request request = new Request.Builder()
  .url("https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send")
  .method("POST", body)
  .addHeader("Authorization", "YOUR_API_TOKEN")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Send Location Request - PHP Example

Source: https://whatsapp.desk360.com/api-documentation

PHP code example using cURL to send a location request. It configures cURL options for the POST request, including headers and the JSON data.

```PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ \
    "to": "+90xxxxxxxxxx", \
    "body": "<i>Send Location</i>" \
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_API_TOKEN'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

?>
```

--------------------------------

### Desk360 API Documentation

Source: https://whatsapp.desk360.com/ai-agent-setup-and-configuration

This section provides access to the API documentation for Desk360, allowing developers to integrate Desk360 functionalities into their applications.

```APIDOC
API Documentation:
  URL: https://whatsapp.desk360.com/api-documentation
  Description: Access the official API documentation for Desk360 to integrate with various features like WhatsApp Business API, AI Agent, and chat management.
```

--------------------------------

### Desk360 Data Import Process

Source: https://whatsapp.desk360.com/data-import

This documentation describes the step-by-step process for importing customer data into the Desk360 panel to facilitate sending template messages. It covers navigating to the 'Upload Data' section, creating new data uploads, naming categories, adding tags, uploading CSV files with phone numbers, and saving the data.

```APIDOC
Data Import Process:

1. Navigate to 'Upload Data' section.
2. Click 'New Data Upload'.
3. Enter a Category Name (max 60 characters).
4. Add Tags (select existing or create new).
5. Upload CSV file with phone numbers (including country codes).
6. Click 'Save' to add the list to the category table.
```

--------------------------------

### Send Media Message - cURL

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using cURL.

```cURL
curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--form 'to="+90xxxxxxxxxx"' \
--form 'attachments[]=@"/path/to/file"'
```

--------------------------------

### Desk360 Quick Response Management

Source: https://whatsapp.desk360.com/desk360-chat-settings/quick-response

This section details how to create, manage, and send quick responses within the Desk360 platform. Quick responses allow support agents to use predefined answers for frequently asked questions, saving time and ensuring consistency.

```APIDOC
Quick Response Management:

Creating a Quick Response:
  - Access the Quick Response feature.
  - Click the '+ Add Quick Response' button.
  - Fill in the following fields:
    - Title: A short name for the reply (e.g., 'Greeting', 'Support Hours').
    - Content: The message body. Supports formatting like bold, italic, links, and emojis.
    - Status: 'Active' or 'Inactive'. Only active replies are visible to agents.
  - Click 'Save' to store the quick response.

Editing and Deleting:
  - Use the '✏️' icon to edit an existing quick response.
  - Use the '🗑️' icon to delete a quick response. Deletion is irreversible.

Sending a Quick Response:
  - Navigate to the chat screen and select an active customer conversation.
  - Click the quick reply icon next to the message input box.
  - A list of available quick replies will appear.
  - Select the desired quick reply.
  - The content will populate the message box, where it can be further edited.
  - Click 'Send' to deliver the message to the customer.

Notes:
  - Only 'Active' quick replies are available for selection.
  - Multiple quick replies can be sent consecutively.
  - Quick replies can be personalized before sending.
```

--------------------------------

### Desk360 API Documentation

Source: https://whatsapp.desk360.com/desk360-balance-management

Provides access to Desk360 functionalities through an API. This section details available endpoints, methods, parameters, and expected responses for integrating Desk360 with other applications.

```APIDOC
API Documentation:
  - Access to Desk360 functionalities via API.
  - Endpoints for managing WhatsApp Business API, chat, AI agents, and more.
  - Detailed information on request methods, parameters, and response formats.
```

--------------------------------

### Send Media Message - PHP

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using PHP with cURL.

```PHP
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('to' => '+90xxxxxxxxxx','attachments[]'=> new CURLFILE('/path/to/file')),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_API_TOKEN'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

--------------------------------

### Send Media Message - JavaScript

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a media message using JavaScript with axios and form-data.

```JavaScript
const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');
let data = new FormData();
data.append('to', '+90xxxxxxxxxx');
data.append('attachments[]', fs.createReadStream('/path/to/file'));
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...data.getHeaders()
  },
  data : data
};
axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```

--------------------------------

### Desk360 Login Methods

Source: https://whatsapp.desk360.com/login

Provides information on how to log in to the Desk360 platform using either a Google account or a Desk360 specific account with email and password.

```APIDOC
Login Methods:

1. Google Account Login:
   - Click on 'Sign in with Google'.
   - Sign in with your Google account in the opened window.

2. Desk360 Account Login:
   - Enter your Email Address.
   - Enter your Password.
   - Click the login button.
```

--------------------------------

### Get WhatsApp Media

Source: https://whatsapp.desk360.com/api-documentation

Retrieve WhatsApp media information by its unique media ID and integration ID.

```APIDOC
GET /v1/integrations/:integrationId/conversations/messages/medias/:mediaId

Path Parameters:
- IntegrationId (Integer, required): The ID of your integration.
- MediaId (String, required): The ID of the media.
```

--------------------------------

### Send WhatsApp Message (cURL)

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a text message using cURL to the WhatsApp Desk360 API.

```cURL
curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--form 'to="+90xxxxxxxxxx"' \
--form 'text="Hello!"'
```

--------------------------------

### Send WhatsApp Message (JavaScript)

Source: https://whatsapp.desk360.com/api-documentation

Example of sending a text message using JavaScript with Axios to the WhatsApp Desk360 API.

```JavaScript
const axios = require('axios');
const FormData = require('form-data');
let data = new FormData();
data.append('to', '+90xxxxxxxxxx');
data.append('text', 'hello!');
let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...data.getHeaders()
  },
  data : data
};
axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
```
Tokens:
Raw