Wati

https://docs.wati.io/
Admin
Wati is a WhatsApp API platform that enables developers to send and receive messages, manage...
Tokens:106,452
Snippets:411
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Broadcasts Overview Example

Source: https://docs.wati.io/reference/get_api-ext-v3-broadcasts-overview

This example demonstrates how to call the API to get the broadcast overview. Ensure you provide the required 'date_from' and 'date_to' query parameters. The 'channel' and 'search_string' parameters are optional.

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "API Documentation V3",
    "version": "v3"
  },
  "paths": {
    "/api/ext/v3/broadcasts/overview": {
      "get": {
        "tags": [
          "Campaigns"
        ],
        "summary": "Get the campaign overview",
        "parameters": [
          {
            "name": "channel",
            "in": "query",
            "description": "Name or phone number of the channel (null for default channel).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "date_from",
            "in": "query",
            "description": "The start date of the broadcast.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "date_to",
            "in": "query",
            "description": "The end date of the broadcast.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "search_string",
            "in": "query",
            "description": "The page number of the broadcast.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the broadcast overview.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBroadcastsOverviewResponse"
                },
                "example": {
                  "total_links": 0,
                  "total_processing": 0,
                  "total_queued": 0,
                  "total_sent": 0,
                  "total_delivered": 0,
                  "total_open": 0,
                  "total_replied": 0,
                  "total_failed": 0,
                  "total_stopped": 0,
                  "total_sending": 0
                }
              }
            }
          },
          "400": {
            "description": "The request is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "The request is unauthorized."
          },
          "403": {
            "description": "The request is forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenRequestResponse"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests. Either the rate limit has been exceeded or usage limits have been reached."
          },
          "500": {
            "description": "Unexpected error occurred. Please try again.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ForbiddenRequestResponse": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "The error code associated with the error.",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "The descriptive error message explaining what went wrong.",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "description": "The timestamp indicating when the error was recorded.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Represents the result of a forbidden request, containing error details."
      },
      "GetBroadcastsOverviewResponse": {
        "type": "object",
        "properties": {
          "total_links": {
            "type": "integer",
            "description": "The total number of links.",
            "format": "int64"
          },
          "total_processing": {
            "type": "integer",
            "description": "The total number of processing links.",
            "format": "int64"
          },
          "total_queued": {
            "type": "integer",
            "description": "The total number of queued links.",
            "format": "int64"
          },
          "total_sent": {
            "type": "integer",
            "description": "The total number of sent links.",
            "format": "int64"
          },
          "total_delivered": {
            "type": "integer",
            "description": "The total number of delivered links.",
            "format": "int64"
          },
          "total_open": {
            "type": "integer",
            "description": "The total number of open links.",
            "format": "int64"
          },
          "total_replied": {
            "type": "integer",
            "description": "The total number of replied links.",
            "format": "int64"
          },
          "total_failed": {
            "type": "integer",
            "description": "The total number of failed links.",
            "format": "int64"
          },
          "total_stopped": {
            "type": "integer",
            "description": "The total number of stopped links.",
            "format": "int64"
          },
          "total_sending": {
            "type": "integer",
            "description": "The total number of sending links.",
            "format": "int64"
          }
        },
        "additionalProperties": false,
        "description": "Represents the broadcast overview response."
      }
    }
  }
}
```

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

### Get Sales Pipeline Response Example

Source: https://docs.wati.io/reference/post_api-ext-v3-salesanalytics-pipeline

This example shows the structure of a successful response containing sales pipeline data. It includes the win rate and a list of stages with their respective counts.

```json
{
  "win_rate": 20,
  "entries": [
    {
      "stage": "New Lead",
      "count": 150
    },
    {
      "stage": "Contacted",
      "count": 90
    },
    {
      "stage": "Qualified",
      "count": 80
    },
    {
      "stage": "Proposal",
      "count": 50
    },
    {
      "stage": "Deal Won",
      "count": 100
    },
    {
      "stage": "Deal Lost",
      "count": 30
    }
  ]
}
```

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

### Get Sales Pipeline Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-salesanalytics-pipeline

This example demonstrates the structure of a request to retrieve sales pipeline data. Dates should be in ISO 8601 UTC format. Agent and stage IDs are optional.

```json
{
  "from": "2025-12-30T02:50:13.5508281Z",
  "to": "2026-01-06T02:50:13.5508288Z",
  "agentIds": [
    "650a26c6f84a9c0dd6ad66e1",
    "650a26c6f84a9c0dd6ad66e2"
  ],
  "selectedStageIds": [
    "650a26c6f84a9c0dd6ad66e3",
    "650a26c6f84a9c0dd6ad66e4"
  ]
}
```

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

### Get Contacts API v3 Example

Source: https://docs.wati.io/reference/get_api-ext-v3-contacts

This example demonstrates how to retrieve a list of contacts using the GET /api/ext/v3/contacts endpoint. It includes query parameters for pagination.

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "API Documentation V3",
    "version": "v3"
  },
  "paths": {
    "/api/ext/v3/contacts": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "summary": "Get contacts",
        "parameters": [
          {
            "name": "page_number",
            "in": "query",
            "description": "Page number (1-based).",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "Number of items per page (max 100).",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the contact list.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetContactListResponse"
                },
                "example": {
                  "contact_list": [
                    {
                      "id": "507f1f77bcf86cd799439011",
                      "wa_id": "1234567890",
                      "name": "John Doe",
                      "phone": "+1234567890",
                      "photo": "https://example.com/photos/johndoe.jpg",
                      "created": "2024-01-15T10:30:00Z",
                      "last_updated": "2024-02-10T14:45:00Z",
                      "contact_status": "active",
                      "source": "manual",
                      "channel_id": "channel_123",
                      "ig_phone_source": "profile",
                      "mg_phone_source": "profile",
                      "opted_in": true,
                      "allow_broadcast": true,
                      "allow_sms": false,
                      "teams": [
                        "Team A",
                        "Team B"
                      ],
                      "segments": [],
                      "custom_params": [
                        {
                          "name": "customer_tier",
                          "value": "gold"
                        },
                        {
                          "name": "preferred_language",
                          "value": "en"
                        }
                      ],
                      "channel_type": "whatsapp",
                      "display_name": "John D.",
                      "contact_link": {
                        "whats_app_contact_id": "507f191e810c19729de860ec",
                        "instagram_contact_id": "507f191e810c19729de860ed",
                        "messenger_contact_id": "507f191e810c19729de860ee"
                      },
                      "is_broadcast_limit_reached": false
                    }
                  ],
                  "page_number": 1,
                  "page_size": 10
                }
              }
            }
          },
          "400": {
            "description": "The request is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "The request is unauthorized."
          },
          "403": {
            "description": "The request is forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenRequestResponse"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests. Either the rate limit has been exceeded or usage limits have been reached."
          },
          "500": {
            "description": "Unexpected error occurred. Please try again.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ContactDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the contact.",
            "nullable": true
          },
          "wa_id": {
            "type": "string",
            "description": "WhatsApp identifier for the contact.",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "The contact's name.",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "description": "The contact's phone number."
          }
        }
      }
    }
  }
}
```

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

