#9119 메시지 요청 본문 예시 페이지 분리 #31
Open
+1,194
−1,108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpshjee
reviewed
Mar 19, 2025
ko/api-guide-v1x0/message-example.md
Outdated
|
|
||
| <span id="sms-sms"></span> | ||
|
|
||
| ### SMS(단문문) |
There was a problem hiding this comment.
@gimbimloki (단문) 으로 변경되어야할것 같습니다.
Comment on lines
+6
to
+10
| <h1>메시지 - 발송 요청 본문 예시</h1> | ||
|
|
||
| **Notification > Notification Hub > API v1.0 사용 가이드 > 메시지 - 발송 요청 본문 예시** | ||
|
|
||
|
|
There was a problem hiding this comment.
@gimbimloki 나중에 flow 발송예시, template 발송예시도 추가될걸 대비해서, 어떤 api의 예시인지 나오면 좋을 것 같습니다.
message.md에는 예시들이 ## 메시지 채널별 자유 양식 메시지 발송 요청 본문 예시 하위에 있었는데 현재는 빠져있는것 같습니다.
hiasince
reviewed
Mar 19, 2025
| | content.unsubscribePhoneNumber | String | N | 080 수신 거부 번호, 발송 목적이 광고인 경우 필수 | | ||
| | content.smsType | String | Y | SMS 타입, 메시지 유형이 SMS인 경우 필수, STANDALONE(스탠다드) | | ||
| | content.cards | Object Array | Y | 카드 | | ||
| | content.cards[].title | String | N | 제목 | |
There was a problem hiding this comment.
@gimbimloki
RCS-SMS 예시 경우에는 title 필드는 제외되어야할 것 같습니다
| | sender | Object | Y | 발신자 | | ||
| | sender.senderPhoneNumber | String | Y | 발신자 번호 | | ||
| | content | Object | Y | 메시지 내용 | | ||
| | content.messageType | String | Y | SMS | |
There was a problem hiding this comment.
@gimbimloki
RCS와 동일하게 설명에 적는게 어떨까요?
SMS 내 메시지 유형, SMS, LMS, MMS
There was a problem hiding this comment.
@hiasince RCS와 다르게 해당 예시는 SMS(단문) 예시이기 때문에 SMS만 적었습니다.
ko/api-guide-v1x0/message-example.md
Outdated
| | content | Object | Y | 메시지 내용 | | ||
| | content.messageType | String | Y | MMS | | ||
| | content.body | String | Y | 내용 | | ||
| | content.attachmentIds | String Array | Y | 첨부 파일 아이디 | |
There was a problem hiding this comment.
@gimbimloki
Email에는 첨부파일의 제약사항이 기재되어있는 것 같은데, SMS에도 동일하게 기재하는게 어떨까요?
기존 SMS 상품 쪽에 적혀있는 제약사항 공유드립니다.
첨부 이미지 제한 사항
지원 코덱: .jpg, .jpeg
첨부 이미지 개수: 3개 이하
첨부 이미지 사이즈: 1개당 300KB 이하. 단, 첨부한 이미지의 개수가 3개일 경우 합산 800KB 이하.
첨부 이미지 해상도: 1000*1000 이하
ko/api-guide-v1x0/message-example.md
Outdated
Comment on lines
1166
to
1190
| | content | Object | Y | 메시지 내용 | | ||
| | content.unsubscribePhoneNumber | String | 푸시 메시지 수신 거부를 위한 대표 번호 | | ||
| | content.unsubscribeGuide | String | 푸시 메시지 수신 거부를 위한 안내 | | ||
| | content.title | String | Y | 제목 | | ||
| | content.String | Y | 내용 | | ||
| | content.style.useHtmlStyle | Boolean | Y | HTML 스타일 사용(Android에서만 가능) | | ||
| | content.richMessage | Object | 리치 메시지 | | ||
| | content.richMessage | Object | N | 리치 메시지 사용시 필요 | | ||
| | content.richMessage.buttons | Object Array | N | 리치 메시지에 추가되는 버튼, 최대 3개까지 가능 | | ||
| | content.richMessage.button.name | String | 버튼 이름 | | ||
| | content.richMessage.button.buttonType | String | 버튼 타입, REPLY, DEEP_LINK, OPEN_APP, OPEN_URL, DISMISS | | ||
| | content.richMessage.button.link | String | 버튼을 눌렀을때, 연결되는 링크 | | ||
| | content.richMessage.button.hint | String | 버튼에대한 힌트 | | ||
| | content.richMessage.media | Object | N | 리치 메시지에 추가되는 미디어 | | ||
| | content.richMessage.media.source | String | 미디어의 위치한 곳의 주소, URL, LOCAL_RESOURCE 가능 | | ||
| | content.richMessage.media.mediaType | String | N | 미디어의 타입, IMAGE, GIF, VEDIO, AUDIO. Android에서는 IMAGE만 지원 | | ||
| | content.richMessage.media.expandable | Boolean | N | Android에서 미디어를 클릭 시 펼침 기능 사용 여부 | | ||
| | content.richMessage.androidMedia | Object | N | Android 기기에 사용되는 미디어. 형식은 media와 동일 | | ||
| | content.richMessage.iosMedia | Object | N | iOS 기기에 사용되는 미디어. 형식은 media와 동일 | | ||
| | content.richMessage.largeIcon | Object | N | 리치 메시지에 추가되는 큰 아이콘, Android에서만 지원 | | ||
| | content.richMessage.largeIcon.source | String | Y | 미디어의 위치한 곳의 주소 | | ||
| | content.richMessage.group | Object | N | 여러 개의 메시지를 그룹 단위로 묶는 기능, Android에서만 지원 | | ||
| | content.richMessage.group.key | String | Y | 그룹의 키 | | ||
| | content.richMessage.group.description | String | Y | 그룹에대한 설명 | | ||
| | content.customKey | Object Array or String Array | N | 사용자 정의 키와 값 | |
There was a problem hiding this comment.
PUSH 쪽 표가 깨져있는 것 같습니다. 확인 부탁드립니다!
hiasince
reviewed
Mar 19, 2025
| @@ -198,1114 +198,6 @@ curl -X POST "${ENDPOINT}/message/v1.0/PUSH/free-form-messages/${MESSAGE_PURPOSE | |||
|
|
|||
| </details> | |||
|
|
|||
| <span id="free-form-message-request-body"></span> | |||
There was a problem hiding this comment.
@gimbimloki
예시를 바로 갈 수 있도록 링크를 걸어두는게 어떨까요?
gimbimloki
commented
Mar 24, 2025
gimbimloki
commented
Mar 24, 2025
gimbimloki
commented
Mar 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
대부분 기존 내용을 옮겨왔고, SMS의 경우 SMS, LMS, MMS 예시를 분리