메인 콘텐츠로 건너뛰기
POST
/
projects
/
{projectId}
/
campaigns
/
{campaignId}
/
send
trigger-campaign
curl --request POST \
  --url https://api.notifly.tech/projects/{projectId}/campaigns/{campaignId}/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "recipients": [
    {
      "type": "phone-number",
      "phoneNumber": "010-1234-5678"
    }
  ]
}'
{
  "code": 200,
  "success": true,
  "error": null
}
API 기반 발송 지원 채널현재 API 기반 발송은 다음 채널에 대해 지원됩니다.
  • 푸시 알림
  • 웹 푸시 알림
  • 카카오 알림톡
  • 카카오 친구톡
  • 문자 메시지
  • 이메일
수신자 유형 지원 범위와 메시지 개인화설정된 캠페인의 발송 채널마다 지원되는 수신자 유형이 다를 수 있습니다. 만약 캠페인의 발송 채널이 지원하지 않는 수신자 유형을 사용하면, API 응답으로 400 Bad Request가 반환됩니다.
  • 푸시 알림: user-id 유형의 수신자만 지원됩니다.
  • 웹 푸시 알림: user-id 유형의 수신자만 지원됩니다.
  • 카카오 알림톡: user-idphone-number 유형의 수신자를 지원합니다.
  • 카카오 친구톡: user-idphone-number 유형의 수신자를 지원합니다.
  • 문자 메시지: user-idphone-number 유형의 수신자를 지원합니다.
  • 이메일: user-id, email 유형의 수신자만 지원됩니다.
수신자 유형이 user-id가 아닌 경우, 노티플라이 서버는 유저 데이터베이스에서 해당 유저에 대한 정보를 받아오지 않고, 요청 payload에 명시되어있는 정보로만 발송을 시도합니다.따라서, 수신자 유형이 user-id가 아닌 경우 유저 기반 메시지 개인화 기능을 사용하실 수 없습니다. 예를 들어, 이 경우 캠페인의 메시지 내용에 {{ user["name"] }} 님 안녕하세요라는 구문이 들어있다면, 개인화는 실패하고 님 안녕하세요라는 메시지가 발송됩니다.이벤트 파라미터는 모든 유형에 대해 사용 가능합니다.
중복 제거API 기반 발송은 중복 발송을 방지하기 위해 수신자의 중복 여부를 체크합니다. 동일한 수신자가 여러 번 포함되어 있는 경우, 중복된 수신자는 한 번만 발송됩니다. 다음은 채널 별 중복 제거 규칙입니다.
  • 푸시 알림: 동일한 디바이스 토큰일 경우, 하나의 디바이스 토큰에만 메시지를 발송합니다.
  • 웹 푸시 알림: 동일한 디바이스 토큰일 경우, 하나의 디바이스 토큰에만 메시지를 발송합니다.
  • 카카오 알림톡: 동일한 전화번호일 경우, 하나의 전화번호에만 메시지를 발송합니다.
  • 카카오 친구톡: 동일한 전화번호일 경우, 하나의 전화번호에만 메시지를 발송합니다.
  • 문자 메시지: 동일한 전화번호일 경우, 하나의 전화번호에만 메시지를 발송합니다.
  • 이메일: 동일한 이메일 주소일 경우, 하나의 이메일 주소에만 메시지를 발송합니다.

Authorizations

Authorization
string
header
required

POST /authenticate로 발급받은 인증 토큰

Path Parameters

projectId
string
required

프로젝트 ID

campaignId
string
required

캠페인 ID (콘솔에서 확인)

Body

application/json
recipients
object[]
required

수신자 목록 (최대 1,000명)

Response

The campaign was triggered successfully.

code
integer
success
boolean
error
string | null