### Webhook Endpoint Configuration Example

Source: https://docs.wati.io/reference/post_api-v2-webhookendpoints

This example demonstrates the structure of a webhook endpoint configuration object. It includes the phone number, status, URL, and the event types to subscribe to.

```json
{
  "phoneNumber": "1650-937-9611",
  "status": 0,
  "url": "https://google.com",
  "eventTypes": [
    "message"
  ]
}
```

```json
{
  "phoneNumber": "1978-949-8353",
  "status": 0,
  "url": "https://google.com",
  "eventTypes": [
    "message",
    "newContactMessageReceived"
  ]
}
```

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

### Add Contact Request Example (JSON)

Source: https://docs.wati.io/reference/post_api-ext-v3-contacts

Use this example to structure your request body when adding a new contact. It includes the WhatsApp number, name, and custom parameters.

```json
{
  "whatsapp_number": "1234567890",
  "name": "John Doe",
  "custom_params": [
    {
      "name": "age",
      "value": "30"
    },
    {
      "name": "city",
      "value": "New York"
    }
  ]
}
```

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

### Send Buttons Message Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-conversations-messages-interactive

Example of a request body to send a message with buttons. This includes header, body, footer, and button configurations.

```json
{
  "target": "65b73810e2bd04aa867b5f7d",
  "type": "buttons",
  "button_message": {
    "header": {
      "type": "image",
      "text": "Click a button",
      "media": {
        "url": "https://example.com/image.jpg",
        "file_name": "image.jpg"
      }
    },
    "body": "This is the main message body text",
    "footer": "Footer text here",
    "buttons": [
      {
        "text": "Button 1"
      },
      {
        "text": "Button 2"
      },
      {
        "text": "Button 3"
      }
    ]
  }
}
```

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

