Wappi.pro Telegram API

https://wappi.pro/telegram-api-documentation
Admin
Wappi.pro Telegram API provides tools for businesses to integrate and automate communication via...
Tokens:17,534
Snippets:42
Trust Score:7.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Webhook for Incoming Videos

Source: https://wappi.pro/telegram-api-documentation/index

This webhook handles incoming video messages. Videos are provided in base64 format. The payload includes message details, type as 'video', and base64 encoded video data in the 'body' field, along with file metadata like filename, mimetype, and optional caption.

```json
{
  "messages": [
    {
      "id": "5904",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:18:38+03:00",
      "time": 1742213918,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "video",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Sinn",
      "chatId": "60227586",
      "caption": "Подпись",
      "from_where": "phone",
      "file_name": "video.mp4",
      "mimetype": "video/mp4",
      "contact_name": "Sinn",
      "contact_phone": "",
      "contact_username": "sinay",
      "username": "sinay",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
      "file_link_expire": 1742473119
    }
  ]
}
```

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

### Proxy Management API

Source: https://wappi.pro/telegram-api-documentation/index

This section covers methods for managing proxy settings.

```APIDOC
## GET /tapi/proxy/get

### Description
Retrieves the current proxy settings.

### Method
GET

### Endpoint
/tapi/proxy/get

### Parameters
None

### Response
#### Success Response (200)
- **proxy** (object) - The proxy configuration.
  - **host** (string) - The proxy host.
  - **port** (integer) - The proxy port.
  - **type** (string) - The proxy type (e.g., "http", "socks5").

#### Response Example
```json
{
  "proxy": {
    "host": "proxy.example.com",
    "port": 8080,
    "type": "http"
  }
}
```

## POST /tapi/proxy/set

### Description
Sets or updates the proxy configuration.

### Method
POST

### Endpoint
/tapi/proxy/set

### Parameters
#### Request Body
- **host** (string) - Required - The proxy host.
- **port** (integer) - Required - The proxy port.
- **type** (string) - Required - The proxy type (e.g., "http", "socks5").

### Request Example
```json
{
  "host": "new-proxy.example.com",
  "port": 3128,
  "type": "socks5"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /tapi/proxy/delete

### Description
Deletes the current proxy configuration.

### Method
POST

### Endpoint
/tapi/proxy/delete

### Parameters
None

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Webhook for Incoming Document or File

Source: https://wappi.pro/telegram-api-documentation/index

Receives notifications for incoming documents or files. File data is provided in base64 format.

```APIDOC
## POST /webhooks/incoming-document

### Description
Receives notifications for incoming documents or files. File data is provided in base64 format.

### Method
POST

### Endpoint
`/webhooks/incoming-document`

### Request Body
#### messages (array of objects) - Required
- **id** (string) - Unique message identifier.
- **profile_id** (string) - Identifier for the profile.
- **wh_type** (string) - Type of webhook, should be "incoming_message".
- **timestamp** (string) - ISO 8601 timestamp of the event.
- **time** (integer) - Unix timestamp of the event.
- **body** (string) - The file data in base64 format.
- **type** (string) - Type of message, should be "document".
- **from** (string) - Sender's identifier.
- **to** (string) - Recipient's identifier.
- **senderName** (string) - Name of the sender.
- **chatId** (string) - Identifier for the chat.
- **caption** (string) - Caption for the document.
- **from_where** (string) - Source of the message (e.g., "phone").
- **file_name** (string) - Name of the file.
- **mimetype** (string) - MIME type of the file (e.g., "application/pdf").
- **contact_name** (string) - Name of the contact.
- **contact_phone** (string) - Phone number of the contact.
- **contact_username** (string) - Username of the contact.
- **username** (string) - Username of the sender.
- **is_forwarded** (boolean) - Indicates if the message was forwarded.
- **isReply** (boolean) - Indicates if the message is a reply.
- **is_edited** (boolean) - Indicates if the message was edited.
- **stanza_id** (string) - Stanza ID of the message.
- **is_me** (boolean) - Indicates if the message is from the current user.
- **chat_type** (string) - Type of chat (e.g., "user").
- **thumbnail** (string) - URL of the thumbnail.
- **picture** (string) - URL of the picture.
- **wappi_bot_id** (string) - Wappi bot ID.
- **is_deleted** (boolean) - Indicates if the message was deleted.
- **is_bot** (boolean) - Indicates if the sender is a bot.
- **file_link** (string) - URL to the file.
- **file_link_expire** (integer) - Expiration timestamp for the file link.

### Request Example
```json
{
  "messages": [
    {
      "id": "5916",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:38:57+03:00",
      "time": 1742215137,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "document",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Minay",
      "chatId": "60227586",
      "caption": "",
      "from_where": "phone",
      "file_name": "document.pdf",
      "mimetype": "application/pdf",
      "contact_name": "",
      "contact_phone": "",
      "contact_username": "",
      "username": "",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
      "file_link_expire": 1742475537
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the webhook reception.

#### Response Example
```json
{
  "status": "ok"
}
```
```

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

### Webhook for Incoming Documents or Files

Source: https://wappi.pro/telegram-api-documentation/index

This webhook handles incoming documents and files. These are provided in base64 format. The payload includes message details, type as 'document', and base64 encoded file data in the 'body' field, along with file metadata like filename and mimetype.

```json
{
  "messages": [
    {
      "id": "5916",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:38:57+03:00",
      "time": 1742215137,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "document",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Minay"
    }
  ]
}
```

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

### Webhook for Incoming Video

Source: https://wappi.pro/telegram-api-documentation/index

Receives notifications for incoming videos. Video data is provided in base64 format.

```APIDOC
## POST /webhooks/incoming-video

### Description
Receives notifications for incoming videos. Video data is provided in base64 format.

### Method
POST

### Endpoint
`/webhooks/incoming-video`

### Request Body
#### messages (array of objects) - Required
- **id** (string) - Unique message identifier.
- **profile_id** (string) - Identifier for the profile.
- **wh_type** (string) - Type of webhook, should be "incoming_message".
- **timestamp** (string) - ISO 8601 timestamp of the event.
- **time** (integer) - Unix timestamp of the event.
- **body** (string) - The video data in base64 format.
- **type** (string) - Type of message, should be "video".
- **from** (string) - Sender's identifier.
- **to** (string) - Recipient's identifier.
- **senderName** (string) - Name of the sender.
- **chatId** (string) - Identifier for the chat.
- **caption** (string) - Caption for the video.
- **from_where** (string) - Source of the message (e.g., "phone").
- **file_name** (string) - Name of the video file.
- **mimetype** (string) - MIME type of the video (e.g., "video/mp4").
- **contact_name** (string) - Name of the contact.
- **contact_phone** (string) - Phone number of the contact.
- **contact_username** (string) - Username of the contact.
- **username** (string) - Username of the sender.
- **is_forwarded** (boolean) - Indicates if the message was forwarded.
- **isReply** (boolean) - Indicates if the message is a reply.
- **is_edited** (boolean) - Indicates if the message was edited.
- **stanza_id** (string) - Stanza ID of the message.
- **is_me** (boolean) - Indicates if the message is from the current user.
- **chat_type** (string) - Type of chat (e.g., "user").
- **thumbnail** (string) - URL of the thumbnail.
- **picture** (string) - URL of the picture.
- **wappi_bot_id** (string) - Wappi bot ID.
- **is_deleted** (boolean) - Indicates if the message was deleted.
- **is_bot** (boolean) - Indicates if the sender is a bot.
- **file_link** (string) - URL to the file.
- **file_link_expire** (integer) - Expiration timestamp for the file link.

### Request Example
```json
{
  "messages": [
    {
      "id": "5904",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:18:38+03:00",
      "time": 1742213918,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "video",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Sinn",
      "chatId": "60227586",
      "caption": "Подпись",
      "from_where": "phone",
      "file_name": "video.mp4",
      "mimetype": "video/mp4",
      "contact_name": "Sinn",
      "contact_phone": "",
      "contact_username": "sinay",
      "username": "sinay",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
      "file_link_expire": 1742473119
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the webhook reception.

#### Response Example
```json
{
  "status": "ok"
}
```
```

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

### Bulk Sending API

Source: https://wappi.pro/telegram-api-documentation/index

Methods for managing the 'Message Broadcast' tool, which allows for mass message sending.

```APIDOC
## POST /broadcast/init

### Description
Initiates a bulk message sending campaign.

### Method
POST

### Endpoint
/broadcast/init

### Parameters
#### Request Body
- **campaign_name** (string) - Required - The name of the campaign.
- **message_text** (string) - Required - The text content of the message to send.
- **recipients** (array) - Required - A list of recipient IDs or phone numbers.

### Request Example
```json
{
  "campaign_name": "October Promo",
  "message_text": "Special offer for October!",
  "
```

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

### Webhook for Application Status

Source: https://wappi.pro/telegram-api-documentation/index

Receives notifications about the status of the application.

```APIDOC
## POST /webhooks/application-status

### Description
Receives notifications about the status of the application.

### Method
POST

### Endpoint
`/webhooks/application-status`

### Request Body
#### messages (array of objects) - Required
- **wh_type** (string) - Type of webhook, should be "application_status".
- **profile_id** (string) - Identifier for the profile.
- **status** (string) - Application status (e.g., "online", "offline").
- **phone** (string) - The phone number associated with the profile.
- **timestamp** (string) - ISO 8601 timestamp of the event.
- **time** (integer) - Unix timestamp of the event.

### Request Example
```json
{
  "messages": [
    {
      "wh_type": "application_status",
      "profile_id": "fae370e3-0a1a",
      "status": "online",
      "phone": "966507585521",
      "timestamp": "2024-03-02T15:52:27.996591556+03:00",
      "time": 1709383947
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the webhook reception.

#### Response Example
```json
{
  "status": "ok"
}
```
```

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

### Webhook for Incoming Image

Source: https://wappi.pro/telegram-api-documentation/index

Receives notifications for incoming images. Image data is provided in base64 format.

```APIDOC
## POST /webhooks/incoming-image

### Description
Receives notifications for incoming images. Image data is provided in base64 format.

### Method
POST

### Endpoint
`/webhooks/incoming-image`

### Request Body
#### messages (array of objects) - Required
- **id** (string) - Unique message identifier.
- **profile_id** (string) - Identifier for the profile.
- **wh_type** (string) - Type of webhook, should be "incoming_message".
- **timestamp** (string) - ISO 8601 timestamp of the event.
- **time** (integer) - Unix timestamp of the event.
- **body** (string) - The image data in base64 format.
- **type** (string) - Type of message, should be "image".
- **from** (string) - Sender's identifier.
- **to** (string) - Recipient's identifier.
- **senderName** (string) - Name of the sender.
- **chatId** (string) - Identifier for the chat.
- **caption** (string) - Caption for the image.
- **from_where** (string) - Source of the message (e.g., "phone").
- **mimetype** (string) - MIME type of the image (e.g., "image/jpeg").
- **contact_name** (string) - Name of the contact.
- **contact_phone** (string) - Phone number of the contact.
- **contact_username** (string) - Username of the contact.
- **username** (string) - Username of the sender.
- **is_forwarded** (boolean) - Indicates if the message was forwarded.
- **isReply** (boolean) - Indicates if the message is a reply.
- **is_edited** (boolean) - Indicates if the message was edited.
- **stanza_id** (string) - Stanza ID of the message.
- **is_me** (boolean) - Indicates if the message is from the current user.
- **chat_type** (string) - Type of chat (e.g., "user").
- **thumbnail** (string) - URL of the thumbnail.
- **picture** (string) - URL of the picture.
- **wappi_bot_id** (string) - Wappi bot ID.
- **is_deleted** (boolean) - Indicates if the message was deleted.
- **is_bot** (boolean) - Indicates if the sender is a bot.
- **file_link** (string) - URL to the file.
- **file_link_expire** (integer) - Expiration timestamp for the file link.

### Request Example
```json
{
  "messages": [
    {
      "id": "5903",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:16:03+03:00",
      "time": 1742213763,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "image",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Sinn",
      "chatId": "60227586",
      "caption": "Подпись",
      "from_where": "phone",
      "mimetype": "image/jpeg",
      "contact_name": "Sinn",
      "contact_phone": "",
      "contact_username": "sinay",
      "username": "sinay",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
      "file_link_expire": 1742472963
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the webhook reception.

#### Response Example
```json
{
  "status": "ok"
}
```
```

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

### Message Queue Management API

Source: https://wappi.pro/telegram-api-documentation/index

This section covers methods for managing message queues and tasks.

```APIDOC
## GET /tapi/profile/queue/get

### Description
Retrieves the message queue for a profile.

### Method
GET

### Endpoint
/tapi/profile/queue/get

### Parameters
None

### Response
#### Success Response (200)
- **queue** (array) - A list of messages in the queue.
  - **message_id** (string) - The ID of the message.
  - **status** (string) - The status of the message.

#### Response Example
```json
{
  "queue": [
    {
      "message_id": "msg_q123",
      "status": "pending"
    }
  ]
}
```

## GET /tapi/profile/queue/purge

### Description
Clears the message queue for a profile.

### Method
GET

### Endpoint
/tapi/profile/queue/purge

### Parameters
None

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## GET /tapi/task/get

### Description
Retrieves data for a specific task.

### Method
GET

### Endpoint
/tapi/task/get

### Parameters
#### Query Parameters
- **task_id** (string) - Required - The ID of the task.

### Request Example
```json
{
  "task_id": "task_abc123"
}
```

### Response
#### Success Response (200)
- **task_data** (object) - The data associated with the task.

#### Response Example
```json
{
  "task_data": {
    "id": "task_abc123",
    "status": "completed",
    "result": "..."
  }
}
```

## GET /tapi/tasks/get

### Description
Retrieves data for all tasks.

### Method
GET

### Endpoint
/tapi/tasks/get

### Parameters
None

### Response
#### Success Response (200)
- **tasks** (array) - A list of task objects.
  - **task_id** (string) - The ID of the task.
  - **status** (string) - The status of the task.

#### Response Example
```json
{
  "tasks": [
    {
      "task_id": "task_abc123",
      "status": "completed"
    },
    {
      "task_id": "task_def456",
      "status": "pending"
    }
  ]
}
```
```

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

### Webhook for Incoming Images

Source: https://wappi.pro/telegram-api-documentation/index

This webhook handles incoming image messages. Images are provided in base64 format. The payload includes message details, type as 'image', and base64 encoded image data in the 'body' field, along with file metadata like mimetype and optional caption.

```json
{
  "messages": [
    {
      "id": "5903",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:16:03+03:00",
      "time": 1742213763,
      "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
      "type": "image",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Sinn",
      "chatId": "60227586",
      "caption": "Подпись",
      "from_where": "phone",
      "mimetype": "image/jpeg",
      "contact_name": "Sinn",
      "contact_phone": "",
      "contact_username": "sinay",
      "username": "sinay",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
      "file_link_expire": 1742472963
    }
  ]
}
```

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

### Asynchronous Message Sending API

Source: https://wappi.pro/telegram-api-documentation/index

This section details the asynchronous methods for sending various types of messages, including text, images, documents, audio, video, media via URL, location, contacts, forwarding messages, and replying to messages.

```APIDOC
## POST /tapi/async/message/send

### Description
Sends a text message asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the message to.
- **text** (string) - Required - The text content of the message.

### Request Example
```json
{
  "chat_id": "123456789",
  "text": "Hello, this is an asynchronous message!"
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_abc123",
  "status": "sent"
}
```

## POST /tapi/async/message/img/send

### Description
Sends an image (base64 encoded) asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/img/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the image to.
- **image_base64** (string) - Required - The image data encoded in base64.
- **caption** (string) - Optional - The caption for the image.

### Request Example
```json
{
  "chat_id": "123456789",
  "image_base64": "/9j/4AAQSkZJRgABAQEASABIAAD...",
  "caption": "An example image."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_def456",
  "status": "sent"
}
```

## POST /tapi/async/message/document/send

### Description
Sends a document (base64 encoded) asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/document/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the document to.
- **document_base64** (string) - Required - The document data encoded in base64.
- **file_name** (string) - Required - The name of the file.
- **caption** (string) - Optional - The caption for the document.

### Request Example
```json
{
  "chat_id": "123456789",
  "document_base64": "JVBERi0xLjQKJc...",
  "file_name": "example.pdf",
  "caption": "A sample document."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_ghi789",
  "status": "sent"
}
```

## POST /tapi/async/message/video/send

### Description
Sends a video (base64 encoded) asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/video/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the video to.
- **video_base64** (string) - Required - The video data encoded in base64.
- **caption** (string) - Optional - The caption for the video.

### Request Example
```json
{
  "chat_id": "123456789",
  "video_base64": "/9j/4AAQSkZJRgABAQEASABIAAD...",
  "caption": "A short video clip."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_jkl012",
  "status": "sent"
}
```

## POST /tapi/async/message/audio/send

### Description
Sends an audio file (base64 encoded) asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/audio/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the audio to.
- **audio_base64** (string) - Required - The audio data encoded in base64.
- **caption** (string) - Optional - The caption for the audio.

### Request Example
```json
{
  "chat_id": "123456789",
  "audio_base64": "RIFF...",
  "caption": "A voice note."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_mno345",
  "status": "sent"
}
```

## POST /tapi/async/message/file/url/send

### Description
Sends media from a URL asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/file/url/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the media to.
- **url** (string) - Required - The URL of the media file.
- **caption** (string) - Optional - The caption for the media.

### Request Example
```json
{
  "chat_id": "123456789",
  "url": "http://example.com/media.jpg",
  "caption": "Media from a URL."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_pqr678",
  "status": "sent"
}
```

## POST /tapi/async/message/location/send

### Description
Sends a location asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/location/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the location to.
- **latitude** (number) - Required - The latitude of the location.
- **longitude** (number) - Required - The longitude of the location.
- **title** (string) - Optional - The title of the location.
- **address** (string) - Optional - The address of the location.

### Request Example
```json
{
  "chat_id": "123456789",
  "latitude": 40.7128,
  "longitude": -74.0060,
  "title": "New York City",
  "address": "New York, NY, USA"
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_stu901",
  "status": "sent"
}
```

## POST /tapi/async/contact/send

### Description
Sends a contact asynchronously.

### Method
POST

### Endpoint
/tapi/async/contact/send

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to send the contact to.
- **phone_number** (string) - Required - The phone number of the contact.
- **first_name** (string) - Required - The first name of the contact.
- **last_name** (string) - Optional - The last name of the contact.

### Request Example
```json
{
  "chat_id": "123456789",
  "phone_number": "+1234567890",
  "first_name": "John",
  "last_name": "Doe"
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.
- **status** (string) - The status of the message sending operation.

#### Response Example
```json
{
  "message_id": "msg_vwx234",
  "status": "sent"
}
```

## POST /tapi/async/message/forward

### Description
Forwards a message asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/forward

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to forward the message to.
- **from_chat_id** (string) - Required - The ID of the chat from which to forward the message.
- **message_id** (string) - Required - The ID of the message to forward.

### Request Example
```json
{
  "chat_id": "987654321",
  "from_chat_id": "123456789",
  "message_id": "msg_abc123"
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the forwarded message.
- **status** (string) - The status of the message forwarding operation.

#### Response Example
```json
{
  "message_id": "msg_yza567",
  "status": "forwarded"
}
```

## POST /tapi/async/message/reply

### Description
Replies to a message asynchronously.

### Method
POST

### Endpoint
/tapi/async/message/reply

### Parameters
#### Query Parameters
- **chat_id** (string) - Required - The ID of the chat to reply in.
- **reply_to_message_id** (string) - Required - The ID of the message to reply to.
- **text** (string) - Required - The text content of the reply.

### Request Example
```json
{
  "chat_id": "123456789",
  "reply_to_message_id": "msg_abc123",
  "text": "This is a reply."
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the reply message.
- **status** (string) - The status of the reply message sending operation.

#### Response Example
```json
{
  "message_id": "msg_bcd890",
  "status": "replied"
}
```
```

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

### Webhook Management API

Source: https://wappi.pro/telegram-api-documentation/index

This section covers methods for managing webhook URLs and notification types.

```APIDOC
## GET /tapi/webhook/url/get

### Description
Retrieves the currently set webhook URL.

### Method
GET

### Endpoint
/tapi/webhook/url/get

### Parameters
None

### Response
#### Success Response (200)
- **webhook_url** (string) - The configured webhook URL.

#### Response Example
```json
{
  "webhook_url": "https://your-domain.com/webhook"
}
```

## POST /tapi/webhook/url/set

### Description
Sets or updates the webhook URL.

### Method
POST

### Endpoint
/tapi/webhook/url/set

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL to set as the webhook.

### Request Example
```json
{
  "webhook_url": "https://your-domain.com/new-webhook"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /tapi/webhook/url/delete

### Description
Deletes the currently set webhook URL.

### Method
POST

### Endpoint
/tapi/webhook/url/delete

### Parameters
None

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /tapi/webhook/types/set

### Description
Configures the types of webhook notifications to receive.

### Method
POST

### Endpoint
/tapi/webhook/types/set

### Parameters
#### Request Body
- **notification_types** (array) - Required - A list of notification types to enable.
  - **type** (string) - The type of notification (e.g., "message", "chat_update").

### Request Example
```json
{
  "notification_types": ["message", "new_chat"]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Webhook for Application Status Updates

Source: https://wappi.pro/telegram-api-documentation/index

This webhook provides updates on the status of the application. It can indicate statuses like 'online'. The payload includes the profile ID, status, phone number, and timestamps.

```json
{
  "messages": [
    {
      "wh_type": "application_status",
      "profile_id": "fae370e3-0a1a",
      "status": "online",
      "phone": "966507585521",
      "timestamp": "2024-03-02T15:52:27.996591556+03:00",
      "time": 1709383947
    }
  ]
}
```

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

### Synchronous Contact Management API

Source: https://wappi.pro/telegram-api-documentation/index

This section outlines synchronous methods for retrieving, adding, and managing contacts.

```APIDOC
## GET /tapi/sync/contacts/get

### Description
Retrieves a list of contacts synchronously.

### Method
GET

### Endpoint
/tapi/sync/contacts/get

### Parameters
None

### Response
#### Success Response (200)
- **contacts** (array) - A list of contact objects.
  - **contact_id** (string) - The ID of the contact.
  - **name** (string) - The name of the contact.
  - **phone_number** (string) - The phone number of the contact.

#### Response Example
```json
{
  "contacts": [
    {
      "contact_id": "con_abc123",
      "name": "Jane Doe",
      "phone_number": "+1987654321"
    }
  ]
}
```

## GET /tapi/sync/contact/get

### Description
Retrieves a specific contact synchronously.

### Method
GET

### Endpoint
/tapi/sync/contact/get

### Parameters
#### Query Parameters
- **contact_id** (string) - Required - The ID of the contact to retrieve.

### Request Example
```json
{
  "contact_id": "con_abc123"
}
```

### Response
#### Success Response (200)
- **contact** (object) - The contact object.
  - **contact_id** (string) - The ID of the contact.
  - **name** (string) - The name of the contact.
  - **phone_number** (string) - The phone number of the contact.

#### Response Example
```json
{
  "contact": {
    "contact_id": "con_abc123",
    "name": "Jane Doe",
    "phone_number": "+1987654321"
  }
}
```

## POST /tapi/sync/contact/add

### Description
Adds a new contact synchronously.

### Method
POST

### Endpoint
/tapi/sync/contact/add

### Parameters
#### Request Body
- **name** (string) - Required - The name of the contact.
- **phone_number** (string) - Required - The phone number of the contact.

### Request Example
```json
{
  "name": "New Contact",
  "phone_number": "+1122334455"
}
```

### Response
#### Success Response (200)
- **contact_id** (string) - The ID of the newly added contact.

#### Response Example
```json
{
  "contact_id": "con_xyz789"
}
```
```

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

### Webhook for Incoming Message

Source: https://wappi.pro/telegram-api-documentation/index

Receives notifications for incoming messages of various types, including text.

```APIDOC
## POST /webhooks/incoming-message

### Description
Receives notifications for incoming messages, including text messages.

### Method
POST

### Endpoint
`/webhooks/incoming-message`

### Request Body
#### messages (array of objects) - Required
- **id** (string) - Unique message identifier.
- **profile_id** (string) - Identifier for the profile.
- **wh_type** (string) - Type of webhook, should be "incoming_message".
- **timestamp** (string) - ISO 8601 timestamp of the event.
- **time** (integer) - Unix timestamp of the event.
- **body** (string) - The content of the message.
- **type** (string) - Type of message (e.g., "text").
- **from** (string) - Sender's identifier.
- **to** (string) - Recipient's identifier.
- **senderName** (string) - Name of the sender.
- **chatId** (string) - Identifier for the chat.
- **caption** (string or null) - Caption for media messages.
- **from_where** (string) - Source of the message (e.g., "phone").
- **contact_name** (string) - Name of the contact.
- **contact_phone** (string) - Phone number of the contact.
- **contact_username** (string) - Username of the contact.
- **username** (string) - Username of the sender.
- **is_forwarded** (boolean) - Indicates if the message was forwarded.
- **isReply** (boolean) - Indicates if the message is a reply.
- **is_edited** (boolean) - Indicates if the message was edited.
- **stanza_id** (string) - Stanza ID of the message.
- **is_me** (boolean) - Indicates if the message is from the current user.
- **chat_type** (string) - Type of chat (e.g., "user").
- **thumbnail** (string) - URL of the thumbnail.
- **picture** (string) - URL of the picture.
- **wappi_bot_id** (string) - Wappi bot ID.
- **is_deleted** (boolean) - Indicates if the message was deleted.
- **is_bot** (boolean) - Indicates if the sender is a bot.

### Request Example
```json
{
  "messages": [
    {
      "id": "5902",
      "profile_id": "51a8107a-5442",
      "wh_type": "incoming_message",
      "timestamp": "2025-03-17T15:14:37+03:00",
      "time": 1742213677,
      "body": "Текстовое сообщение",
      "type": "text",
      "from": "60227586",
      "to": "5279188641",
      "senderName": "Sinn",
      "chatId": "60227586",
      "caption": null,
      "from_where": "phone",
      "contact_name": "Sinn",
      "contact_phone": "",
      "contact_username": "sinay",
      "username": "sinay",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "chat_type": "user",
      "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success of the webhook reception.

#### Response Example
```json
{
  "status": "ok"
}
```
```
Tokens:
Raw