Узел Messages

/v1/messages

Используйте узел messages, чтобы отправлять своим клиентам текстовые сообщения, медиафайлы, контакты, геоданные, интерактивные сообщения и шаблоны сообщений.

Сведения о сообщениях различных типов, которые вы можете отправлять, см. в следующих руководствах: Текстовые сообщения, Сообщения с медиафайлами, Сообщения с контактами и сведениями о местоположении, Интерактивные сообщения, Шаблоны сообщений, Шаблоны сообщений с медиафайлами и Интерактивные шаблоны сообщений.

Прежде чем начать

Вам нужно:

• Пройти аутентификацию и получить маркер авторизации для доступа к службе. Дополнительную информацию см. в документации по входу и аутентификации.
• Подтвердить аккаунт WhatsApp, которому будут отправляться сообщения, и получить соответствующий ID пользователя WhatsApp. Дополнительную информацию см. в документации по контактам.
• Обеспечить соответствие сообщений условиям доставки.

Ограничения

• Поддерживаются сообщения следующих типов: текст, шаблоны сообщений, изображения, документы и аудио.
• Максимальная длина текстового сообщения — 4096 символов.

Создание

Для отправки сообщения любого типа необходимо выполнить вызов POST к узлу /messages. Содержимое тела сообщения JSON зависит от типа сообщения (текст, изображение и т. п.).

Параметры

Ниже перечислены основные параметры для POST-запросов /messages:

Объект Text

Объект Media

Для локального API ID медиаобъекта возвращается после успешной загрузки медиафайла в локальный/референтный клиент WhatsApp Business через конечную точкуmedia.

Объект Contacts

В contacts можно вложить следующие объекты: addresses, emails, name, org, phone и urls. Множественные объекты должны быть заключены в массив, как показано в примере ниже.

Пример объекта contacts с вложенными множественными объектами:

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

Объект Location

Объект Template

В template можно вложить объекты components и language.

Объект Components

В components можно вложить объект parameters. Кроме того, можно задать для параметра type значение button.

Объект Parameter

Тип кнопки

В объекте components для параметра type можно задать значение button. Предусмотрено два параметра кнопок:

Пример типа button с параметром sub_type со значением quick_reply:

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

Пример типа button с параметром sub_type со значением copy_code

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

Объект Hsm

Объект Interactive

Объект Action

Примеры

Звуковые сообщения:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

Сообщения с документами с использованием параметра filename:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

Сообщения с документами с использованием параметра link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

Видеосообщения с использованием параметра link:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

Текстовые сообщения:

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "text",
  "text": {
      "body": "your-message-content"
  }
}

Интерактивные сообщения (списки):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

Интерактивные сообщения (кнопки ответа):

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

Интерактивные сообщения (сообщения об одном и нескольких товарах):

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

Интерактивные сообщения (сообщения о нескольких товарах):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

Интерактивные сообщения (сообщения с каталогом):

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

Интерактивные сообщения (списки):

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

Ниже показан пример payload в ответе. Для краткости объекты meta и error отсутствуют.

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

В случае успеха вы получите ответ с ID сообщения. Если запрос вернет раздел errors, проверьте исходное сообщение, исправьте ошибки и отправьте запрос заново. Дополнительную информацию об ошибках см. в статьях Коды ошибок локального клиента WhatsApp Business и Коды статусов HTTP.

Если запрос заблокирован для оценивания качества, ответ будет включать в себя свойство message_status с сообщением, указывающим, что сообщение не было доставлено сразу же и будет отправлено или заблокировано после завершения оценивания качества. Это свойство будет существовать только в случае блокировки сообщения.

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

Форматирование в текстовых сообщениях

В сообщениях WhatsApp можно использовать базовое форматирование. Для этого нужно заключить текст, который требуется отформатировать, в специальные символы:

Производительность

В этом контексте производительность — это количество сообщений, которые можно отправить за секунду через локальный/справочный клиент WhatsApp Business. Максимальная производительность зависит от множества факторов. Самые главные из них — выбранная конфигурация клиента и то, отправляется ли сообщение существующему или новому пользователю. При отправке новому пользователю настройка шифрования занимает немного больше времени.

Часто задаваемые вопросы

Дополнительная информация

• Документация по входу и аутентификации
• Документация по контактам
• Коды ошибок локального клиента WhatsApp Business
• Коды статусов HTTP