### Add Contact Response Example (JSON)

Source: https://docs.wati.io/reference/post_api-ext-v3-contacts

This is an example of a successful response when adding a contact. It returns the created contact's details, including its ID, WA ID, and custom parameters.

```json
{
  "id": "507f1f77bcf86cd799439011",
  "wa_id": "1234567890",
  "name": "John Doe",
  "phone": "+1234567890",
  "photo": "https://example.com/photos/johndoe.jpg",
  "created": "2024-01-15T10:30:00Z",
  "last_updated": "2024-02-10T14:45:00Z",
  "contact_status": "active",
  "source": "manual",
  "channel_id": "channel_123",
  "ig_phone_source": "profile",
  "mg_phone_source": "profile",
  "opted_in": true,
  "allow_broadcast": true,
  "allow_sms": false,
  "teams": [
    "Team A",
    "Team B"
  ],
  "segments": [],
  "custom_params": [
    {
      "name": "customer_tier",
      "value": "gold"
    },
    {
      "name": "preferred_language",
      "value": "en"
    }
  ],
  "channel_type": "whatsapp",
  "display_name": "John D.",
  "contact_link": {
    "whats_app_contact_id": "507f191e810c19729de860ec",
    "instagram_contact_id": "507f191e810c19729de860ed",
    "messenger_contact_id": "507f191e810c19729de860ee"
  },
  "is_broadcast_limit_reached": false
}
```

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

### cURL Example

Source: https://docs.wati.io/reference/authentication

Example of how to make an authenticated API request using cURL.

```APIDOC
```bash
curl --location 'https://live-mt-server.wati.io/xxxxxx/api/v1/getContacts' \
	--header 'Authorization: Bearer <your_api_token>' \
	--header 'Content-Type: application/json'
```
```

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

### Add Contact using Node.js

Source: https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber

This Node.js example uses the `axios` library to send a POST request to add a contact. Ensure you have `axios` installed (`npm install axios`). Replace placeholders with your API token and contact details.

```node
const axios = require('axios');

const whatsappNumber = '85264318721';
const apiToken = 'YOUR_API_TOKEN';

const url = `${WATI_API_ENDPOINT}/api/v1/addContact/${whatsappNumber}`;

const headers = {
    'Authorization': `Bearer ${apiToken}`,
    'Content-Type': 'application/json'
};

const data = {
    'name': 'John Doe',
    'customParams': [
        {
            'name': 'email',
            'value': 'john.doe@example.com'
        }
    ]
};

axios.post(url, data, { headers })
    .then(response => {
        console.log(response.status);
        console.log(response.data);
    })
    .catch(error => {
        console.error('Error adding contact:', error.response ? error.response.data : error.message);
    });
```

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

### Send List Message Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-conversations-messages-interactive

Example of a request body to send a message with a list. This includes header, body, footer, button text, and sections with rows.

```json
{
  "target": "65b73810e2bd04aa867b5f7d",
  "type": "list",
  "list_message": {
    "header": "Choose an option",
    "body": "Here is the body text",
    "footer": "Footer text",
    "button_text": "Select",
    "sections": [
      {
        "title": "Section 1",
        "rows": [
          {
            "title": "Title 1",
            "description": "Description 1"
          },
          {
            "title": "Title 2",
            "description": "Description 2"
          }
        ]
      },
      {
        "title": "Section 2",
        "rows": [
          {
            "title": "Title 3",
            "description": "Description 3"
          },
          {
            "title": "Title 4",
            "description": "Description 4"
          }
        ]
      }
    ]
  }
}
```

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

