Отправить Контакт
Отправка контакта в существующий чат (только с открытым диалоговым окном). Нужен только один параметр адресата - chatId, phone или bsuid. В BSUID-centric режиме chatId может быть [email protected], bsuid@lid, [email protected] или username@username. Поле phone принимает телефон или BSUID; bsuid можно передать отдельным полем.
JWT tokentoken<token>- body
contacts?array<>Массив, содержащий объекты контактов.
Параметры объекта контакта:
name - Имя контакта. Обязательное поле. Объект с параметрами:
-
formatted_name - Полное имя, как должно отображаться. Пример: Lord Adam John Smith Junior. Вы также должны указать хотя бы один дополнительный параметр (first_name, last_name, middle_name, suffix, prefix)
-
first_name - Имя. Пример: Adam
-
last_name - Фамилия. Пример: Smith
-
middle_name - Отчество. Пример: John
-
suffix - Суффикс имени. Пример: Junior
-
prefix - Префик имени. Пример: Lord
birthday - Строка в формате YYYY-MM-DD. Пример: 2012-08-18
addresses - Массив, содержащий объекты с параметрами:
-
street - Номер и название улицы. Пример: 1 Hacker Way
-
city - Город. Пример: Menlo Park
-
state - Аббревиатура региона. Пример: CA
-
zip - Почтовый индекс. Пример: 94025
-
country - Полное название страны. Пример: United States
-
country_code - Двухбуквенный код страны. Пример: us
-
type - Одно из стандартных значений: HOME, WORK. Пример: HOME
emails - массив, содержащий объекты с параметрами:
-
email - Email адрес. Пример: [email protected]
-
type - Одно из стандартных значений: HOME, WORK. Пример: WORK
org - объект, содержащий параметры:
-
company - Название компании контакта. Пример: WhatsApp
-
department - Название отдела контакта. Пример: Design
-
title - Должность контакта. Пример: Manager
phones - массив, содержащий объекты с параметрами:
-
phone - Автоматически заполняется значением wa_id в виде форматированного телефона. Пример: +1 (940) 555-1234
-
type - Одно из стандартных значений: CELL, MAIN, IPHONE, HOME, WORK. Пример: HOME
-
wa_id - WhatsApp ID. Пример: 19405551234
urls - массив, содержащий объекты с параметрами:
-
url - URL. Пример: https://www.facebook.com
-
type - Одно из стандартных значений: HOME, WORK. Пример: WORK
Общий пример: [{"addresses":[{"city":"Menlo Park","country":"United States","country_code":"us","state":"CA","street":"1 Hacker Way","type":"HOME","zip":"94025"},{"city":"Menlo Park","country":"United States","country_code":"us","state":"CA","street":"200 Jefferson Dr","type":"WORK","zip":"94025"}],"birthday":"2012-08-18","emails":[{"email":"[email protected]","type":"WORK"},{"email":"[email protected]","type":"WORK"}],"name":{"first_name":"John","formatted_name":"John Smith","last_name":"Smith"},"org":{"company":"WhatsApp","department":"Design","title":"Manager"},"phones":[{"phone":"+1 (940) 555-1234","type":"HOME"},{"phone":"+1 (650) 555-1234","type":"WORK","wa_id":"16505551234"}],"urls":[{"url":"https://www.facebook.com","type":"WORK"}]}]
contact?Простая карточка контакта вместо contacts. Нужны name и phone.
quotedMsgId?stringИдентификатор цитируемого сообщения (Cloud API)
chatId?stringОбязателен, если не указаны phone и bsuid
ID чата из списка сообщений. Примеры: [email protected], RU.1504711984690866@lid, username@username или [email protected] (группа). Используется вместо параметра phone.
phone?stringОбязателен, если не указаны chatId и bsuid
Идентификатор получателя. Принимает номер телефона с кодом страны или BSUID, например RU.1504711984690866.
Для chatId используйте полные ID чатов: [email protected], bsuid@lid, username@username или [email protected].
bsuid?stringНеобязательная альтернатива phone/chatId
BSUID получателя без суффикса @lid. Пример: RU.1504711984690866.
Server response example
application/json- response
sent?booleanid?stringУникальный идентификатор сообщения
message?stringУведомление о статусе отправки сообщения
description?stringКомментарий к результату отправки
curl -X POST 'https://api.1msg.io/123/sendContact' \ -H 'Content-Type: application/json' \ -d '{ "contacts": [ { "name": { "formatted_name": "John Smith", "first_name": "John", "last_name": "Smith" }, "phones": [ { "phone": "+1 (650) 555-1234", "type": "WORK", "wa_id": "16505551234" } ] } ], "phone": "12020721369"}'{ "sent": true, "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8", "message": "Sent to [email protected]", "description": "Message has been sent to the provider"}