> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/message-sending-management.md).

# Message Sending Management

## Validates the message information.

> &#x20; \## Function Description\
> &#x20; \* Validates the message information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Validates the message information.\
> &#x20; \* Validates the message information before modifying it.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/validateSendMessageBaseInfo":{"post":{"tags":["Message Sending Management"],"summary":"Validates the message information.","description":"  ## Function Description\n  * Validates the message information.\n  ---\n  ## Detailed Description\n  * Validates the message information.\n  * Validates the message information before modifying it.\n","operationId":"validateSendMessageBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Validates the message sending target information.

> &#x20; \## Function Description\
> &#x20; \* Validates the message sending target information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Validates the message sending target information.\
> &#x20; \* Checks whether the target is already a registered member before registering the message sending target information.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/validateInsertSendMessageTargetMember":{"post":{"tags":["Message Sending Management"],"summary":"Validates the message sending target information.","description":"  ## Function Description\n  * Validates the message sending target information.\n  ---\n  ## Detailed Description\n  * Validates the message sending target information.\n  * Checks whether the target is already a registered member before registering the message sending target information.\n","operationId":"validateInsertSendMessageTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Sends a test message.

> &#x20; \## Function Description\
> &#x20; \* Sends a test message.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Sends a test message.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/sendTestMessage":{"post":{"tags":["Message Sending Management"],"summary":"Sends a test message.","description":"  ## Function Description\n  * Sends a test message.\n  ---\n  ## Detailed Description\n  * Sends a test message.\n","operationId":"sendTestMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register Message Receiving Target

> &#x20;   \## Function Description\
> &#x20;   \* Saves the data when bulk-registering recipients.\
> &#x20;   \---\
> &#x20;   \## Detailed Description\
> &#x20;   \* When recipients are bulk-registered, the send status is initially saved as 'N'.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseInteger":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"integer","format":"int32","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/saveStMsgTgtMbrInfoExcel":{"post":{"tags":["Message Sending Management"],"summary":"Register Message Receiving Target","description":"    ## Function Description\n    * Saves the data when bulk-registering recipients.\n    ---\n    ## Detailed Description\n    * When recipients are bulk-registered, the send status is initially saved as 'N'.\n","operationId":"saveStMsgTgtMbrInfoExcel","parameters":[{"name":"msgSndNo","in":"query","description":"Message Send No.","required":true,"schema":{"type":"String"}},{"name":"mbrId","in":"query","description":"Member ID","required":true,"schema":{"type":"String"}},{"name":"applyYn","in":"query","description":"Application Status","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Registers the message target member.

> &#x20; \## Function Description\
> &#x20; \* Registers the message target member.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Registers the message target member.\
> &#x20; \* Registers member information not yet registered for the message.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/insertSendMessageTargetMember":{"post":{"tags":["Message Sending Management"],"summary":"Registers the message target member.","description":"  ## Function Description\n  * Registers the message target member.\n  ---\n  ## Detailed Description\n  * Registers the message target member.\n  * Registers member information not yet registered for the message.\n","operationId":"insertSendMessageTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Registers/modifies the message basic information.

> &#x20; \## Function Description\
> &#x20; \* Registers/modifies the message basic information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Registers/modifies the message basic information.\
> &#x20; \* If the message number to be registered is already registered, it is modified.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/insertSendMessageBaseInfo":{"post":{"tags":["Message Sending Management"],"summary":"Registers/modifies the message basic information.","description":"  ## Function Description\n  * Registers/modifies the message basic information.\n  ---\n  ## Detailed Description\n  * Registers/modifies the message basic information.\n  * If the message number to be registered is already registered, it is modified.\n","operationId":"insertSendMessageBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Validate Message Receiving Target

> &#x20;   \## Function Description\
> &#x20;   \* Validates the eligibility of target members when bulk-registering recipients.\
> &#x20;   \---\
> &#x20;   \## Detailed Description\
> &#x20;   \* Returns the applyYn, errorCode, and errorMsg results after validating the bulk registration of recipients.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getMbrInfoValidation":{"post":{"tags":["Message Sending Management"],"summary":"Validate Message Receiving Target","description":"    ## Function Description\n    * Validates the eligibility of target members when bulk-registering recipients.\n    ---\n    ## Detailed Description\n    * Returns the applyYn, errorCode, and errorMsg results after validating the bulk registration of recipients.\n","operationId":"getMbrInfoValidation","parameters":[{"name":"msgSndNo","in":"query","description":"Message Send No.","required":true,"schema":{"type":"String"}},{"name":"mbrId","in":"query","description":"Member ID","required":true,"schema":{"type":"String"}},{"name":"mbrNm","in":"query","description":"Member Name","required":true,"schema":{"type":"String"}},{"name":"validationType","in":"query","description":"Validation Type","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Deletes the message target member.

