REST API를 사용한 메시지 전송

두 가지 다른 Braze 엔드포인트를 사용하여 백엔드에서 실시간으로 메시지를 보낼 수 있습니다. 각각 요청 형식이 다릅니다: 하나는 요청에 전체 메시지 내용을 포함해야 하며, 다른 하나는 캠페인 ID를 요구하고 대시보드에서 정의된 내용을 전송합니다.

이 접근 방식은 API가 지원하는 모든 메시징 채널(WhatsApp, 이메일, SMS, 푸시 알림, 콘텐츠 카드, 웹훅 등)에서 작동합니다.

보내는 두 가지 방법

전체 요청 및 응답 세부 정보는 즉시 메시지 보내기(API 전용) 및 API 트리거된 전달을 사용한 캠페인 보내기 엔드포인트 참조 문서를 참조하십시오.

Option 1: 요청에 메시지 내용을 포함하여 전송(/messages/send)

API 요청에서 전체 메시지 내용을 지정하려는 경우 이 엔드포인트를 사용하십시오. 반드시 객체(예: messages.whats_app, messages.emailmessages, 또는 messages.sms)를 포함해야 합니다. 캠페인 추적 없이 발송하려면campaign_id 생략하거나, 대시보드에서 발송 내역을 추적하려면 각 메시지에 API message_variation_id캠페인 ID와 를 포함하세요(자세한 내용은 엔드포인트 참조 문서 참조).

필요 사항: 해당messages.send권한을 가진 API 키.

예시: WhatsApp 템플릿 메시지

1
2
3
POST YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "external_user_ids": ["user123"],
  "messages": {
    "whats_app": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_WHATSAPP_SUBSCRIPTION_GROUP_ID",
      "message_type": "template_message",
      "message": {
        "template_name": "new_message_received",
        "template_language_code": "en_US"
      }
    }
  }
}

전체 WhatsApp 객체 사양은 WhatsApp 객체를 참조하십시오.

예시: Email

1
2
3
4
5
6
7
8
9
10
11
{
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "subject": "Your order has shipped",
      "from": "[email protected]",
      "body": "<p>Your order #12345 is on its way.</p>"
    }
  }
}

다른 채널에 대해서는 메시징 객체를 참조하십시오.

Option 2: 대시보드에서 콘텐츠로 캠페인을 트리거하세요 (/campaigns/trigger/send)

Braze 대시보드에서 메시지 콘텐츠가 구축된 경우(API 트리거 캠페인) 이 엔드포인트를 사용하십시오. 필수campaign_id항목과 수신자를 전송합니다; 객체는messages 전송하지 않습니다.

필요 사항: 해당campaigns.trigger.send권한을 가진 API 키.

1단계: API로 트리거되는 캠페인 생성

1. Braze 대시보드에서 메시징 > 캠페인으로 이동하세요.
2. 캠페인 생성을 선택한 후, API 트리거 캠페인(API 캠페인이 아님)을 선택하십시오.
3. 메시지 채널(WhatsApp, 이메일, SMS 등)을 추가하고 대시보드에서 메시지 내용을 구축하세요.
4. 캠페인 ID를 기록하십시오(여러 메시지 배리언트를 사용하는 경우 전송 ID도 포함). 이것들은 API 요청에서 사용하게 될 것입니다.

API 트리거 캠페인을 구축하는 방법에 대한 자세한 내용은 API 트리거 전달을 참조하십시오.

2단계: API를 통해 캠페인을 트리거합니다

POST 요청을 로/campaigns/trigger/send 와recipients (또는 broadcast/audience)와campaign_id함께 전송하십시오. 객체를messages 포함하지 마십시오—콘텐츠는 캠페인에서 제공됩니다.

1
2
3
POST YOUR_REST_ENDPOINT/campaigns/trigger/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "recipients": [
    {
      "external_user_id": "user123"
    }
  ]
}

전체 요청 본문( , send_to_existing_only, attributes,trigger_properties 등 포함)은 API 트리거 전달을 사용한 캠페인 전송 엔드포인트 참조 문서를 참조하십시오.

통합을 확인하세요

1. 위의 옵션 중 하나를 사용하여 요청을 보내되, 수신자로 본인 ID를 지정하십시오.
2. 메시지가 전달되었는지 확인하십시오.
3. 옵션 2를 사용하는 경우, Braze 대시보드에서 캠페인을 확인하여 발송이 기록되었는지 확인하십시오.

고려 사항

• 지원되는 환경에서 Braze 개인화 기능을 활용하여 콘텐츠를 맞춤 설정하세요.
• 관련 규정을 준수하고 필수적인 수신 거부 옵션 및 개인정보 처리방침을 포함하도록 메시징을 구성하십시오.
• 추가 엔드포인트(스케줄링, 캔버스 트리거 등)에 대해서는 메시징 엔드포인트를 참조하십시오.