온프레미스 API용 Webhooks
비즈니스가 수신한 메시지와 고객 프로필 업데이트에 대한 알림을 받으려면 Webhooks를 구독하세요. WhatsApp Business 플랫폼 Webhooks에 대한 자세한 내용은 개요, Webhooks를 참조하세요.
Webhooks 설정은 WhatsApp Business 앱에 등록된 전화번호에 영향을 미치지 않습니다. WhatsApp Business 플랫폼으로 전화번호를 마이그레이션한 경우에만 WhatsApp Business 앱에서 더 이상 해당 전화번호를 사용할 수 없습니다.
시작하기 전에
다음과 같은 항목이 필요합니다.
- HTTPS를 지원하고 유효한 SSL 인증서가 있는 코드
- Coreapp에서 보낸 인바운드 요청을 수락하도록 구성된 콜백 URL 엔드포인트
- 알림을 수신했을 때
HTTPS 200 OK응답을 반환하는 콜백 URL 엔드포인트
재시도
어떤 이유로든 알림이 전송되지 않거나 Webhooks 요청이 200 외에 다른 HTTP 상태 코드를 반환하면 전송을 다시 시도합니다. 지연 시간이 점차 늘어나 특정 시간 초과에 도달하거나(일반적으로 24시간이지만 차이가 있을 수 있음) 전송이 성공할 때까지 다시 시도합니다.
콜백 URL 엔드포인트 설정
webhooks 매개변수를 콜백 URL 엔드포인트로 설정하고 PATCH 요청을 /v1/settings/application 엔드포인트로 전송합니다. 다른 일반적으로 구성하는 매개변수로는 sent_status와 callback_persist가 있습니다.
요청 예시
PATCH /v1/settings/application
{
"callback_persist": true,
"sent_status": true, // Either use this or webhooks.message.sent, but webhooks.message.sent property is preferred as sent_status will be deprecated soon
"webhooks": {
"url": "webhook.your-domain",
"message": { // Available on v2.41.2 and above
"sent": false,
"delivered": true,
"read": false
},
}
}
요청이 성공하면 응답에 null 또는 JSON 개체와 함께 200 OK가 포함됩니다.
앱 구성, 추가적인 Webhooks 매개변수에 대한 자세한 내용은 앱 설정 참고 자료를 참조하세요.
Webhooks 알림 페이로드
트리거 이벤트가 발생할 때마다 WhatsApp Business 플랫폼은 이벤트를 확인하고 이전에 지정한 Webhooks URL로 알림을 전송합니다. 두 가지 유형의 알림을 받을 수 있습니다.
- 수신된 메시지: 이 알림은 메시지를 수신했을 때 알려줍니다. 이 문서에서는 '인바운드 알림'이라고 지칭하기도 합니다.
- 메시지 상태 및 가격 알림: 이 알림은 메시지 상태가 변경되었을 때 알려줍니다(예: 메시지를 읽었거나 전달된 경우). 이 문서에서는 '아웃바운드 알림'이라고 지칭하기도 합니다.
각 필드에 대한 자세한 내용은 구성 요소를 참조하세요.
오류 알림
{
"errors": [ {
"code": <error-code>,
"title": "<error-title>",
"details": "<error-description>",
"href": "location for error detail"
},
{
...
}
]
}
