POST /api/push/start
푸시 그룹을 만들고 참여 버튼을 받아요.
키는 x-api-key 헤더로 보내세요. 그룹 생성은 절대 청구되지 않아요. 오류는 오류 및 한도에 정리돼 있어요.
본문
| 필드 | 유형 | 설명 |
|---|---|---|
group | string | 필수. 앱에서 사람들이 보는 그룹 이름이에요. |
pushGroupId | string | 필수. 그룹을 가리키는 텍스트면 무엇이든 돼요. 모든 전송과 브랜딩 호출에 쓰여요. |
brand | object | 그룹의 브랜드예요. 아래를 참고하세요. |
reuse | boolean | true이면 참여하는 휴대폰마다 그룹의 자체 사본을 받아서, 휴대폰마다 참여한 웹사이트가 기록돼요. 어느 쪽이든 전송은 모든 휴대폰에 도착해요. |
브랜드 객체
| 필드 | 유형 | 설명 |
|---|---|---|
logo | string | 정사각형 이미지 URL이에요. 모든 알림과 앱에 표시되는 그룹 사진이에요. |
name | string | 앱에 표시되는 브랜드 이름이에요. 생략하면 브랜드 이름이 표시되지 않아요. |
description | string | 앱에 표시되는 그룹 소개 한 줄이에요. |
brand.color와 brand.title은 실시간 현황용 필드예요. 푸시 그룹은 무시해요.
예시
1 2 3 4 5 6 7 8 9 10 11 12 13
curl -X POST https://api.webliveactivity.com/api/push/start \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "group": "Acme Orders", "pushGroupId": "acme-orders", "reuse": true, "brand": { "name": "Acme", "logo": "https://acme.example/logo.webp", "description": "Order updates from Acme" } }'
응답
201로 응답해요. groupId 값은 참여 버튼이 쓰는 id예요. 웹 페이지에 links.iframe 값을 넣으세요. 버튼은 실행 버튼과 똑같이 작동하고, 버튼 유형은 notify, subscribe, follow 중 하나예요.
1 2 3 4 5 6 7 8
{ "ok": true, "groupId": "pg-7hk3mzq2wd9x", "pushGroupId": "acme-orders", "links": { "iframe": "<iframe src=\"https://api.webliveactivity.com/embed/button?type=notify&userId=pg-7hk3mzq2wd9x\" width=\"340\" height=\"95\" style=\"border:0;color-scheme:light\"></iframe>" } }
참고
- start를 호출할 때마다 새 참여 버튼이 만들어져요. 같은
pushGroupId값으로 다시 시작하면 같은 그룹에 버튼이 하나 더 생기고, 전송은 어느 버튼으로 참여한 휴대폰에든 도착해요. - 나중에 이름이나 브랜드를 바꾸려면 POST /api/push/branding 호출을 쓰세요.
- 푸시 그룹은 웹훅을 보내지 않아요.
