Skip to content

API 트리거 전송을 사용하여 캠페인 메시지 보내기

post

/campaigns/trigger/send

이 엔드포인트를 사용하면 API 트리거 배달을 사용하여 지정된 사용자에게 즉각적인 일회성 메시지를 보낼 수 있습니다.

API 트리거 전송을 사용하면 메시지 콘텐츠를 Braze 대시보드 내에 보관하면서 API를 사용하여 메시지 전송 시기와 수신자를 지정할 수 있습니다.

세그먼트를 타겟팅하는 경우 요청에 대한 기록이 개발자 콘솔에 저장됩니다. 이 엔드포인트로 메시지를 보내려면 API 트리거 캠페인을 구축할 때 생성한 캠페인 ID가 있어야 합니다.

필수 구성 요소

이 엔드포인트를 사용하려면 campaigns.trigger.send 권한으로 API 키를 생성해야 합니다.

사용량 제한

요청에 세그먼트 또는 연결된 오디언스를 지정할 때 이 엔드포인트에는 분당 250건의 요청 속도 제한이 적용됩니다. 그렇지 않으면 external_id 을 지정하는 경우 이 엔드포인트는 API 속도 제한에 설명된 대로 /messages/send, /campaigns/trigger/send, /canvas/trigger/send 간에 시간당 250,000건의 요청이 공유되는 기본 속도 제한을 갖습니다.

요청 본문

요청 매개변수

매개변수 필수 데이터 유형 설명
campaign_id 필수 문자열 캠페인 식별자를 참조하세요.
send_id 선택 사항 문자열 식별자 보내기을 참조하십시오.
trigger_properties 선택 사항 객체 트리거 속성을 참조하십시오. 개인화 키-값 쌍은 이 요청의 모든 사용자에게 적용됩니다.
broadcast 선택 사항 부울 전체 세그먼트에 캠페인 또는 캔버스가 타겟팅하는 메시지를 보낼 때 broadcast을(를) true로 설정해야 합니다. 이 매개변수는 기본적으로 false로 설정됩니다 (2017년 8월 31일 기준).

broadcast가 true로 설정하면 recipients 목록을 포함할 수 없습니다. 그러나 이 플래그를 실수로 설정하면 예상보다 많은 대상에게 메시지를 보낼 수 있으므로 broadcast: true 을 설정할 때는 주의하세요.
audience 선택 사항 연결된 오디언스 객체 연결된 오디언스을 참조하십시오.
recipients 선택 사항 배열 수신자 객체를 참조하십시오.

send_to_existing_onlyfalse인 경우 속성 객체를 포함해야 합니다.

recipients 을 제공하지 않고 broadcast 을 true로 설정하면 캠페인이 타겟팅하는 전체 세그먼트에 메시지가 전송됩니다.

email 이 식별자인 경우 수신자 객체에 다음을 포함해야 합니다. prioritization 를 수신자 객체에 포함해야 합니다.
attachments 선택 사항 배열 broadcast 이 true로 설정되어 있으면 attachments 목록은 포함할 수 없습니다.
  • 수신자 배열에는 최대 50개의 개체가 포함될 수 있으며, 각 개체에는 단일 external_user_id 문자열과 trigger_properties 개체가 포함됩니다.
  • send_to_existing_onlytrue 일 경우, Braze는 기존 사용자에게만 메시지를 보냅니다. 그러나 이 플래그는 사용자 별칭과 함께 사용할 수 없습니다.
  • send_to_existing_onlyfalse 인 경우 속성을 포함해야 합니다. Braze는 메시지를 보내기 전에 id 및 속성을 가진 사용자를 생성합니다.

사용자의 구독 그룹 상태는 attributes 객체 내에 subscription_groups 매개변수를 포함하여 업데이트할 수 있습니다. 자세한 내용은 사용자 속성 개체를 참조하십시오.

요청 예시

응답 세부 정보

메시지를 보내는 엔드포인트 응답에는 메시지 발송을 다시 참조할 수 있도록 메시지의 dispatch_id 주소가 포함됩니다. dispatch_id 은 메시지 발송의 ID로, Braze에서 전송되는 각 전송의 고유 ID입니다. 이 엔드포인트를 사용하면 전체 배치된 사용자 집합에 대해 단일 dispatch_id 을 받게 됩니다. 자세한 내용은 dispatch_id 에서 디스패치 ID 동작에 대한 문서를 참조하세요.

요청에 치명적인 오류가 발생하면 오류 코드와 설명은 오류 및 응답을 참조하세요.

캠페인용 속성 개체

Braze에는 API 트리거 캠페인을 보내기 전에 사용자에 대한 속성 및 값을 추가, 생성 또는 업데이트할 수 있는 attributes 이라는 메시징 개체가 있습니다. 이 API 호출로 campaign/trigger/send 엔드포인트를 사용하면 캠페인을 처리하고 전송하기 전에 사용자 속성 개체를 처리합니다. 이것은 경쟁 조건으로 인해 발생할 수 있는 문제의 위험을 최소화하는 데 도움이 됩니다.

이 페이지가 얼마나 도움이 되었나요?
New Stuff!