ΠŸΠ΅Ρ€Π΅ΠΉΡ‚ΠΈ ΠΊ ΡΠΎΠ΄Π΅Ρ€ΠΆΠ°Π½ΠΈΡŽ

CreateTemplate#

Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠΉΡ‚Π΅ этот ΠΌΠ΅Ρ‚ΠΎΠ΄ для создания Π½ΠΎΠ²ΠΎΠ³ΠΎ шаблона

Запрос#

Для создания Π½ΠΎΠ²ΠΎΠ³ΠΎ шаблона трСбуСтся Π²Ρ‹ΠΏΠΎΠ»Π½ΠΈΡ‚ΡŒ запрос ΠΏΠΎ адрСсу:

POST {{apiUrl}}/waInstance{{idInstance}}/createTemplate/{{apiTokenInstance}}

Для получСния ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ² запроса idInstance, apiTokenInstance ΠΈ apiUrl ΠΎΠ±Ρ€Π°Ρ‚ΠΈΡ‚Π΅ΡΡŒ ΠΊ Ρ€Π°Π·Π΄Π΅Π»Ρƒ ΠŸΠ΅Ρ€Π΅Π΄ Π½Π°Ρ‡Π°Π»ΠΎΠΌ Ρ€Π°Π±ΠΎΡ‚Ρ‹.

ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ запроса#

ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ Π’ΠΈΠΏ ΠžΠ±ΡΠ·Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹ΠΉ ОписаниС
elementName string Π”Π° Имя шаблона. Имя элСмСнта ΡƒΠ½ΠΈΠΊΠ°Π»ΡŒΠ½ΠΎ для пространства ΠΈΠΌΠ΅Π½ GREEN-APIs.
languageCode string Π”Π° Код языка для шаблона. ВсС ΠΊΠΎΠ΄Ρ‹ языков смотритС Π² Ρ‚Π°Π±Π»ΠΈΡ†Π΅ Π½ΠΈΠΆΠ΅
category string Π”Π° ΠšΠ°Ρ‚Π΅Π³ΠΎΡ€ΠΈΡ вашСго шаблона. Π’Π²Π΅Π΄ΠΈΡ‚Π΅ ΠΎΠ΄Π½ΠΎ ΠΈΠ· Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ: AUTHENTICATION, MARKETING and UTILITY. ΠŸΡ€ΠΈ ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ Π΄Ρ€ΡƒΠ³ΠΎΠ³ΠΎ значСния Π²Ρ‹ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚Π΅ сообщСниС ΠΎΠ± ошибкС: failed. Invalid category provided, kindly use category from these options AUTHENTICATION,MARKETING,UTILITY.
templateType string Π”Π° Π’ΠΈΠΏ шаблона: TEXT, IMAGE, VIDEO, DOCUMENT.
vertical string Π”Π° ΠšΡ€Π°Ρ‚ΠΊΠΎΠ΅ описаниС шаблона для прохоТдСния Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΠΈ Meta*. Π›ΠΈΠΌΠΈΡ‚ символов: 180.
content string Π”Π° Π’Π΅Π»ΠΎ шаблона, Π»ΠΈΠΌΠΈΡ‚ символов 1028.
header string НСт Π—Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ шаблона. ΠŸΡ€ΠΈΠΌΠ΅Π½ΠΈΠΌΠΎ для templateType = Text. МаксимальноС количСство символов: 60.
exampleHeader string НСт* НСпримСнимо для Ρ‚ΠΈΠΏΠ° шаблона: CATALOG. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠΉΡ‚Π΅ Π² exampleHeader Ρ‚ΠΎΠ»ΡŒΠΊΠΎ строчныС Π±ΡƒΠΊΠ²Ρ‹, Ρ‚Π°ΠΊ ΠΊΠ°ΠΊ использованиС Π·Π°Π³Π»Π°Π²Π½Ρ‹Ρ… Π±ΡƒΠΊΠ² ΠΏΡ€ΠΈΠ²ΠΎΠ΄ΠΈΡ‚ ΠΊ ошибкС. * ΠŸΡ€ΠΈΠΌΠ΅Ρ€ тСкста Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΊΠ° шаблона, обязатСлСн ΠΏΡ€ΠΈ использовании поля header Π² запросС.
footer string НСт НиТний ΠΊΠΎΠ»ΠΎΠ½Ρ‚ΠΈΡ‚ΡƒΠ» шаблона. Π›ΠΈΠΌΠΈΡ‚ символов: 60.
buttons string НСт Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ Ρ‚ΠΎΠ»ΡŒΠΊΠΎ Π² Ρ‚ΠΎΠΌ случаС, Ссли Π² вашСм шаблонС Π΅ΡΡ‚ΡŒ ΠΏΡ€ΠΈΠ·Ρ‹Π² ΠΊ Π΄Π΅ΠΉΡΡ‚Π²ΠΈΡŽ. Π’Π°ΠΊΠΆΠ΅ прСдставлСн ΠΏΡ€ΠΈΠΌΠ΅Ρ€, Ссли ΠΊΠ½ΠΎΠΏΠΊΠ° URL ΠΈΠΌΠ΅Π΅Ρ‚ ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½Ρ‹ΠΉ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€.
example string Π”Π° Π’Π°Ρˆ тСкст с подставлСнными ΠΏΡ€ΠΈΠΌΠ΅Ρ€Π°ΠΌΠΈ Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½Ρ‹Ρ… вмСсто ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ² Π² ΠΌΠ΅Ρ‚ΠΎΠ΄Π΅ SendTemplates
enableSample boolean НСт ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ трСбуСтся для создания всСх Ρ‚ΠΈΠΏΠΎΠ² шаблонов.
allowTemplateCategoryChange boolean НСт ЛогичСскоС Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅. Если Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅ TRUE, WhatsApp автоматичСски ΠΎΠ±Π½ΠΎΠ²ΠΈΡ‚ ΠΊΠ°Ρ‚Π΅Π³ΠΎΡ€ΠΈΡŽ шаблона Π² соотвСтствии с содСрТимым шаблона. Π—Π½Π°Ρ‡Π΅Π½ΠΈΠ΅ ΠΏΠΎ ΡƒΠΌΠΎΠ»Ρ‡Π°Π½ΠΈΡŽ β€” FALSE. Если катСгория обновляСтся, Π²Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΡ€ΠΎΡΠΌΠΎΡ‚Ρ€Π΅Ρ‚ΡŒ old Category ΠΈΠ· GetTemplates.
addSecurityRecommendation boolean НСт ΠžΠΏΡ†ΠΈΡ для ΠΊΠ°Ρ‚Π΅Π³ΠΎΡ€ΠΈΠΈ AUTHENTICATION, ΠΊ содСрТимому добавляСт заявлСниС ΠΎΠ± ΠΎΡ‚ΠΊΠ°Π·Π΅ ΠΎΡ‚ отвСтствСнности. Π’ цСлях бСзопасности Π½Π΅ ΠΏΠ΅Ρ€Π΅Π΄Π°Π²Π°ΠΉΡ‚Π΅ этот ΠΊΠΎΠ΄.
codeExpirationMinutes number НСт ΠžΠΏΡ†ΠΈΡ для ΠΊΠ°Ρ‚Π΅Π³ΠΎΡ€ΠΈΠΈ AUTHENTICATION, Π² Π½ΠΈΠΆΠ½ΠΈΠΉ ΠΊΠΎΠ»ΠΎΠ½Ρ‚ΠΈΡ‚ΡƒΠ» добавляСт ΡΠ»Π΅Π΄ΡƒΡŽΡ‰ΠΈΠΉ тСкст: Π‘Ρ€ΠΎΠΊ дСйствия этого ΠΊΠΎΠ΄Π° истСкаСт Ρ‡Π΅Ρ€Π΅Π· <NUM_MINUTES> ΠΌΠΈΠ½ΡƒΡ‚. Π‘Ρ€ΠΎΠΊ дСйствия ΠΊΠΎΠ΄Π° Π΄ΠΎΠ»ΠΆΠ΅Π½ ΡΠΎΡΡ‚Π°Π²Π»ΡΡ‚ΡŒ ΠΎΡ‚ 1 Π΄ΠΎ 90 ΠΌΠΈΠ½ΡƒΡ‚.
Код ΠΏΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΈΠ²Π°Π΅ΠΌΡ‹Ρ… языков
Language Code
Африкаанс af
Албанский sq
Арабский ar
АзСрбайдТанский az
Π‘Π΅Π½Π³Π°Π»ΡŒΡΠΊΠΈΠΉ bn
Болгарский bg
ΠšΠ°Ρ‚Π°Π»Π°Π½ΡΠΊΠΈΠΉ ca
ΠšΠΈΡ‚Π°ΠΉΡΠΊΠΈΠΉ (CHN) zh_CN
ΠšΠΈΡ‚Π°ΠΉΡΠΊΠΈΠΉ (HKG) zh_HK
ΠšΠΈΡ‚Π°ΠΉΡΠΊΠΈΠΉ (TAI) zh_TW
Π₯орватский hr
ЧСшский cs
Датский da
Голландский nl
Английский en
Английский (UK) en_GB
Английский (US) en_US
Эстонский et
Ѐилиппинский fil
Ѐинский fi
Ѐранцузский fr
Грузинский ka
НСмСцкий de
грСчСский el
Π“ΡƒΠ΄ΠΆΠ°Ρ€Π°Ρ‚ΠΈ gu
Π₯ауса ha
ΠΈΠ²Ρ€ΠΈΡ‚ he
Π₯ΠΈΠ½Π΄ΠΈ hi
ВСнгСрский hu
индонСзийский id
ирландский ga
ΠΈΡ‚Π°Π»ΡŒΡΠ½ΡΠΊΠΈΠΉ it
японский ja
Каннада kn
ΠšΠ°Π·Π°Ρ…ΡΠΊΠΈΠΉ kk
ΠšΠΈΠ½ΡŒΡΡ€ΡƒΠ°Π½Π΄Π° rw_RW
корСйский ko
ΠšΡ‹Ρ€Π³Ρ‹Π· (ΠšΡ‹Ρ€Π³Ρ‹Π·ΡΡ‚Π°Π½) ky_KG
Лаосский lo
Π»Π°Ρ‚Ρ‹ΡˆΡΠΊΠΈΠΉ lv
Литовский lt
макСдонский mk
малайский ms
Малаялам ml
ΠœΠ°Ρ€Π°Ρ‚Ρ…ΠΈ mr
НорвСТский nb
ΠŸΠ΅Ρ€ΡΠΈΠ΄ΡΠΊΠΈΠΉ fa
польский pl
ΠŸΠΎΡ€Ρ‚ΡƒΠ³Π°Π»ΡŒΡΠΊΠΈΠΉ (BR) pt_BR
ΠŸΠΎΡ€Ρ‚ΡƒΠ³Π°Π»ΡŒΡΠΊΠΈΠΉ (POR) pt_PT
ΠΏΠ°Π½Π΄ΠΆΠ°Π±ΠΈ pa
Румынский ro
Русский ru
БСрбский sr
словацкий sk
БловСнский sl
испанский es
испанский (ARG) es_AR
испанский (SPA) es_ES
испанский (MEX) es_MX
Π‘ΡƒΠ°Ρ…ΠΈΠ»ΠΈ sw
ШвСдский sv
Вамильский ta
TΡ‚Π΅Π»ΡƒΠ³Ρƒ te
тайский th
Ρ‚ΡƒΡ€Π΅Ρ†ΠΊΠΈΠΉ tr
украинский uk
Π£Ρ€Π΄Ρƒ ur
УзбСкский uz
Π²ΡŒΠ΅Ρ‚Π½Π°ΠΌΡΠΊΠΈΠΉ vi
Π—ΡƒΠ»Ρƒ zu

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ Ρ‚Π΅Π»Π° запроса#

