SendContact#
Метод предназначен для отправки сообщения с контактом. Формируется визитная карточка контакта и отправляется в чат. Сообщение будет добавлено в очередь на отправку. Сообщение на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона. Скорость отправки сообщений из очереди регулирует параметр Интервал отправки сообщений.
Запрос#
Для отправки сообщения с контактом требуется выполнить запрос по адресу:
POST https://api.green-api.com/waInstance{{idInstance}}/sendContact/{{apiTokenInstance}}
Для получения параметров запроса idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
chatId | string | Да | Идентификатор чата |
contact | object | Да | Объект о контакте |
quotedMessageId | string | Нет | Идентификатор цитируемого сообщения,если указан то сообщение отправится с цитированием указанного сообщения чата |
Параметры объекта contact
:
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
phoneContact | integer | Да | номер телефона контакта в международном формате (без +) 11 или 12 цифр |
firstName | string | Если не указаны middleName , lastName , company | Имя контакта |
middleName | string | Если не указаны firstName , lastName , company | Отчество контакта |
lastName | string | Если не указаны middleName , firstName , company | Фамилия контакта |
company | string | Если не указаны middleName , lastName , firstName | Название компании контакта |
Пример тела запроса#
Отправка сообщения в личный чат:
{
"chatId": "11001234567@c.us",
"contact": {
"phoneContact": 79001234568,
"firstName": "Артем",
"middleName": "Петрович",
"lastName": "Евпаторийский",
"company": "Велосипед"
}
}
Отправка сообщения в групповой чат:
{
"chatId": "120363043968066561@g.us",
"contact": {
"phoneContact": 79001234568,
"firstName": "Артем",
"middleName": "Петрович",
"lastName": "Евпаторийский",
"company": "Велосипед"
}
}
Отправка сообщения с цитированием:
{
"chatId": "11001234567@c.us",
"quotedMessageId": "361B0E63F2FDF95903B6A9C9A102F34B",
"contact": {
"phoneContact": 79001234568,
"firstName": "Артем",
"middleName": "Петрович",
"lastName": "Евпаторийский",
"company": "Велосипед"
}
}
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
idMessage | string | Идентификатор отправленного сообщения |
Пример тела ответа#
{
"idMessage": "3EB0C767D097B7C7C030"
}
Ошибки SendContact#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Пример кода на Python#
import requests
url = "https://api.green-api.com/waInstance{{idInstance}}/sendContact/{{apiTokenInstance}}"
payload = "{\r\n\t\"chatId\": \"11001234567@c.us\",\r\n\t\"contact\": {\r\n\t\t\"phoneContact\": 79001234568,\r\n \t\"firstName\": \"Артем\",\r\n\t\t\"middleName\": \"Петрович\",\r\n\t\t\"lastName\": \"Евпаторийский\",\r\n\t\t\"company\": \"Велосипед\"\r\n\t}\r\n}\r\n"
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))