### Send File Message Response Example

Source: https://docs.wati.io/reference/post_api-ext-v3-conversations-messages-file

This example shows a successful response when a file message is sent. It includes details about the sent message, such as its content, timestamp, owner status, delivery status, and conversation ID.

```json
{
  "message": {
    "text": "Hello, this is a sample message!",
    "type": "text",
    "timestamp": "2026-01-06T02:50:13.4295333Z",
    "owner": true,
    "status": "delivered",
    "avatar_url": "https://example.com/avatar.png",
    "assigned_id": "6858f59a3374901cc1c8223f",
    "operator_name": "John Doe",
    "bot_type": "regular",
    "id": "507f1f77bcf86cd799439011",
    "created": "2026-01-06T02:50:13.4295331Z",
    "conversation_id": "685bd235e6119686e693a093",
    "ticket_id": "68aed3c93a050b3c53978463",
    "event_type": "message"
  }
}
```

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

### Schedule Template Messages Response Example (Success)

Source: https://docs.wati.io/reference/post_api-ext-v3-messagetemplates-schedule

This example shows a successful response after scheduling template messages. It includes a success status, broadcast ID, and a list of recipients with their status or errors.

```json
{
  "success": true,
  "broadcast_id": "broadcast_123456",
  "recipients": [
    {
      "local_message_id": "local-msg-123",
      "phone_number": "1234567890",
      "errors": [
        "Invalid phone number format."
      ]
    }
  ]
}
```

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

### Schedule Template Messages Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-messagetemplates-schedule

This example demonstrates the structure of a request to schedule template messages. It includes channel, template name, broadcast name, scheduled time, and recipient details with custom parameters.

```json
{
  "channel": "1234567890",
  "template_name": "welcome_template",
  "broadcast_name": "Welcome Campaign",
  "scheduled_at": "2024-12-25T10:00:00Z",
  "recipients": [
    {
      "phone_number": "1234567890",
      "local_message_id": "local-msg-123",
      "custom_params": [
        {
          "name": "first_name",
          "value": "John"
        }
      ]
    }
  ]
}
```

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

### Send Template Messages Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-messagetemplates-send

This example demonstrates the structure of a request to send template messages. It specifies the channel, template name, broadcast details, and recipient information including custom parameters.

```json
{
  "channel": "1234567890",
  "template_name": "welcome_template",
  "broadcast_name": "Welcome Campaign",
  "recipients": [
    {
      "phone_number": "1234567890",
      "local_message_id": "local-msg-123",
      "custom_params": [
        {
          "name": "first_name",
          "value": "John"
        }
      ]
    }
  ]
}
```

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

### Send File via URL Request Example

Source: https://docs.wati.io/reference/post_api-ext-v3-conversations-messages-fileviaurl

This example demonstrates the structure of a request to send a file message using a URL. It includes the target conversation ID, the file URL, and an optional caption.

```json
{
  "target": "65b73810e2bd04aa867b5f7d",
  "file_url": "https://example.com/example.jpg",
  "caption": "Example File"
}
```

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

### Update Contacts Request Example

Source: https://docs.wati.io/reference/put_api-ext-v3-contacts

This example shows the structure of a request body to update contacts. It includes the target contact ID and a list of custom parameters to be updated. Use this when modifying existing contact details.

```json
{
  "contacts": [
    {
      "target": "507f1f77bcf86cd799439011",
      "customParams": [
        {
          "name": "age",
          "value": "30"
        },
        {
          "name": "city",
          "value": "New York"
        }
      ]
    },
    {
      "target": "507f1f77bcf86cd799439012",
      "customParams": [
        {
          "name": "age",
          "value": "28"
        },
        {
          "name": "city",
          "value": "HongKong"
        }
      ]
    }
  ]
}
```

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

### Send Interactive Buttons Message - Node.js Example

Source: https://docs.wati.io/reference/post_api-v1-sendinteractivebuttonsmessage

This Node.js example shows how to send an interactive buttons message. It uses the 'axios' library for making the HTTP POST request. Remember to replace 'YOUR_API_TOKEN' and the 'whatsappNumber'.