{
    "elementName": "ticket_check_url_4245343",
    "languageCode": "en_US",
    "category": "MARKETING",
    "templateType": "TEXT",
    "vertical": "TEXT",
    "content": "your ticket has been confirmed for {{1}} persons on date {{2}}.",
    "header": "This is the header",
    "exampleHeader": "This is the header",
    "footer": "This is the footer",
    "buttons": "[{'type':'PHONE_NUMBER','text':'Call Us','phone_number':'+919872329959'},{'type':'URL','text':'Book A Demo','url':'https://GREEN-API.io/{{1}}','example':['https://GREEN-API.io/abc'], {'type':'QUICK_REPLY','text':'Demo Button'}]",
    "example": "your ticket has been confirmed for 4 persons on date 2020-05-04.",
    "enableSample": true,
    "allowTemplateCategoryChange": false
}

ΠžΡ‚Π²Π΅Ρ‚#

Поля ΠΎΡ‚Π²Π΅Ρ‚Π°#

ПолС Вип ОписаниС
template object ΠžΠ±ΡŠΠ΅ΠΊΡ‚ созданного шаблона

ΠžΠ±ΡŠΠ΅ΠΊΡ‚ template#

ПолС Вип ОписаниС
buttonSupported string Π’ΠΈΠΏΡ‹ ΠΊΠ½ΠΎΠΏΠΎΠΊ, ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅ΠΌΡ‹Π΅ Π² шаблонС.
category string ΠšΠ°Ρ‚Π΅Π³ΠΎΡ€ΠΈΡ шаблона.
containerMeta string ΠŸΠΎΠ»Π½ΠΎΡΡ‚ΡŒΡŽ сформированный запрос, ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½Π½Ρ‹ΠΉ Π½Π° Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΡŽ Π² Meta*.
createdOn number Timestamp создания шаблона (Π² миллисСкундах).
data string ПолС data ΠΈΠ· шаблона, тСкстовоС прСдставлСниС шаблона.
elementName string Имя шаблона, Π·Π°Π΄Π°Π½Π½ΠΎΠ΅ Π² Ρ‚Π΅Π»Π΅ запроса CreateTemplate.
languageCode string Π―Π·Ρ‹ΠΊ шаблона, Π·Π°Π΄Π°Π½Π½Ρ‹ΠΉ Π² Ρ‚Π΅Π»Π΅ запрсоа CreateTemplate.
languagePolicy string Π‘Π»ΡƒΠΆΠ΅Π±Π½ΠΎΠ΅ ΠΏΠΎΠ»Π΅ опрСдСлСния языка для Meta*.
meta string ПолС, содСрТащСС ΠΏΡ€ΠΈΠΌΠ΅Ρ€ шаблона.
modifiedOn number Timestamp рСдактирования шаблона (Π² миллисСкундах). Π Π°Π²Π΅Π½ createdOn ΠΏΡ€ΠΈ создании шаблона.
namespace string Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ Π°ΠΊΠΊΠ°ΡƒΠ½Ρ‚Π° GREEN-API.
priority number ΠŸΡ€ΠΈΠΎΡ€ΠΈΡ‚Π΅Ρ‚ ΡˆΠ°Π±Π»ΠΎΠ½Ρƒ, Π·Π°Π΄Π°Π²Π°Π΅ΠΌΡ‹ΠΉ Meta*.
quality string Π‘Π»ΡƒΠΆΠ΅Π±Π½ΠΎΠ΅ ΠΏΠΎΠ»Π΅ оцСнивания шаблона со стороны Meta*.
retry number ΠšΠΎΠ»ΠΈΡ‡Π΅ΡΡ‚Π²ΠΎ ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎΠΉ ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ шаблона Π½Π° Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΡŽ Π² Meta*.
stage string Π‘Π»ΡƒΠΆΠ΅Π±Π½ΠΎΠ΅ ΠΏΠΎΠ»Π΅ стадии ΠΎΠ±Ρ€Π°Π±ΠΎΡ‚ΠΊΠΈ запроса Meta*.
status string Бтатус Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΠΈ Meta* ΠΏΠΎ ΡˆΠ°Π±Π»ΠΎΠ½Ρƒ. ΠœΠΎΠΆΠ΅Ρ‚ ΠΏΡ€ΠΈΠ½ΠΈΠΌΠ°Ρ‚ΡŒ значСния: PENDING (Π½Π° рассмотрСнии), APPROVED (шаблон Π²Π΅Ρ€ΠΈΡ„ΠΈΡ†ΠΈΡ€ΠΎΠ²Π°Π½ ΠΈ ΠΌΠΎΠΆΠ΅Ρ‚ Π±Ρ‹Ρ‚ΡŒ ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½), REJECTED (шаблон Π½Π΅ ΠΏΡ€ΠΎΡˆΠ΅Π» Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΡŽ, Meta считаСт шаблон ΠΏΠΎΠ΄ΠΎΠ·Ρ€ΠΈΡ‚Π΅Π»ΡŒΠ½Ρ‹ΠΌ), FAILED (шаблон Π½Π΅ ΠΏΡ€ΠΎΡˆΠ΅Π» Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΡŽ, ошибка Π² Ρ‚Π΅Π»Π΅ запроса. ΠŸΡ€ΠΈΡ‡ΠΈΠ½Π° ΡƒΠΊΠ°Π·Π°Π½Π° Π² Π΄ΠΎΠΏΠΎΠ»Π½ΠΈΡ‚Π΅Π»ΡŒΠ½ΠΎΠΌ ΠΏΠΎΠ»Π΅ reason), PAUSED (Ρ€Π°Π±ΠΎΡ‚Π° шаблона приостановлСна).
templateType string Вип шаблона
vertical string ΠšΡ€Π°Ρ‚ΠΊΠΎΠ΅ описаниС шаблона для прохоТдСния Π²Π΅Ρ€ΠΈΡ„ΠΈΠΊΠ°Ρ†ΠΈΠΈ Meta*.
templateId string ID созданного шаблона для взаимодСйствия с Π½ΠΈΠΌ.

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ Ρ‚Π΅Π»Π° ΠΎΡ‚Π²Π΅Ρ‚Π°#

