POST /api/end
휴대폰에서 하나 이상의 실시간 현황을 없애요.
종료하면 카드가 소리 없이 바로 사라져요. 마지막 디자인을 화면에 남기려면 업데이트로 보낸 다음 나중에 종료하세요. 대상 지정은 update와 같아요.
기록은 남아 있어서 restart: true 설정으로 업데이트하면 카드를 다시 띄울 수 있어요. 무료 요금제 한도는 종료를 막지 않아요.
실시간 현황 id로
1 2 3 4 5 6 7
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityId": "act-8f2cqa4mx7rd", "widgetContainerId": "acme-orders" }'
여러 실시간 현황 id로
1 2 3 4 5 6 7 8 9 10
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityIds": [ "act-8f2cqa4mx7rd", "act-9k4d2bwh6tne" ], "widgetContainerId": "acme-orders" }'
그룹으로
한 번의 호출로 그룹의 모든 실시간 현황을 종료해요.
1 2 3 4 5 6 7
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "group": "order-tracker", "widgetContainerId": "acme-orders" }'
최종 상태 저장하기
finalState 값은 업데이트처럼 저장된 상태에 병합돼요. 카드에는 표시되지 않아요. 나중에 재시작하면 이 상태에서 시작해요.
1 2 3 4 5 6 7 8 9 10 11 12
curl -X POST https://api.webliveactivity.com/api/end \ -H 'Content-Type: application/json' \ -H 'x-api-key: wla_your_key' \ -d '{ "activityId": "act-8f2cqa4mx7rd", "widgetContainerId": "acme-orders", "finalState": { "primaryText": "Delivered", "progress": 1, "isComplete": true } }'
응답
update와 같은 { ok, targeted, unknown } 형태로 반환해요.
1 2 3 4 5
{ "ok": true, "targeted": 1, "unknown": [] }
