콘텐츠로 건너뛰기
사용자 가이드지원 데모 요청 로그인
Pushwoosh.com

WhatsApp API

createWhatsAppMessage

Anchor link to

사용자에게 WhatsApp 메시지를 보내는 데 사용됩니다

POST https://api.pushwoosh.com/json/1.3/createWhatsAppMessage

요청 본문

Anchor link to
이름
필수
유형설명
auth*예stringPushwoosh Control Panel의 API access token입니다.
application*예stringPushwoosh application code
notifications*예array콘텐츠 설정입니다. 메시지 매개변수의 JSON 배열입니다. 자세한 내용은 아래를 참조하세요.

알림 매개변수

Anchor link to
이름
필수유형설명
send_date*예string알림을 보낼 날짜와 시간입니다. 즉시 보내려면 YYYY-MM-DD HH:mm 형식 또는 'now'를 사용하세요.
contentcontent_id가 제공되지 않은 경우 필수입니다.stringWhatsApp 메시지의 텍스트 콘텐츠입니다.
content_idcontent가 제공되지 않은 경우 필수입니다.stringMeta 계정에서 사전 승인된 WhatsApp 템플릿의 식별자입니다.
devices*예array고객 전화번호입니다(/registerDevice를 사용하여 User ID와 연결하고 hwid 매개변수에 지정하거나 use_auto_registration을 사용해야 합니다). 여기에는 하나의 번호만 지정할 수 있습니다.
use_auto_registration아니요booleantrue로 설정하면 devices 매개변수에 지정된 전화번호가 자동으로 등록됩니다.
content_variables아니요object메시지 콘텐츠를 사용자 정의하기 위한 콘텐츠 변수입니다. 각 플레이스홀더는 해당 동적 값으로 대체됩니다.
button_url_variables아니요object버튼에 대한 동적 URL 변수입니다. 각 키는 버튼 인덱스를 나타내며, 그 값은 버튼의 URL에서 대체될 동적 변수입니다. 참고: 버튼 인덱싱은 0부터 시작하며, 첫 번째 버튼은 0, 두 번째 버튼은 1, 이런 식으로 계속됩니다.
header_variables아니요objectWhatsApp 템플릿 메시지의 헤더에 대한 변수입니다. type(예: text, image, video, document)과 해당 값을 지정합니다. 예시: "header_variables": {"image": "https://image-url.png"}
preset아니요stringControl Panel의 WhatsApp Preset Code입니다.
language아니요stringWhatsApp 템플릿의 언어 로케일입니다(Meta WhatsApp 템플릿 편집기의 로케일과 일치해야 합니다). 기본값: "en_US". 예시: "en_GB".

요청 예시

Anchor link to
{
  "request": {
    "application": "12XXX-67XXX",           // 필수. Pushwoosh 애플리케이션 코드.
    "auth": "yxoPUlwqm…………pIyEX4H",         // 필수. Pushwoosh Control Panel의 API access token.
    "notifications": [{
      "send_date": "now",                   // 필수. YYYY-MM-DD HH:mm 또는 "now".
      "content": "Hello! {{1}}",            // content_id가 제공되지 않은 경우 필수. 메시지 텍스트.
      "content_id": "hello_world",          // content가 제공되지 않은 경우 필수. WhatsApp 템플릿 식별자.
      "devices": ["whatsapp:+1234567890"],  // 필수. 고객 WhatsApp 전화번호 (/registerDevice를 사용하여
                                            //           UserId와 연결하고 "hwid" 매개변수에 지정하거나
                                            //           "use_auto_registration"을 사용해야 함).
                                            //           여기에는 하나의 WhatsApp 번호만 지정할 수 있습니다.
      "preset": "XXXXX-XXXXX",              // 선택 사항. Control Panel의 WhatsApp Preset Code.
      "content_variables": {                // 선택 사항. 메시지 콘텐츠를 사용자 정의하기 위한 콘텐츠 변수.
        "1": "John"
      },
      "header_variables": {                 // 선택 사항. WhatsApp 메시지 헤더에 대한 변수.
        "image": "https://image-url.png"
      },
      "language": "en_GB",                  // 선택 사항. WhatsApp 템플릿의 언어 로케일 (Meta WhatsApp 템플릿 편집기의 로케일과 일치해야 함). 기본값: "en_US".
      "use_auto_registration": true         // 선택 사항. "devices" 매개변수에 지정된 WhatsApp 번호를
                                            //           자동으로 등록합니다.
    }]
  }
}

예시: WhatsApp을 통해 2단계 인증 코드 보내기

Anchor link to
{
    "request": {
        "application":"APP_CODE", "auth":"AUTH_TOKEN",
        "notifications":[{
            "send_date":"now",
            "content_id":"replace_with_your_meta_two_factor_template_name",
            "content_variables":{"1":"AUTH_CODE"},
            "button_url_variables":{"0":"AUTH_CODE"},
            "devices":["whatsapp:REPLACE_WITH_YOUR_PHONE_NO"]
        }]
    }
}

응답 예시

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10EXXX-0D9F2XXX"
    ]
  }
}

오류 응답

Anchor link to
{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}