Sending Alternative Messages in Multi-channel
Multi-channel alternative message is a service that allows you to send alternative messages through various channels, unlike the existing alternative message that only supported SMS and LMS. Multi-channel alternative message is rule-based, and you must set the order of alternative message types on the web. Multi-channel alternative message is mapped one-to-one with department codes. When department codes are attached, alternative message will be sent accordingly. (Department code can be created on the web.)
If an alternate message type is specified in the data, alternative messages of SMS or LMS will be sent just once.
Note
- A separate contract is required to use the multi-channel alternative message.
- Web screens required to send a multi-channel alternative message will be provided later.
- For multi-channel alternative message, a separate column must be added to the existing table.
Request Information
Category | Field | Type | Description |
---|---|---|---|
Common | department_cd | String | Department code - need to send by referring to multi-channel alternative message rules mapped to department codes |
XMS | fall_back_yn | String | Whether to use alternative sending - To add as there was no alternative message for XMS |
XMS | fall_back_title | String | Title of alternative sending - To add as there was no alternative message for XMS |
XMS | fall_back_message | String | Alternative message details - To add as there was no alternative message for XMS |
Note
- Before calling every BizMessage API, you must call OAuth 2.0 API in advance.
- Please refer to the Sample Code document for API-specific codes.
Warning
As the staging server is linked to the Kakao operation server and actually sends messages, please be careful to avoid sending messages incorrectly.
Retrieveing Message Delivery Result
With the Push method, it is not possible to check the message delivery result at the same time as sending. In this case, you can use this API to check the message delivery result of each message.
Note
After calling this API, be sure to call the Closing Message Delivery Result Retrieval Request API not to retrieve the processed results again.
Request
Request Syntax
코드예제Request Syntax of Retrieveing Message Delivery Result
curl -X 'GET' \
'https://{base_url}/v2/info/report/results' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
Method | URL |
---|---|
GET | https://{base_url}/v2/info/report/results |
Parameter | Type | Required | Class | Category | Description |
---|---|---|---|---|---|
base_url | String | Y |
Operating | General | bizmsg-web.kakaoenterprise.com |
Finance | bizmsg-bank.kakaoenterprise.com |
||||
Stock | bizmsg-stock.kakaoenterprise.com |
||||
Public institution | bizmsg-gov.kakaoenterprise.com |
||||
Staging | General | stg-user.bizmsg.kakaoenterprise.com |
|||
Finance | stg-bizmsg-bank.kakaoenterprise.com |
||||
Stock | stg-bizmsg-stock.kakaoenterprise.com |
||||
Public institution | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
코드예제Request Header of Requesting Message Delivery ResultParameter | Type | Required | Description |
---|---|---|---|
accept | String | Y |
*/* |
Authorization | String | Y |
Bearer {oauthToken} - {oauthToken} : Access token acquired by OAuth 2.0 API |
client_id | String | N |
Customer ID |
message_types | String[] | N |
Message type to query |
Response
Response Syntax
코드예제Response Syntax of Retrieveing Message Delivery Result
{
"code": "200",
"code_detail": {
"detail_code": "",
"detail_message": "success"
},
"report_group_no": "8493608862033069978",
"results": [
{
"cid": "77613652af2d464580796c41cf0d39a3",
"uid": "220918080309405KFXrvK8CR9e+k8s",
"message_type": "AT",
"final_message_type": "RCSSMS",
"status_code": "API_200",
"broker_status_code": "0000",
"error_message": "success",
"req_date": "2022-12-07T04:58:36.656Z",
"res_date": "2022-12-07T04:58:36.656Z"
}
]
}
Response Elements
코드예제Response Elements of Retrieveing Message Delivery ResultField | Type | Required | Description |
---|---|---|---|
code | String | N |
Message delivery result code |
100 : In processing |
|||
200 : Success |
|||
400 : Authorization error |
|||
410 : Invalid input value |
|||
420 : File/image error |
|||
500 : Internal system error |
|||
510 : Failed to send |
|||
520 : Failed but can be resent |
|||
Object | N |
Code detail | |
detail_code | String | N |
Detailed code |
detail_message | String | N |
Detailed message |
report_group_no | String | N |
Unique number of message result group |
Array | N |
List of message result | |
uid | String | N |
Message key ID |
cid | String | N |
Key ID defined by customer |
message_type | String | N |
Originally requested message type |
final_message_type | String | N |
Last sent message type |
status_code | String | N |
Message status code - For details, refer to API Message Status Code. |
broker_status_code | String | N |
Status code sent from sender |
error_message | String | N |
Result message |
req_date | String | N |
Request date |
res_date | String | N |
Completion date |
Closing Message Delivery Result Retrieval Request
This API is used to close the request of retrieving the message delivery result.
Request
Request Syntax
코드예제Request Syntax of Closing Message Delivery Result Retrieval Request
curl -X 'PUT' \
'https://{base_url}/v2/info/report/results/complete/{report_group_no}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
Method | URL |
---|---|
PUT | https://{base_url}/v2/info/report/results/complete/{report_group_no} |
Parameter | Type | Required | Class | Category | Description |
---|---|---|---|---|---|
base_url | String | Y |
Operating | General | bizmsg-web.kakaoenterprise.com |
Finance | bizmsg-bank.kakaoenterprise.com |
||||
Stock | bizmsg-stock.kakaoenterprise.com |
||||
Public institution | bizmsg-gov.kakaoenterprise.com |
||||
Staging | General | stg-user.bizmsg.kakaoenterprise.com |
|||
Finance | stg-bizmsg-bank.kakaoenterprise.com |
||||
Stock | stg-bizmsg-stock.kakaoenterprise.com |
||||
Public institution | stg-bizmsg-gov.kakaoenterprise.com |
||||
report_group_no | String | Y |
Unique number of message result group |
Request Header
코드예제Request Header of Closing Message Delivery Result Retrieval RequestParameter | Type | Required | Description |
---|---|---|---|
accept | String | Y |
*/* |
Authorization | String | Y |
Bearer {oauthToken} - {oauthToken} : Access token acquired by OAuth 2.0 API |
Response
Response Syntax
코드예제Response Syntax of Closing Message Delivery Result Retrieval Request
{
"code": "200",
"code_detail": {
"detail_code": "",
"detail_message": "success"
}
}
Response Elements
코드예제Response Elements of Closing Message Delivery Result Retrieval RequestField | Type | Required | Description |
---|---|---|---|
code | String | N |
Message delivery result code |
100 : In processing |
|||
200 : Success |
|||
400 : Authorization error |
|||
410 : Invalid input value |
|||
420 : File/image error |
|||
500 : Internal system error |
|||
510 : Failed to send |
|||
520 : Failed but can be resent |
|||
Object | N |
Message status code | |
detail_code | String | N |
Detailed code |
detail_message | String | N |
Detailed message |
Retrieving Detailed Message Delivery Result
This API is used to retrieve the detailed delivery result of every type of message.
Request
Request Syntax
코드예제Request Syntax of Retrieving Detailed Message Delivery Result
curl -X 'GET' \
'https://{base_url}/v2/info/report/search/detail/{uid}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
Method | URL |
---|---|
GET | https://{base_url}/v2/info/report/search/detail/{uid} |
Parameter | Type | Required | Class | Category | Description |
---|---|---|---|---|---|
base_url | String | Y |
Operating | General | bizmsg-web.kakaoenterprise.com |
Finance | bizmsg-bank.kakaoenterprise.com |
||||
Stock | bizmsg-stock.kakaoenterprise.com |
||||
Public institution | bizmsg-gov.kakaoenterprise.com |
||||
Staging | General | stg-user.bizmsg.kakaoenterprise.com |
|||
Finance | stg-bizmsg-bank.kakaoenterprise.com |
||||
Stock | stg-bizmsg-stock.kakaoenterprise.com |
||||
Public institution | stg-bizmsg-gov.kakaoenterprise.com |
||||
uid | String | Y |
Message key ID - ex. 21018173501346cxU7zEswSYSsTmS |
Request Header
코드예제Request Header of Retrieving Detailed Message Delivery ResultParameter | Type | Required | Description |
---|---|---|---|
accept | String | Y |
*/* |
Authorization | String | Y |
Bearer {oauthToken} - {oauthToken} : Access token acquired by OAuth 2.0 API |
Response
Response Syntax
코드예제Response Syntax of Retrieving Detailed Message Delivery Result
{
"code": "200",
"code_detail": {
"detail_code": "",
"detail_message": "success"
},
"report_group_no": "8493608862033069978",
"results": [
{
"cid": "77613652af2d464580796c41cf0d39a3",
"uid": "220918080309405KFXrvK8CR9e+k8s",
"message_type": "AT",
"final_message_type": "RCSSMS",
"status_code": "API_200",
"broker_status_code": "0000",
"error_message": "success",
"req_date": "2022-12-07T04:58:36.656Z",
"res_date": "2022-12-07T04:58:36.656Z"
}
]
}
Response Elements
코드예제Response Elements of Retrieving Detailed Message Delivery ResultField | Type | Required | Description |
---|---|---|---|
code | String | N |
Message delivery result code |
100 : In processing |
|||
200 : Success |
|||
400 : Authorization error |
|||
410 : Invalid input value |
|||
420 : File/image error |
|||
500 : Internal system error |
|||
510 : Failed to send |
|||
520 : Failed but can be resent |
|||
N |
Message status code | ||
detail_code | String | N |
Detailed code |
detail_message | String | N |
Detailed message |
N |
Detailed delivery results of a single message | ||
cid | String | N |
Defined Key ID by corporate customer |
uid | String | N |
Message key ID |
phone_number | String | N |
Mobile number of recipient - text(16) |
sender_no | String | N |
The mobile number of sender - text(16) |
message | String | N |
Message body |
fall_back_message | String | N |
Detailed message of alternative message |
N |
Detailed results by alternative message type | ||
step | Integer | N |
Order of delivered message - to be increased by 1 each time the type is changed |
message_type | String | N |
Message type |
template_code | String | N |
Template code - Templates for each type may be different |
status_code | String | N |
dk techin messaging result code |
broker_status_code | String | N |
Status code sent from sender (for reference) |
error_message | String | N |
Error message |
req_date | String | N |
Request date |
res_date | String | N |
Completion date |