```javascript
const axios = require('axios');

const url = 'https://api.wati.io/v1/sendInteractiveButtonsMessage';

const payload = {
    "body": "This is the body of the message",
    "footer": "This is the footer",
    "header": {
        "type": "Text",
        "text": "Header Text"
    },
    "buttons": [
        {
            "text": "Button 1"
        },
        {
            "text": "Button 2"
        },
        {
            "text": "Button 3"
        }
    ]
};

const params = {
    "whatsappNumber": "85264318721"
};

const headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
};

axios.post(url, payload, { params, headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error);
    });
```

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

### Send File Message Request Body Example

Source: https://docs.wati.io/reference/post_api-ext-v3-conversations-messages-file

This example demonstrates the structure of a request body for sending a file message. It includes the target conversation ID, the file details (content type, name, filename), and an optional caption.

```json
{
  "target": "65b73810e2bd04aa867b5f7d",
  "file": {
    "contentDisposition": "",
    "contentType": "image/jpeg",
    "headers": {
      "Content-Type": [
        "image/jpeg"
      ]
    },
    "length": 3,
    "name": "file",
    "fileName": "example.jpg"
  },
  "caption": "Example File"
}
```

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

### Send Interactive Buttons Message - C# Example

Source: https://docs.wati.io/reference/post_api-v1-sendinteractivebuttonsmessage

This C# example shows how to send an interactive buttons message using `HttpClient`. It serializes the message object to JSON and sends it as a POST request. Ensure your API token and whatsappNumber are correctly configured.

```csharp
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class MessageSender
{
    public static async Task SendButtonsMessageAsync()
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage
        {
            Method = HttpMethod.Post,
            RequestUri = new Uri("https://api.wati.io/v1/sendInteractiveButtonsMessage?whatsappNumber=85264318721"),
        };

        var message = new
        {
            body = "This is the body of the message",
            footer = "This is the footer",
            header = new {
                type = "Text",
                text = "Header Text"
            },
            buttons = new List<object>
            {
                new { text = "Button 1" },
                new { text = "Button 2" },
                new { text = "Button 3" }
            }
        };

        request.Content = new StringContent(JsonConvert.SerializeObject(message), Encoding.UTF8, "application/json");
        request.Headers.Add("Authorization", "Bearer YOUR_API_TOKEN");

        HttpResponseMessage response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();
        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }

    public static void Main(string[] args)
    {
        SendButtonsMessageAsync().GetAwaiter().GetResult();
    }
}

```

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

### Start Chatbot

Source: https://docs.wati.io/reference/post_api-ext-v3-chatbots-start

Initiates a chatbot conversation with a specified target.

```APIDOC
## POST /api/v3/chatbots/start

### Description
Starts a chatbot conversation with a target recipient.

### Method
POST

### Endpoint
/api/v3/chatbots/start

### Request Body
- **chatbot_id** (string) - Required - The ID of the chatbot to start.
- **target** (string) - Required - The target recipient in one of the following formats:
    * `ContactId`: The unique ID of a contact.
    * `PhoneNumber`: The recipient's phone number (e.g., `14155552671`).
    * `Channel:ContactId`: A combination of the channel (name or phone number) and the recipient's phone number (e.g., `MyChannel:65b73810e2bd04aa867b5f7d`, `123456789:65b73810e2bd04aa867b5f7d`).
    * `Channel:PhoneNumber`: A combination of the channel (name or phone number) and the recipient's phone number (e.g., `MyChannel:1415552671`, `123456789:1415552671`).

### Request Example
{
  "chatbot_id": "your_chatbot_id",
  "target": "your_target_identifier"
}

### Response
#### Success Response (200)
- **result** (boolean) - Indicates whether the chatbot start operation was successful.
```

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

### Get Lead Stages

Source: https://docs.wati.io/reference/get_api-ext-v3-salesanalytics-leadstages

Retrieves the list of lead stages.

