getContacts

Отдаёт людей, с которыми может переписываться канал: адресную книгу аккаунта и собеседников личных чатов. Нужен, чтобы сверить контакты вашей CRM с мессенджером.

Параметры

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

Первые 100 контактов:

curl

curl "$GRATIO_URL/waInstance$GRATIO_ID/getContacts/$GRATIO_TOKEN?count=100"

Python

import os
import requests

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

url = f"{BASE}/getContacts/{TOKEN}"
params = {"count": "100"}
response = requests.get(url, params=params, timeout=90)
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 query = new URLSearchParams({ count: "100" });
const url = `${base}/getContacts/${GRATIO_TOKEN}?${query}`;
const response = await fetch(url);
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getContacts/' . getenv('GRATIO_TOKEN');
$url .= '?' . http_build_query(['count' => '100']);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 90,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

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

Ответ 200 OK:

[
  {"chatId": "8695836", "name": "Мария", "contactName": "", "type": "user", "phoneNumber": 0},
  {"chatId": "1111111", "name": "Олег", "contactName": "", "type": "user", "phoneNumber": 0}
]

Поля ответа

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

Подробная карточка одного человека — getContactInfo.

Ошибки

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

Что дальше

• getContactInfo — профиль собеседника.
• getChats — все чаты, в том числе группы.
• checkAccount — найти человека по номеру телефона.