Код ΡƒΡΠΏΠ΅ΡˆΠ½ΠΎΠ³ΠΎ состояния: 200 OK.

{
  "template": {
    "appId": "****f7-***33-4**d-8f***-c***d*****",
    "category": "MARKETING",
    "createdOn": 1652768999707,
    "data": "Hi, you Welcome to Header.\nHi, {{1}}. This is the template for header testing.\nHi, Welcome to Footer. | [call,917676767676] | [ur,https://www.fb.com]",
    "elementName": "test_template12332",
    "id": "f****a-f****-4**2-8***4-dc****ea",
    "languageCode": "en",
    "languagePolicy": "deterministic",
    "master": true,
    "meta": "{\"example\":\"Hi, [john]. This is the template for header testing.\"}",
    "modifiedOn": 1652768999707,
    "namespace": "e***3_e5**_**de_***3_20****1b",
    "status": "PENDING",
    "templateType": "TEXT",
    "vertical": "Header",
    "allowTemplateCategoryChange": "false"
  }
}

Ошибки CreateTemplate#

ΠŸΠ΅Ρ€Π΅Ρ‡Π΅Π½ΡŒ ΠΎΠ±Ρ‰ΠΈΡ… для всСх ΠΌΠ΅Ρ‚ΠΎΠ΄ΠΎΠ² ошибок смотритС Π² Ρ€Π°Π·Π΄Π΅Π»Π΅ Π‘Ρ‚Π°Π½Π΄Π°Ρ€Ρ‚Π½Ρ‹Π΅ ошибки.

  • ΠžΡ€Π³Π°Π½ΠΈΠ·Π°Ρ†ΠΈΡ Meta, Π° Ρ‚Π°ΠΊΠΆΠ΅ Π΅Ρ‘ ΠΏΡ€ΠΎΠ΄ΡƒΠΊΡ‚Ρ‹ Instagram ΠΈ Facebook, Π½Π° ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ ΠΌΡ‹ ссылаСмся Π² этой ΡΡ‚Π°Ρ‚ΡŒΠ΅, ΠΏΡ€ΠΈΠ·Π½Π°Π½Ρ‹ экстрСмистскими Π½Π° Ρ‚Π΅Ρ€Ρ€ΠΈΡ‚ΠΎΡ€ΠΈΠΈ Π Π€.

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ ΠΊΠΎΠ΄Π° Π½Π° curl#

curl --location '{{apiUrl}}/waInstance{{idInstance}}/createTemplate/{{apiTokenInstance}}' \
    --header 'Content-Type: application/json' \
    --data 'elementName=ticket_check_url_4245343' \
    --data 'languageCode=en_US' \
    --data 'category=MARKETING' \
    --data 'templateType=TEXT' \
    --data 'vertical=TEXT' \
    --data 'content=your ticket has been confirmed for {{1}} persons on date {{2}}.' \
    --data 'header=This is the header' \
    --data 'exampleHeader=This is the header' \
    --data 'footer=This is the footer' \
    --data 'buttons=[{'type':'PHONE_NUMBER','text':'Call Us','phone_number':'+919872329959'},{'type':'URL','text':'Book A Demo','url':'https://GREEN-API.io/{{1}}','example':['https://GREEN-API.io/abc']}, {'type':'QUICK_REPLY','text':'Demo Button'}]' \
    --data 'example=your ticket has been confirmed for 4 persons on date 2020-05-04.' \
    --data 'enableSample=true' \
    --data 'allowTemplateCategoryChange=false'