POST /api/push/send
푸시 그룹의 모든 휴대폰에 알림을 보내요.
본문
| 필드 | 유형 | 설명 |
|---|---|---|
pushGroupId | string | 필수. 보낼 대상 그룹이에요. |
title | string | 굵게 표시되는 첫 줄이에요. 제목, 메시지 중 하나 또는 둘 다 보내세요. |
subtitle | string | 제목 아래 줄이에요. |
message | string | 본문 텍스트예요. 제목, 메시지 중 하나 또는 둘 다 보내세요. |
imageUrl | string | 알림과 함께 표시되는 이미지예요. WebP, PNG, JPEG를 쓸 수 있어요. |
actionURL | string | 탭하면 열리는 페이지예요. http:// 또는 https://로 시작해야 해요. 없으면 탭할 때 앱에서 그룹이 열려요. |
name | string | 대시보드 로그에서 이 메시지를 구분하는 라벨이에요. 휴대폰에는 보이지 않아요. |
예시
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/push/send \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "pushGroupId": "acme-orders", "title": "Your order shipped!", "subtitle": "Order #1234", "message": "Your package is on the way. Expected delivery: tomorrow by 5 PM.", "imageUrl": "https://acme.example/shipped.webp", "actionURL": "https://acme.example/orders/1234", "name": "Shipping notice" }'
응답
targeted 값은 알림을 보낸 휴대폰 수예요. 아무도 참여하지 않았으면 0이고, 그때는 아무것도 청구되지 않아요.
1 2 3 4 5 6
{ "ok": true, "targeted": 42, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders" }
전송
- 전송은 바로 나가요. 실시간 현황 업데이트처럼 합쳐지지 않으니, 두 번 보내면 알림도 두 개예요.
- 모든 알림은 휴대폰에 알림을 울려요. 조용한 전송은 없어요.
- 꺼진 휴대폰은 다시 켜지면 받아요. 최대 3일까지예요. iPhone은 가장 최신 알림만 보관해요.
- 알림을 받은 휴대폰 한 대가 푸시 한 건으로 계산돼요. 전송 및 요금을 참고하세요.
오류
| 상태 | 의미 |
|---|---|
| 400 | pushGroupId 값이 없거나, title과 message가 모두 없거나, actionURL 값이 http 또는 https가 아닐 때. |
| 402 | FREE_TIER_LIMIT_REACHED: 무료 요금제의 월간 푸시를 모두 썼어요. 누군가 참여한 경우에만 발생해요. |
| 413 | 알림이 4KB를 넘어요. 텍스트를 줄이세요. |
다른 모든 오류는 오류 및 한도에 있어요.