> &#x20; \## Function Description\
> &#x20; \* Deletes the message target member.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Deletes the message target member.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/sendMessageMgmt/deleteSendMessageTargetMember":{"post":{"tags":["Message Sending Management"],"summary":"Deletes the message target member.","description":"  ## Function Description\n  * Deletes the message target member.\n  ---\n  ## Detailed Description\n  * Deletes the message target member.\n","operationId":"deleteSendMessageTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Short URL

> &#x20; \## Function Description\
> &#x20; \* Retrieves the short URL information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the short URL information.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"SendMessageMgmtResponse":{"type":"object","description":"Message Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgTypCd":{"type":"string","description":"Message Type Code"},"msgTypCdNm":{"type":"string","description":"Message Type Name"},"msgSndTypCd":{"type":"string","description":"Send Type Code"},"msgSndTypCdNm":{"type":"string","description":"Send Type Name"},"msgSndMethCd":{"type":"string","description":"Send Method Code"},"msgSndMethCdNm":{"type":"string","description":"Send Method Name"},"msgSndStatCd":{"type":"string","description":"Send Status Code"},"msgSndStatCdNm":{"type":"string","description":"Send Status Name"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"msgSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"msgSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"siteNm":{"type":"string","description":"Site Name"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"recvmnVetoNo":{"type":"string","description":"Recipient Rejection No."},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"msgSndSeq":{"type":"string","description":"Message Sending Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"recvmnNo":{"type":"string","description":"Recipient No."},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"shortUrl":{"type":"string","description":"Short URL"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getShortUrl":{"get":{"tags":["Message Sending Management"],"summary":"Retrieve Short URL","description":"  ## Function Description\n  * Retrieves the short URL information.\n  ---\n  ## Detailed Description\n  * Retrieves the short URL information.\n","operationId":"getShortUrl","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}},{"name":"linkUrl","in":"query","description":"URL Address","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SendMessageMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Message Recipient Information List

> &#x20; \## Function Description\
> &#x20; \* Retrieves the message recipient list.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the message recipient list.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"RealGridListResponseSendMessageMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtResponse"}}}},"SendMessageMgmtResponse":{"type":"object","description":"Message Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgTypCd":{"type":"string","description":"Message Type Code"},"msgTypCdNm":{"type":"string","description":"Message Type Name"},"msgSndTypCd":{"type":"string","description":"Send Type Code"},"msgSndTypCdNm":{"type":"string","description":"Send Type Name"},"msgSndMethCd":{"type":"string","description":"Send Method Code"},"msgSndMethCdNm":{"type":"string","description":"Send Method Name"},"msgSndStatCd":{"type":"string","description":"Send Status Code"},"msgSndStatCdNm":{"type":"string","description":"Send Status Name"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"msgSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"msgSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"siteNm":{"type":"string","description":"Site Name"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"recvmnVetoNo":{"type":"string","description":"Recipient Rejection No."},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"msgSndSeq":{"type":"string","description":"Message Sending Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"recvmnNo":{"type":"string","description":"Recipient No."},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"shortUrl":{"type":"string","description":"Short URL"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getSendMessageTargetMemberList":{"get":{"tags":["Message Sending Management"],"summary":"Retrieve Message Recipient Information List","description":"  ## Function Description\n  * Retrieves the message recipient list.\n  ---\n  ## Detailed Description\n  * Retrieves the message recipient list.\n","operationId":"getSendMessageTargetMemberList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}},{"name":"mbrNo","in":"query","description":"Member No.","schema":{"type":"String"}},{"name":"sndRes","in":"query","description":"Send Result","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSendMessageMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Message Sending Information List