```APIDOC
## GET /api-ext/v3/salesanalytics/leadstages

### Description
Returns the list of lead stages.

### Method
GET

### Endpoint
/api-ext/v3/salesanalytics/leadstages

### Response
#### Success Response (200)
- **stages** (array) - A list of lead stage objects.
  - **id** (integer) - The unique identifier for the lead stage.
  - **name** (string) - The name of the lead stage.
  - **order** (integer) - The order in which the stage appears in the funnel.
  - **is_default** (boolean) - Indicates if this is the default lead stage.
  - **is_active** (boolean) - Indicates if the lead stage is currently active.
```

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

### Update Conversation Status Request Body Example

Source: https://docs.wati.io/reference/put_api-ext-v3-conversations-target-status

This example shows the structure of the request body for updating a conversation's status. It requires a `new_status` field.

```json
{
  "new_status": "open"
}
```

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

### Send Interactive Buttons Message - Go Example

Source: https://docs.wati.io/reference/post_api-v1-sendinteractivebuttonsmessage

This Go program demonstrates how to send an interactive buttons message using the `net/http` package. It constructs the JSON payload and sends a POST request to the API. Remember to replace placeholders.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
)

func main() {
	url := "https://api.wati.io/v1/sendInteractiveButtonsMessage?whatsappNumber=85264318721"

	payload := map[string]interface{}{
		"body": "This is the body of the message",
		"footer": "This is the footer",
		"header": map[string]string{
			"type": "Text",
			"text": "Header Text",
		},
		"buttons": []map[string]string{
			{"text": "Button 1"},
			{"text": "Button 2"},
			{"text": "Button 3"},
		},
	}

	jsonPayload, err := json.Marshal(payload)
	if err != nil {
		log.Fatalf("Error marshaling JSON: %v", err)
	}

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonPayload))
	if err != nil {
		log.Fatalf("Error creating request: %v", err)
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		log.Fatalf("Error sending request: %v", err)
	}
	defer resp.Body.Close()

	fmt.Println("Status Code:", resp.StatusCode)

	// You can read the response body here if needed
}

```

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

### Get Broadcast Recipients

Source: https://docs.wati.io/reference/get_api-ext-v3-broadcasts-broadcast-id-recipients

This endpoint allows you to retrieve all recipients associated with a specific broadcast campaign. You need to provide the broadcast ID to get the list of recipients.

```APIDOC
## GET /api-ext/v3/broadcasts/{broadcastId}/recipients

### Description
Retrieves the list of recipients for a given broadcast campaign ID.

### Method
GET

### Endpoint
/api-ext/v3/broadcasts/{broadcastId}/recipients

### Parameters
#### Path Parameters
- **broadcastId** (string) - Required - The unique identifier of the broadcast campaign.
```

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

### Start Chatbot

Source: https://docs.wati.io/reference/post_api-v1-chatbots-start

Initiates a chatbot for a given WhatsApp number and chatbot ID.

```APIDOC
## POST /api/v1/chatbots/start

### Description
Starts a chatbot for a given WhatsApp number and chatbot ID.

### Method
POST

### Endpoint
/api/v1/chatbots/start

### Parameters
#### Query Parameters
- **whatsappNumber** (string) - Required - WhatsApp Number with country code. Example, 85264318721
- **chatbotId** (string) - Required - Chatbot Id

### Response
#### Success Response (200)
- **result** (boolean) - Result status of starting the chatbot. Returns 'true' when the chatbot is started successfully.

#### Response Example
{
  "result": true
}
```

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

### Add Contact using C#

Source: https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber

This C# example uses `HttpClient` to send a POST request for adding a contact. Ensure you are using a compatible .NET version. Replace placeholders with your API token and contact details.

```csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

public class AddContact
{
    public static async Task Main(string[] args)
    {
        string whatsappNumber = "85264318721";
        string apiToken = "YOUR_API_TOKEN";
        string watiApiEndpoint = "{WATI_API_ENDPOINT}"; // Replace with your WATI API endpoint

        string url = $"{watiApiEndpoint}/api/v1/addContact/{whatsappNumber}";

        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiToken}");

            var payload = new
            {
                name = "John Doe",
                customParams = new[]
                {
                    new { name = "email", value = "john.doe@example.com" }
                }
            };

            string jsonPayload = System.Text.Json.JsonSerializer.Serialize(payload);
            var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");

