Green API
  1. Incoming messages
Green API
  • Green API EN
    • Account
      • Get account settings
      • Set account settings
      • Get account state
      • Reboot account
      • Logout account
      • Get QR code
      • Get Authorization Code
      • Set profile picture
      • Get WhatsApp account information
    • Sending
      • Send text
      • Send text with quote
      • Send text to group
      • Send poll
      • Send video, audio, image, document
      • Send video, audio, image, document via URL
      • Upload file
      • Send location
      • Send contact
      • Forward messages
    • Receiving
      • Receiving notification
        • Receive notification
        • Delete notification
      • Receiving files
        • Download file from incoming message
    • Journals
      • Get chat history
      • Get chat message
      • Get incoming messages journal
      • Get outgoing messages journal
    • Queues
      • Get messages count to send
      • Show messages queue to send
      • Clear messages queue to send
      • Get webhooks count in the incoming queue
      • Clear incoming Webhooks queue
    • Groups
      • Create group
      • Change group name
      • Get group data
      • Add group participant
      • Delete group participant
      • Set group admin rights
      • Remove group admin rights
      • Set group picture
      • Leave group
    • Statuses
      • Send text status
      • Send voice status
      • Send media status
      • Get Outgoing Statuses
      • Get Incoming Statuses
      • Get Status Statistic
      • Delete Status
    • Read mark
      • Mark message as read
      • Mark chat as read
    • Service methods
      • Check WhatsApp availability
      • Get avatar contact
      • Get avatar group
      • Get contacts
      • Get contact info
      • Edit message
      • Delete message
      • Archive chat
      • Unarchive chat
      • Change the settings of disappearing chat messages
    • Notifications Green API
      • Incoming messages
        • Quoted
          • Quoting by text message
            • Text message
        • Media messages
          • Image message
          • Video message
          • Audio message
          • Document message
        • Text message
          POST
        • Extended text message
          POST
        • Location message
          POST
        • Contact message
          POST
        • Contacts array message
          POST
        • Buttons message
          POST
        • Selection list message
          POST
        • Template buttons message
          POST
        • Simple button selection
          POST
        • Template button selection
          POST
        • List element selection
          POST
        • Sticker message
          POST
        • Reaction message
          POST
        • Poll message
          POST
        • Incoming poll update message
          POST
        • Group invitation message
          POST
        • Edited message
          POST
        • Deleted Message
          POST
      • Outgoing message
        • Message sent from phone
          • Media messages
            • Image message
            • Video message
            • Audio message
            • Document message
          • Text message
          • Extended text message
          • Location message
          • Contact message
          • Contacts array message
          • Sticker message
          • Poll message
          • Reaction message
          • Group invitation message
          • Outgoing message status
          • Edited message
          • Deleted Message
        • Message sent via API
          • Media messages
            • Image message
            • Video message
            • Audio message
            • Document message
          • Text message
          • Extended text message
          • Location message
          • Contact message
          • Poll message
          • Outgoing message status
          • Edited message
          • Deleted Message
      • Others
        • Account status
        • Incoming call
        • Incoming block
        • Exceeding limitation on tariff
      • API exceptions
        • Error SWE001
        • Error SWE002
        • Error SWE003
        • Error SWE004
  • Green API RU
    • Аккаунт
      • Получить настройки аккаунта
      • Установить настройки аккаунта
      • Получить состояние аккаунта
      • Перезапустить аккаунт
      • Разлогинить аккаунт
      • Получить QR-код
      • Авторизации по номеру телефона
      • Установить фото профиля
      • Получить данные аккаунта
    • Отправка
      • Отправить текст
      • Отправить текст c цитатой
      • Отправить текст в группу
      • Отправить опрос
      • Отправить видео, аудио, изображение, документ
      • Отправить видео, аудио, изображение, документ по URL
      • Выгрузить файл
      • Отправить геолокацию
      • Отправить контакт
      • Переслать сообщения
    • Получение
      • Получение уведомлений
        • Получить уведомление
        • Удалить уведомление
      • Получение файлов
        • Скачать файл из входящего сообщения
    • Журналы
      • Получить историю сообщений чата
      • Получить сообщение чата
      • Получить журнал входящих сообщений
      • Получить журнал отправленных сообщений
    • Очереди
      • Получить количество сообщений к отправке
      • Получить очередь сообщений к отправке
      • Очистить очередь сообщений к отправке
      • Получить количество уведомлений во входящей очереди
      • Очистить очередь входящих уведомлений
    • Группы
      • Создать группу
      • Изменить имя группы
      • Получить информацию о группе
      • Добавить участника в группу
      • Удалить участника из группы
      • Назначить права администратора группы
      • Отозвать права администратора группы
      • Установить фото группы
      • Выйти из группы
    • Статусы
      • Отправить текстовый статус
      • Отправить голосовой статус
      • Отправить медиа статус
      • Получить исходящие статусы
      • Получить входящие статусы
      • Получить статистику статуса
      • Удалить статус
    • Отметка прочтения
      • Отметить сообщение в чате прочитанным
      • Отметить чат прочитанным
    • Сервисные методы
      • Проверить наличие WhatsApp
      • Получить аватар контакта
      • Получить аватар группы
      • Получить контакты
      • Получить инфо контакта
      • Редактировать сообщение
      • Удалить сообщение
      • Архивировать чат
      • Разархивировать чат
      • Изменить настройки исчезающих сообщений чата
    • Уведомления Green API
      • Входящее сообщение
        • Цитирование
          • Цитирование текстовым сообщением
            • Текстовое сообщение
        • Медиа сообщения
          • Сообщение с изображением
          • Сообщение с видео
          • Сообщение с аудио
          • Сообщение с документом
        • Текстовое сообщение
        • Расширенное текстовое сообщение
        • Сообщение с геолокацией
        • Сообщение с контактом
        • Сообщение с массивом контактов
        • Сообщение с кнопками
        • Сообщение со списком выбора
        • Сообщение с шаблонными кнопками
        • Сообщение с выбором обычной кнопки
        • Сообщение с выбором шаблонной кнопки
        • Сообщение с выбором элемента списка
        • Сообщение со стикером
        • Сообщение-реакция
        • Сообщение с опросом
        • Сообщение с обновлением опроса
        • Сообщение с приглашением в группу
        • Отредактированное сообщение
        • Удаленное сообщение
      • Отправленное сообщение
        • Отправленное сообщение с телефона
          • Медиа сообщения
            • Сообщение с изображением
            • Сообщение с видео
            • Сообщение с аудио
            • Сообщение с документом
          • Текстовое сообщение
          • Расширенное текстовое сообщение
          • Сообщение с геолокацией
          • Сообщение с контактом
          • Сообщение с массивом контактов
          • Сообщение со стикером
          • Сообщение с опросом
          • Сообщение-реакция
          • Сообщение с приглашением в группу
          • Статус отправленного сообщения
          • Отредактированное сообщение
          • Удаленное сообщение
        • Отправленное сообщение через API
          • Медиа сообщения
            • Сообщение с изображением
            • Сообщение с видео
            • Сообщение с аудио
            • Сообщение с документом
          • Текстовое сообщение
          • Расширенное текстовое сообщение
          • Сообщение с геолокацией
          • Сообщение с контактом
          • Сообщение с опросом
          • Статус отправленного сообщения
          • Отредактированное сообщение
          • Удаленное сообщение
      • Прочие
        • Статус аккаунта
        • Входящий звонок
        • Входящая блокировка
        • Превышение ограничения на тарифе
      • Исключения АПИ
        • Ошибка SWE001
        • Ошибка SWE002
        • Ошибка SWE003
        • Ошибка SWE004
  1. Incoming messages

