getContactInfo

Отдаёт карточку собеседника личного чата: поля Green API и, в Telegram, подробный профиль — как экран профиля в приложении. Нужен, чтобы заполнить карточку клиента в вашей системе.

Параметры

Пример запроса

Карточка Марии в MAX:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getContactInfo/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "8695836"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/getContactInfo/{TOKEN}"
payload = {"chatId": "8695836"}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/getContactInfo/${GRATIO_TOKEN}`;
const payload = { chatId: "8695836" };
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getContactInfo/' . getenv('GRATIO_TOKEN');
$payload = ['chatId' => '8695836'];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK:

{
  "avatar": "https://i.oneme.ru/i?r=…",
  "name": "Мария",
  "contactName": "",
  "chatId": "8695836",
  "chatType": "user",
  "lastSeen": null,
  "phoneNumber": 0,
  "email": "",
  "category": "",
  "description": "",
  "products": [],
  "isArchive": false,
  "isDisappearing": false,
  "messageExpiration": 0,
  "isMute": false,
  "muteExpiration": 0,
  "isBusiness": false
}

Поля ответа

Подробный профиль Telegram

В Telegram ответ дополняют поля сверх Green API. Поле есть, только если Telegram его сообщил. Профиль Марии:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getContactInfo/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "8617393401"}'

Ответ 200 OK:

{
  "avatar": "https://api.gratio.net/media/7100000001/8617393401/avatar/0/5be1…",
  "name": "Мария",
  "contactName": "",
  "chatId": "8617393401",
  "chatType": "user",
  "lastSeen": 1791823600,
  "phoneNumber": 0,
  "email": "",
  "category": "",
  "description": "Мама Вари из 3А",
  "products": [],
  "isArchive": false,
  "isDisappearing": false,
  "messageExpiration": 0,
  "isMute": false,
  "muteExpiration": 0,
  "isBusiness": false,
  "status": "offline",
  "username": "maria_k",
  "usernames": ["maria_k"],
  "isContact": false,
  "isMutualContact": false,
  "isBlocked": false,
  "isVerified": false,
  "isPremium": false,
  "birthday": {"day": 14, "month": 10, "year": null},
  "commonChatsCount": 1,
  "callsAvailable": true,
  "hasStories": false
}

Так выглядит business у аккаунта Telegram для бизнеса:

"business": {
  "address": "Москва, ул. Лесная, 5",
  "latitude": 55.7812,
  "longitude": 37.5893,
  "timezone": "Europe/Moscow",
  "workHours": [
    {"day": "mon", "open": "09:00", "close": "18:00"},
    {"day": "tue", "open": "09:00", "close": "18:00"}
  ],
  "openNow": true,
  "introTitle": "Здравствуйте!",
  "introText": "Ответим в рабочие часы"
}

Свежесть данных

Новое имя или фото собеседника в MAX появится в ответе не позже чем через час. В Telegram кэшируйте карточки у себя: каждый запрос — обращение к Telegram.

Ошибки

Общие правила — в статье Ответы и ошибки.

Особенности каналов

• MAX. avatar — ссылка MAX на фото. Подробного профиля нет, lastSeen — null, номер MAX не показывает.
• Telegram. avatar — подписанная ссылка Gratio: у Telegram нет публичных ссылок на фото. Номер — только если собеседник его открыл.
• WhatsApp. avatar — подписанная ссылка Gratio, phoneNumber — номер собеседника, description — «О себе». У бизнес-аккаунта с подтверждённым именем — "isVerified": true.
• Почта. Известно только имя из писем, остальные поля пустые.

Что дальше

• getAvatar — только фото профиля.
• getContacts — все контакты канала.
• checkAccount — найти собеседника по номеру.