            try
            {
                HttpResponseMessage response = await client.PostAsync(url, content);
                string responseBody = await response.Content.ReadAsStringAsync();

                Console.WriteLine($"Status Code: {response.StatusCode}");
                Console.WriteLine($"Response Body: {responseBody}");
            }
            catch (Exception e)
            {
                Console.WriteLine($"Error: {e.Message}");
            }
        }
    }
}
```

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

### Update Contact Attributes for Multiple Contacts Response Example

Source: https://docs.wati.io/reference/post_api-v1-updatecontactattributesformulticontacts

This example shows a successful response from the API when updating contact attributes for multiple contacts. The 'result' field indicates whether the operation was successful.

```json
{
  "result": true
}
```

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

### Authentication Header Example

Source: https://docs.wati.io/reference/authentication

All API requests must include the Authorization and Content-Type headers. Replace `<your_api_token>` with your actual token.

```APIDOC
## GET https://live-mt-server.wati.io/xxxxxx/api/v1/getContacts

### Description
This is an example of a GET request to retrieve contacts, demonstrating the required authentication headers.

### Method
GET

### Endpoint
https://live-mt-server.wati.io/xxxxxx/api/v1/getContacts

### Headers
- `Authorization`: `Bearer <your_api_token>`
- `Content-Type`: `application/json`

