변수 예문 사전

템플릿 미리보기를 사람이 읽을 수 있게 만드는 예문을 등록해요.

템플릿 본문에는 #{user_name} 같은 자리표시자가 들어가요. 그대로 보면 무슨 메시지인지 알기 어려워서, 채널마다 표시용 예문​​을 등록해 두면 미리보기가 홍길동처럼 읽혀요.

요청 파라미터

보낸 키만 덮어쓰는 부분 갱신​​이에요. 기존에 있던 다른 변수의 예문은 그대로 남아요. 한 채널 안에서는 같은 변수에 같은 예문이 적용돼요. 값을 빈 문자열로 보내면 무시돼서, 이 API로 예문을 지울 수는 없어요. . 이 들어가거나 $ 로 시작하는 키도 오류 없이 버려져요.

코드 예제

curl -X PUT "https://message.bootapi.com/alimtalk/senders/6a718d6cdd5558fb1fff72af/variable_examples" \
  -H "Authorization: Basic {base64(client_key:secret_key)}" \
  -H "Content-Type: application/json" \
  -d '{
    "examples": {
      "user_name": "홍길동",
      "company_name": "부트페이몰"
    }
  }'bash

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: 'your-commerce-client-key', secret_key: 'your-commerce-secret-key')
response = commerce.alimtalk_sender_variable_examples(
  ksp_id: '6a718d6cdd5558fb1fff72af',
  examples: {
    user_name: '홍길동',
    company_name: '부트페이몰'
  }
)
puts response.dataruby

응답

갱신된 사전 전체를 돌려줘요.

{
  "ksp_id": "6a718d6cdd5558fb1fff72af",
  "variable_examples": {
    "user_name": "홍길동",
    "company_name": "부트페이몰",
    "order_number": "20260827-0001"
  }
}json

에러 코드