객체 스키마 #
Response #
| Name | Type | Description |
|---|---|---|
| code | String | 메시지 발송 요청에 대한 결과 응답코드 |
| message | String | 메시지 발송 요청에 대한 결과 코드 설명 |
| data | List | 메시지 발송 요청에 대한 결과 데이터 목록 |
| data.cliKey | String | 클라이언트키: 고객사에서 부여하는 메시지 고유 키 |
| data.msgKey | String | U+ 메시지 허브 시스템에서 부여한 메시지 고유 키 |
| data.phone | String | 수신번호 |
| data.code | String | 메시지 발송 결과 코드 |
| data.message | String | 메시지 발송 결과 코드 설명 |
Agency : 특수부가통신사업자/RCS대행사 정보 #
| Name | Type | Required | Description |
|---|---|---|---|
| kisaOrigCode | String | false | 특수부가통신등록증의 “등록번호”에서 숫자만 사용 |
| rcsAgencyId | String | false | RBC에 등록된 대행사 ID (RCS 사용하는 경우만 사용) |
| rcsAgencyKey | String | false | RBC에서 발급한 대행사 Key (RCS 사용하는 경우만 사용) |
RecvInfo : 개별 수신 정보 #
| Name | Type | Required | Description |
|---|---|---|---|
| cliKey | String | true | 클라이언트키: 고객사에서 부여하는 메시지 고유 키(^[a-zA-Z0-9-_.@]{1,30}$) |
| phone | String | true | 수신번호(^[0-9-]{1,20}$) |
| mergeData | HashMap<String, String> | false | 가변데이터 |
| userCustomFields | HashMap<String, String> | false | 웹훅 추가필드 데이터 |
FbInfo : fallback 정보 #
| Name | Type | Required | Description |
|---|---|---|---|
| ch | String | true | 채널(SMS/MMS) |
| title | String | SMS: false, MMS: true | 제목 , 최대 40Byte |
| msg | String | true | 메시지 |
| fileId | String | false | 파일 아이디 MMS : fileId, fileIdLst 둘 중 하나만 사용 가능(파일 1개만 가능) |
| fileIdLst | List | false | 파일 아이디 목록 MMS : fileId, fileIdLst 둘 중 하나만 사용 가능(파일 3개 까지만 가능) ex) “fileIdLst”: [ “file1”, “file2”, “file3”] |
FbReason : Fallback 결과 #
| Name | Type | Required | Description |
|---|---|---|---|
| ch | String | true | 채널 |
| fbResultCode | String | true | fb 결과코드 |
| fbResultDesc | String | true | fb 결과설명 |
| telco | String | false | 이통사(*xMS, RCS만 해당) 또는 카카오 딜러사(API Key 설정: 결과 딜러사 정보 제공 Y인 경우) |