백업 및 복원

/v1/settings/backup 및 /v1/settings/restore

/v1/settings/backup과 /v1/settings/restore 엔드포인트를 사용하면 간편하게 다른 환경이나 서버로 이동하고 알려진 작업 상태로 복원할 수 있습니다. WhatsApp Business API 클라이언트 또는 서버의 작동이 중단되면 백업을 쉽게 가져올 수 있도록 수시로 백업할 것을 권장합니다.

WhatsApp Business API 클라이언트는 앱 설정과 등록을 포함한 모든 필수 정보의 백업과 복원을 지원합니다.

보안 업데이트

v2.31.4에서 WhatsApp은 다른 WhatsApp 클라이언트(예: 휴대폰 앱) 백업 및 복원 기능의 보안 모델과 일치하도록 백업 및 복원 엔드포인트를 수정했습니다. 이 변경 사항이 적용되면 복원 작업 성공 시 WhatsApp 비즈니스 계정과 해당 연락처 간에 새 보안 코드가 생성됩니다.

WhatsApp 비즈니스 계정이 백업에서 복원되면 '보안 알림' 설정을 활성화한 소비자 클라이언트는 "{Business Account}의 보안 코드가 변경되었습니다. 자세히 알아보려면 탭하세요."라는 알림을 받게 됩니다. 그 외에 다른 모든 백업/복원 동작은 예전과 동일합니다.

시작하기 전에

admin 계정을 사용하여 백업 및 복원 설정에 액세스해야 합니다.

백업

WhatsApp Business API 클라이언트가 등록 및 실행된 경우에만 백업/내보내기 기능을 실행할 수 있습니다. 메시지나 콜백은 백업되지 않으므로 가상 컴퓨터 스냅샷을 캡처하고 복원하더라도 의미가 없습니다.

예

백업하려면 password 필드가 포함된 /v1/settings/backup 엔드포인트를 사용합니다.

POST /v1/settings/backup
{
    "password": "PASSWORD"
}

{
    "settings": {
       "data": "ENCRYPTED_BACKUP_DATA"
    }
}

매개변수

요청 매개변수:

응답 매개변수

복원

복원은 새로운 기기에 WhatsApp Business API 클라이언트의 새 버전을 설정하거나 같은 기기에서 이전 설정과 동일한 암호화 정보 및 설정을 사용하여 알려진 작업 상태로 앱을 복원하는 데 사용할 수 있습니다.

새 기기에서 앱을 설정하려면 Coreapp을 등록하지 않은 상태로 실행해야 합니다. 가져오기에 성공하면 Coreapp이 자동으로 초기화되어 요청을 보내기 시작합니다. 기기에 기존 앱이 있는 상태에서 복원할 경우 해당 앱이 중단되며 docker restart 명령으로 이를 다시 시작해야 합니다.

다중 연결 설정을 복원할 때는 복원할 대상과 동일한 유형의 설정 상태에서 진행해야 합니다. 예를 들어 샤드 2개를 실행한 상태에서 설정을 백업했다면 샤드 2개를 실행하고 복원을 수행해야 합니다.

예

설정을 복원하려면 password 및 data 필드가 포함된 /v1/settings/restore 엔드포인트를 사용하세요.

POST /v1/settings/restore
{
    "password": "your-password",
    "data": "your-encrypted-backup-data"
}

WhatsApp Business API 클라이언트는 가져오기 이후에 종료됩니다. 특정 배포(예: AWS)에서는 앱이 자동으로 다시 시작됩니다. 그렇지 않은 경우 docker restart 명령을 사용하여 서비스를 다시 시작해야 합니다.

요청이 성공하면 HTTP 상태 코드 200 OK와 null 또는 {}가 반환됩니다. 오류가 발생하면 오류 및 상태 메시지를 참조하세요.

매개변수