### Request Example
```http
GET https://live-mt-server.wati.io/xxxxxx/api/v1/getContacts

	Authorization: Bearer eyJhbGciOiJIUzI1....... 
	Content-Type: application/json
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

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

### Add Contact using Java

Source: https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber

This Java example uses Apache HttpClient to send a POST request for adding a contact. Ensure you have the `httpclient` dependency added to your project. Replace placeholders with your API token and contact details.

```java
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class AddContact {

    public static void main(String[] args) {
        String whatsappNumber = "85264318721";
        String apiToken = "YOUR_API_TOKEN";
        String watiApiEndpoint = "{WATI_API_ENDPOINT}"; // Replace with your WATI API endpoint

        String url = watiApiEndpoint + "/api/v1/addContact/" + whatsappNumber;

        try (CloseableHttpClient client = HttpClients.createDefault()) {
            HttpPost request = new HttpPost(url);

            // Set headers
            request.setHeader("Authorization", "Bearer " + apiToken);
            request.setHeader("Content-Type", "application/json");

            // Create JSON payload
            String jsonPayload = "{\"name\": \"John Doe\", \"customParams\": [{\"name\": \"email\", \"value\": \"john.doe@example.com\"}]}";
            StringEntity entity = new StringEntity(jsonPayload);
            request.setEntity(entity);

            // Execute request
            try (CloseableHttpResponse response = client.execute(request)) {
                System.out.println("Status Code: " + response.getStatusLine().getStatusCode());
                HttpEntity responseEntity = response.getEntity();
                if (responseEntity != null) {
                    String responseString = EntityUtils.toString(responseEntity);
                    System.out.println("Response Body: " + responseString);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
```

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

### Get WhatsApp Message by Local ID (Java)

Source: https://docs.wati.io/reference/get_api-v1-whatsapp-messages-phonenumber-localmessageid

Use Java to get a specific WhatsApp message by providing the channel phone number and the message's local ID. The phone number must include the country code.

```java
import okhttp3.*; 
import java.io.IOException;

public class GetMessage {
    public static void main(String[] args) {
        String apiEndpoint = "{WATI_API_ENDPOINT}";
        String apiToken = "YOUR_API_TOKEN";
        String phoneNumber = "85264318721"; // Example: 85264318721
        String localMessageId = "ba65a768-5148-6172-812c-b01877a8c818"; // Example: ba65a768-5148-6172-812c-b01877a8c818

        OkHttpClient client = new OkHttpClient().newBuilder().build();
        Request request = new Request.Builder()
          .url(String.format("%s/api/v1/whatsapp/messages/%s/%s", apiEndpoint, phoneNumber, localMessageId))
          .addHeader("Authorization", "Bearer " + apiToken)
          .addHeader("Accept", "application/json")
          .build();

        try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
```

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

### Add Contact using Go

Source: https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber

This Go code snippet shows how to make a POST request to add a contact. It includes setting the necessary headers and JSON payload. Remember to replace `YOUR_API_TOKEN` with your actual token.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	whatsappNumber := "85264318721"
	apiToken := "YOUR_API_TOKEN"

	url := fmt.Sprintf("%s/api/v1/addContact/%s", WATI_API_ENDPOINT, whatsappNumber)

	payload := map[string]interface{}{
		"name": "John Doe",
		"customParams": []map[string]string{
			{"name": "email", "value": "john.doe@example.com"}
		}
	}

	jsonPayload, err := json.Marshal(payload)
	if err != nil {
		fmt.Println("Error marshalling JSON:", err)
		return
	}

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonPayload))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Set("Authorization", "Bearer "+apiToken)
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}

	defer res.Body.Close()

	var result map[string]interface{}
	json.NewDecoder(res.Body).Decode(&result)

	fmt.Println(res.StatusCode)
	fmt.Println(result)
}
```

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

### Get Lead Stages API Definition

Source: https://docs.wati.io/reference/get_api-ext-v3-salesanalytics-leadstages

This OpenAPI definition describes the GET endpoint for retrieving lead stages. It includes the request path, summary, description, and possible responses, detailing the structure of the successful response and common error scenarios.

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "API Documentation V3",
    "version": "v3"
  },
  "paths": {
    "/api/ext/v3/salesAnalytics/leadStages": {
      "get": {
        "tags": [
          "SalesAnalytics"
        ],
        "summary": "Get lead stages",
        "description": "Returns the list of lead stages.",
        "responses": {
          "200": {
            "description": "Returns the lead stages.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetLeadStagesResponse"
                },
                "example": {
                  "stages": [
                    {
                      "id": "new-lead",
                      "label": "New Lead",
                      "color": "#659E9E",
                      "sort_order": 1
                    },
                    {
                      "id": "contacted",
                      "label": "Contacted",
                      "color": "#E6BC45",
                      "sort_order": 2
                    },
                    {
                      "id": "qualified",
                      "label": "Qualified",
                      "color": "#D97A4F",
                      "sort_order": 3
                    },
                    {
                      "id": "proposal-sent",
                      "label": "Proposal Sent",
                      "color": "#8D84C1",
                      "sort_order": 4
                    },
                    {
                      "id": "deal-won",
                      "label": "Deal Won",
                      "color": "#C378DC",
                      "sort_order": 5
                    },
                    {
                      "id": "deal-lost",
                      "label": "Deal Lost",
                      "color": "#D17373",
                      "sort_order": 6
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "The request is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "The request is unauthorized."
          },
          "403": {
            "description": "The request is forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenRequestResponse"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests. Either the rate limit has been exceeded or usage limits have been reached."
          },
          "500": {
            "description": "Unexpected error occurred. Please try again.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnexpectedErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ForbiddenRequestResponse": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "The error code associated with the error.",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "The descriptive error message explaining what went wrong.",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "description": "The timestamp indicating when the error was recorded.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Represents the result of a forbidden request, containing error details."
      },
      "GetLeadStagesResponse": {
        "type": "object",
        "properties": {
          "stages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LeadStageItemDto"
            },
            "description": "The list of lead stages.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Response model for getting lead stages."
      },
      "InvalidRequestResponse": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "The error code associated with the error.",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "The descriptive error message explaining what went wrong.",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "description": "The timestamp indicating when the error was recorded.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Represents the result of an invalid request, containing error details."
      },
      "LeadStageItemDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the lead stage."
          },
          "label": {
            "type": "string",
            "description": "The display name of the lead stage."
          },
          "color": {
            "type": "string",
            "description": "The color associated with the lead stage, in hex format."
          },
          "sort_order": {
            "type": "integer",
            "description": "The order in which the lead stage should be displayed.",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Represents a single lead stage item."
      },
      "UnexpectedErrorResponse": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "The error code associated with the error.",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "The descriptive error message explaining what went wrong.",
            "nullable": true
          },
          "timestamp": {
            "type": "string",
            "description": "The timestamp indicating when the error was recorded.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Represents the result of an unexpected error, containing error details."
      }
    }
  }
}
```
Tokens:
Raw