> &#x20; \## Function Description\
> &#x20; \* Retrieves the message sending list.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the message sending list.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"RealGridListResponseSendMessageMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SendMessageMgmtResponse"}}}},"SendMessageMgmtResponse":{"type":"object","description":"Message Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgTypCd":{"type":"string","description":"Message Type Code"},"msgTypCdNm":{"type":"string","description":"Message Type Name"},"msgSndTypCd":{"type":"string","description":"Send Type Code"},"msgSndTypCdNm":{"type":"string","description":"Send Type Name"},"msgSndMethCd":{"type":"string","description":"Send Method Code"},"msgSndMethCdNm":{"type":"string","description":"Send Method Name"},"msgSndStatCd":{"type":"string","description":"Send Status Code"},"msgSndStatCdNm":{"type":"string","description":"Send Status Name"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"msgSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"msgSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"siteNm":{"type":"string","description":"Site Name"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"recvmnVetoNo":{"type":"string","description":"Recipient Rejection No."},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"msgSndSeq":{"type":"string","description":"Message Sending Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"recvmnNo":{"type":"string","description":"Recipient No."},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"shortUrl":{"type":"string","description":"Short URL"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getSendMessageList":{"get":{"tags":["Message Sending Management"],"summary":"Retrieve Message Sending Information List","description":"  ## Function Description\n  * Retrieves the message sending list.\n  ---\n  ## Detailed Description\n  * Retrieves the message sending list.\n","operationId":"getSendMessageList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}},{"name":"searchPeriod","in":"query","description":"Search Period Type","schema":{"type":"String"}},{"name":"sndStrDtm","in":"query","description":"Search Period Start Date","schema":{"type":"LocalDate"}},{"name":"sndEndDtm","in":"query","description":"Search Period End Date","schema":{"type":"LocalDate"}},{"name":"msgSndMethCd","in":"query","description":"Send Method (CM019)","schema":{"type":"String"}},{"name":"searchCondition","in":"query","description":"Search Condition (Message Content/No.)","schema":{"type":"String"}},{"name":"searchConditionContents","in":"query","description":"Search Condition Details","schema":{"type":"String"}},{"name":"msgSndStatCd","in":"query","description":"Send Status (CM018)","schema":{"type":"String"}},{"name":"msgTypCd","in":"query","description":"Message Type (CM021)","schema":{"type":"String"}},{"name":"msgSndTypCd","in":"query","description":"Send Type (CM020)","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSendMessageMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Message Basic Information

> &#x20; \## Function Description\
> &#x20; \* Retrieves the message basic information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the message basic information.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SendMessageMgmtRequest":{"type":"object","description":"Message Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date","description":"Search Period End Date"},"msgSndMethCd":{"type":"string","description":"Send Method (CM019)"},"searchCondition":{"type":"string","description":"Search Condition (Message Content/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"msgSndStatCd":{"type":"string","description":"Send Status (CM018)"},"msgTypCd":{"type":"string","description":"Message Type (CM021)"},"msgSndTypCd":{"type":"string","description":"Send Type (CM020)"},"sndRes":{"type":"string","description":"Send Result"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"recvmnNo":{"type":"string","description":"Mobile Phone No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrCellNo":{"type":"string","description":"Mobile Phone No."},"mbrStatCd":{"type":"string","description":"Member Status"},"smsRecvAgrYn":{"type":"string","description":"SMS Reception Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationMsgCnt":{"type":"integer","format":"int32","description":"Message Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"linkUrl":{"type":"string","description":"URL Address"},"dateSelect":{"type":"string","description":"Select Search Period"}}},"SendMessageMgmtResponse":{"type":"object","description":"Message Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"msgSndNo":{"type":"string","description":"Message No."},"msgTitle":{"type":"string","description":"Message Title"},"msgConts":{"type":"string","description":"Message Content"},"msgTypCd":{"type":"string","description":"Message Type Code"},"msgTypCdNm":{"type":"string","description":"Message Type Name"},"msgSndTypCd":{"type":"string","description":"Send Type Code"},"msgSndTypCdNm":{"type":"string","description":"Send Type Name"},"msgSndMethCd":{"type":"string","description":"Send Method Code"},"msgSndMethCdNm":{"type":"string","description":"Send Method Name"},"msgSndStatCd":{"type":"string","description":"Send Status Code"},"msgSndStatCdNm":{"type":"string","description":"Send Status Name"},"msgSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"msgSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"msgSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"siteNm":{"type":"string","description":"Site Name"},"recvmnVetoNoCd":{"type":"string","description":"Recipient Rejection Number Code"},"recvmnVetoNo":{"type":"string","description":"Recipient Rejection No."},"msgImgPathNm":{"type":"string","description":"Message Image Path"},"msgImgFileNm":{"type":"string","description":"Message Image File Name"},"msgSndSeq":{"type":"string","description":"Message Sending Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"recvmnNo":{"type":"string","description":"Recipient No."},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"shortUrl":{"type":"string","description":"Short URL"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getSendMessageBaseInfo":{"get":{"tags":["Message Sending Management"],"summary":"Retrieve Message Basic Information","description":"  ## Function Description\n  * Retrieves the message basic information.\n  ---\n  ## Detailed Description\n  * Retrieves the message basic information.\n","operationId":"getSendMessageBaseInfo","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendMessageMgmtRequest"}},{"name":"msgSndNo","in":"query","description":"Message No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SendMessageMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Issue New Message No.

> &#x20; \## Function Description\
> &#x20; \* Issues a new message number.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Issues a new message number.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/sendMessageMgmt/getNextMsgSndNo":{"get":{"tags":["Message Sending Management"],"summary":"Issue New Message No.","description":"  ## Function Description\n  * Issues a new message number.\n  ---\n  ## Detailed Description\n  * Issues a new message number.\n","operationId":"getNextMsgSndNo","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