Contact message

POST
/
Documentation Incoming contact message
To receive this type of notification, you must enable the "incomingWebhook" setting: "yes" in your personal account or using the SetSettings method

Request

Body Params application/json
typeWebhook
string 
required
instanceData
object 
required
idInstance
integer 
required
wid
string 
required
typeInstance
string 
required
timestamp
integer 
required
idMessage
string 
required
senderData
object 
required
chatId
string 
required
chatName
string 
required
sender
string 
required
senderName
string 
required
senderContactName
string 
required
messageData
object 
required
typeMessage
string 
required
contactMessageData
object 
required
Example
{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1101000001,
    "wid": "71231234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1705520441,
  "idMessage": "E06893873B835B1A07",
  "senderData": {
    "chatId": "71234567890@c.us",
    "chatName": "Green API",
    "sender": "71234567890@c.us",
    "senderName": "Green API",
    "senderContactName": "Green API inContacts"
  },
  "messageData": {
    "typeMessage": "contactMessage",
    "contactMessageData": {
      "displayName": "Alex Smit",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Smit;Alex;;;\nFN:Alex Smit\nTEL;type=CELL;waid=72345678901:+7 234 567 8901\nEND:VCARD",
      "forwardingScore": 0,
      "isForwarded": false
    }
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
        "idInstance": 1101000001,
        "wid": "71231234567@c.us",
        "typeInstance": "whatsapp"
    },
    "timestamp": 1705520441,
    "idMessage": "E06893873B835B1A07",
    "senderData": {
        "chatId": "71234567890@c.us",
        "chatName": "Green API",
        "sender": "71234567890@c.us",
        "senderName": "Green API",
        "senderContactName": "Green API inContacts"
    },
    "messageData": {
        "typeMessage": "contactMessage",
        "contactMessageData": {
            "displayName": "Alex Smit",
            "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Smit;Alex;;;\nFN:Alex Smit\nTEL;type=CELL;waid=72345678901:+7 234 567 8901\nEND:VCARD",
            "forwardingScore": 0,
            "isForwarded": false
        }
    }
}'

Responses

🟢200Contact message in the journal
text/plain
Body
object {0}
Modified at 2024-12-03 09:11:36
Previous
Location message
Next
Contacts array message
Built with