Environment | Domain |
---|---|
Real | https://api-sms.cloud.toast.com |
Category | Maximum Support | Standard Specifications |
---|---|---|
SMS Body | 255 characters | 90 bytes (45 characters for Korean, or 90 for English) |
MMS Title | 120 characters | 40 bytes (20 characters for Korean, or 40 for English) |
MMS Body | 4,000 characters | 2,000 bytes (1,000 characters for Korean, or 2,000 for English) |
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"templateId": "TemplateId",
"body": "Body",
"sendNo": "15446859",
"requestDate": "2018-08-10 10:00",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"countryCode": "82",
"internationalRecipientNo": "821000000000",
"templateParameter": {
"key": "value"
},
"recipientGroupingKey": "recipientGroupingKey"
}
],
"userId": "UserId",
"statsId": "statsId",
"originCode": "123456789",
"useConversion": true
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
templateId | String | 50 | X | Delivery template ID |
body | String | Standard: 90 bytes, Max: 255 characters (as of EUC-KR) [Precautions] | O | Body |
sendNo | String | 13 | O | Sender number |
requestDate | String | - | X | Request date and time (yyyy-MM-dd HH:mm) Can be set up to 60 days from now |
senderGroupingKey | String | 100 | X | Sender's group key |
recipientList[].recipientNo | String | 20 | O | Recipient number Available in combination with country code Up to 1,000 |
recipientList[].countryCode | String | 8 | X | Country code [Default: 82 (Korea)] |
recipientList[].internationalRecipientNo | String | 20 | X | Recipient number including country code e.g.) 821012345678 To be ignored if recipientNo is available. |
recipientList[].templateParameter | Object | - | X | Template parameter (with the input of template ID) |
recipientList[].templateParameter.{key} | String | - | X | Replacement key (##key##) |
recipientList[].templateParameter.{value} | Object | - | X | Value which is mapped for replacement key |
recipientList[].recipientGroupingKey | String | 100 | X | Recipient group key |
userId | String | 100 | X | Delivery delimiter e.g) admin,system |
statsId | String | 10 | X | Statistics ID (not included in the delivery search conditions) |
originCode | String | 9 | X | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) Do not use unless you are special value-added telecommunications business operator. NHN Cloud's identification code is added by default. |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"body": "Body",
"sendNo": "15446859",
"recipientList": [
{
"internationalRecipientNo": "821000000000"
}
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.statusCode | String | Request status code (1:Requesting, 2:Request completed, 3:Request failed) |
body.data.senderGroupingKey | String | Sender group key |
body.data.sendResultList[].recipientNo | String | Recipient number |
body.data.sendResultList[].resultCode | Integer | Result code |
body.data.sendResultList[].resultMessage | String | Result message |
body.data.sendResultList[].recipientSeq | Integer | Recipient sequence (mtPr) |
body.data.sendResultList[].recipientGroupingKey | String | Recipient group key |
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/sms |
[Request body]
{
"body": "Body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"recipientGroupingKey": "RecipientGroupingKey2"
}
],
"statsId": "statsId"
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 2,
"recipientGroupingKey": "RecipientGroupingKey2"
}
]
}
}
}
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v3.0/appKeys/{appKey}/sender/sms |
[Request body]
{
"body": "Body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"internationalRecipientNo": "821000000000",
"recipientGroupingKey": "RecipientGroupingKey"
}
],
"userId": "",
"statsId": "statsId"
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
[URL]
GET /sms/v3.0/appKeys/{appKey}/sender/sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | Required | Request ID |
startRequestDate | String | - | Required | Start date of delivery (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Required | End date of delivery (yyyy-MM-dd HH:mm:ss) |
startCreateDate | String | - | Required | Start date of registration (yyyy-MM-dd HH:mm:ss) |
endCreateDate | String | - | Required | End date of registration (yyyy-MM-dd HH:mm:ss) |
startResultDate | String | - | Optional | Start date of receiving (yyyy-MM-dd HH:mm:ss) |
endResultDate | String | - | Optional | End date of receiving (yyyy-MM-dd HH:mm:ss) |
sendNo | String | 13 | Optional | Sender number |
recipientNo | String | 20 | Optional | Recipient number |
templateId | String | 50 | Optional | Template number |
msgStatus | String | 1 | Optional | Message status code (0:Failed, 1: requesting, 2: processing, 3:successful, 4:Delivery Cancelled, 5:Duplicate Delivery, 6: Failed (Ad restricted), 7: Waiting for Resending (Ad restricted)) |
resultCode | String | 10 | Optional | Result code of receiving [Table on Query Codes] |
subResultCode | String | 10 | Optional | Detail result code of receiving [Table on Query Codes] |
senderGroupingKey | String | 100 | Optional | Sender's group key |
recipientGroupingKey | String | 100 | Optional | Recipient's group key |
pageNum | Integer | - | Optional | Page number (default : 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/sms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"requestId": "20180810100630ReZQ6KZzAH0",
"requestDate": "2018-08-10 10:06:30.0",
"resultDate": "2018-08-10 10:06:42.0",
"templateId": "TemplateId",
"templateName": "template name",
"categoryId": 0,
"categoryName": "category name",
"body": "single-text test",
"sendNo": "15446859",
"countryCode": "82",
"recipientNo": "01000000000",
"msgStatus": "3",
"msgStatusName": "successful",
"resultCode": "1000",
"resultCodeName": "successful",
"telecomCode": 10001,
"telecomCodeName": "SKT",
"recipientSeq": 1,
"sendType": "0",
"messageType": "SMS",
"messageCount": 1,
"userId": "tester",
"adYn": "N",
"resultMessage": "",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Number of queried data |
body.totalCount | Integer | Number of total data |
body.data[].requestId | String | Request ID |
body.data[].requestDate | String | Date and time of sending |
body.data[].resultDate | String | Date and time of receiving |
body.data[].templateId | String | Template ID |
body.data[].templateName | String | Template name |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryName | String | Category name |
body.data[].body | String | Body |
body.data[].sendNo | String | Sender number |
body.data[].countryCode | String | Country code |
body.data[].recipientNo | String | Recipient number |
body.data[].msgStatus | String | Message status code |
body.data[].msgStatusName | String | Name of message status code |
body.data[].resultCode | String | Result code of receiving [Table on Result Code of Receiving] |
body.data[].resultCodeName | String | Result code name of receiving |
body.data[].telecomCode | Integer | Code of telecom provider |
body.data[].telecomCodeName | String | Name of telecom provider |
body.data[].recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data[].sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data[].messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data[].messageCount | Integer | Number of messages sent |
body.data[].userId | String | Delivery request ID |
body.data[].adYn | String | Ad or not |
body.data[].resultMessage | String | Result message |
body.data[].senderGroupingKey | String | Sender's group key |
body.data[].recipientGroupingKey | String | Recipient's group key |
[URL]
GET /sms/v3.0/appKeys/{appKey}/sender/sms/{requestId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Required | Description |
---|---|---|---|
recipientSeq | Integer | Required | Detail delivery ID |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/sms/'"${REQUEST_ID}"'?recipientSeq='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"requestDate": "2018-08-10 10:06:30.0",
"resultDate": "2018-08-10 10:06:42.0",
"templateId": "TemplateId",
"templateName": "template name",
"categoryId": 0,
"categoryName": "Category name",
"body": "body",
"sendNo": "15446859",
"countryCode": "82",
"recipientNo": "01000000000",
"msgStatus": "3",
"msgStatusName": "successful",
"resultCode": "1000",
"resultCodeName": "successful",
"telecomCode": 10001,
"telecomCodeName": "SKT",
"recipientSeq": 1,
"sendType": "0",
"messageType": "SMS",
"messageCount": 1,
"userId": "tester",
"adYn": "N",
"originCode": "123456789",
"resultMessage": "",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "RecipientGroupingKey",
"dlr": {
"dlrStatus": "DELIVERED",
"networkCode": "12345",
"errorCode": "0"
}
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.requestDate | String | Date and time of sending |
body.data.resultDate | String | Date and time of receiving |
body.data.templateId | String | Template ID |
body.data.templateName | String | Template name |
body.data.categoryId | Integer | Category ID |
body.data.categoryName | String | Category name |
body.data.body | String | Body |
body.data.sendNo | String | Sender name |
body.data.countryCode | String | Country code |
body.data.recipientNo | String | Recipient number |
body.data.msgStatus | String | Message status code |
body.data.msgStatusName | String | Name of message status code |
body.data.resultCode | String | Result code of receiving [Table on Result Code of Receiving] |
body.data.resultCodeName | String | Result code name of receiving |
body.data.telecomCode | Integer | Telecom provider code |
body.data.telecomCodeName | String | Telecom provider name |
body.data.recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data.sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data.messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data.messageCount | Integer | Number of messages sent (international sending) |
body.data.userId | String | Delivery request ID |
body.data.adYn | String | Ad or not |
body.data.originCode | String | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) |
body.data.resultMessage | String | Result message |
body.data.senderGroupingKey | String | Sender's group key |
body.data.recipientGroupingKey | String | Recipient's group key |
body.data.dlr.dlrStatus | String | DLR status code |
body.data.dlr.networkCode | String | DLR network code |
body.data.dlr.errorCode | String | DLR error code |
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/sms/do-convert
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Orignital AppKey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Origianl SecretKey |
[Request body]
{
"requestId": "requestId",
"recipientSeq": 1
}
Value | Type | Maximum length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | O | Request ID |
recipientSeq | Integer | - | O | Recipient sequence |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/sms/do-convert \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key:{secretkey}' \
-d '{
"requestId": "requestId",
"recipientSeq": 1
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
※ * If a request to collect conversion rate was not made via the useConversion field at the time of dispatch, or if the dispatch was not completed, the API responds with a failure.[International SMS Sending Policy]
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/mms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"templateId": "TemplateId",
"title": "Title",
"body": "Body",
"sendNo": "15446859",
"requestDate": "2018-08-10 10:00",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"countryCode": "82",
"internationalRecipientNo": "821000000000",
"templateParameter": {
"key": "value"
},
"recipientGroupingKey": "recipientGroupingKey"
}
],
"userId": "UserId",
"statsId": "statsId",
"originCode": "123456789"
}
Value | Type | Maximum Length | Required | Description |
---|---|---|---|---|
templateId | String | 50 | X | Delivery template ID |
title | String | 40 bytes (in EUC-KR) | O | Title |
body | String | 2000 bytes (in EUC-KR) | O | Body |
sendNo | String | 13 | O | Sender number |
requestDate | String | - | X | Request date and time(yyyy-MM-dd HH:mm) Can be set up to 60 days from now |
senderGroupingKey | String | 100 | X | Sender's group key |
recipientList[].recipientNo | String | 20 | O | Recipient number Available in combination of countryCode |
recipientList[].countryCode | String | 8 | X | Country code [Default: 82 (Korea)] |
recipientList[].internationalRecipientNo | String | 20 | X | Recipient number including country code e.g.) 821012345678 To be ignored if recipientNo is available. |
recipientList[].templateParameter | Object | - | X | Template parameter (with the input of template ID) |
recipientList[].templateParameter.{key} | String | - | X | Replacement key (##key##) |
recipientList[].templateParameter.{value} | Object | - | X | Value which is mapped for replacement key |
recipientList[].recipientGroupingKey | String | 1000 | X | Recipient group key |
userId | String | 100 | X | Delivery delimiter e.g.) admin,system |
statsId | String | 10 | X | Statistics ID (not included in the delivery search conditions) |
originCode | String | 9 | X | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) Do not use unless you are special value-added telecommunications business operator. NHN Cloud's identification code is added by default. |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/mms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"title": "{title}",
"body": "{body}",
"sendNo": "15446859",
"attachFileIdList": [0],
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {}
}
],
"userId": ""
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.statusCode | String | Request status code (1: requesting, 2:request completed, 3: request failed) |
body.data.senderGroupingKey | String | Sender's group key |
body.data.sendResultList[].recipientNo | String | Recipient number |
body.data.sendResultList[].resultCode | Integer | Result code |
body.data.sendResultList[].resultMessage | String | Result message |
body.data.sendResultList[].recipientSeq | Integer | Recipient sequence (mtPr) |
body.data.sendResultList[].recipientGroupingKey | String | Recipient's group key |
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/mms |
[Request body]
{
"title": "Title",
"body": "Body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"recipientGroupingKey": "RecipientGroupingKey2"
}
],
"statsId": "statsId"
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 2,
"recipientGroupingKey": "RecipientGroupingKey2"
}
]
}
}
}
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/mms |
[Request body]
{
"title": "Title",
"body": "Body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGrouping",
"attachFileIdList": [
0
],
"recipientList": [
{
"recipientNo": "01010000000",
"recipientGroupingKey": "RecipientGroupingKey"
}
],
"statsId": "statsId"
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGrouping",
"sendResultList": [
{
"recipientNo": "01012341234",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
[URL]
GET /sms/v3.0/appKeys/{appKey}/sender/mms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | Required | Request ID |
startRequestDate | String | - | Required | Start date of sending (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Required | End date of sending (yyyy-MM-dd HH:mm:ss) |
startCreateDate | String | - | Required | Start date of registration (yyyy-MM-dd HH:mm:ss) |
endCreateDate | String | - | Required | End date of registration (yyyy-MM-dd HH:mm:ss) |
startResultDate | String | - | Optional | Start date of receiving (yyyy-MM-dd HH:mm:ss) |
endResultDate | String | - | Optional | End date of receiving (yyyy-MM-dd HH:mm:ss) |
sendNo | String | 13 | Optional | Sender number |
recipientNo | String | 20 | Optional | Recipient number |
templateId | String | 50 | Optional | Template number |
msgStatus | String | 1 | Optional | Message status code (0:Failed, 1: requesting, 2: processing, 3:successful, 4:Delivery Cancelled, 5:Duplicate Delivery, 6: Failed (Ad restricted), 7: Waiting for Resending (Ad restricted)) |
resultCode | String | 10 | Optional | Result code of receiving [Table on Query Codes] |
subResultCode | String | 10 | Optional | Detail result code of receiving [Table on Query Codes] |
senderGroupingKey | String | 100 | Optional | Sender's group key |
recipientGroupingKey | String | 100 | Optional | Recipient's group key |
pageNum | Integer | - | Optional | Page number (default : 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/mms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"requestId": "20230918160734BWt01iOWZm2",
"requestDate": "2023-09-18 16:07:34.0",
"resultDate": "2023-09-18 16:07:36.0",
"templateId": null,
"templateName": null,
"categoryId": null,
"categoryName": null,
"title": "Title",
"body": "본문",
"sendNo": "15771234",
"countryCode": "82",
"recipientNo": "01012341234",
"msgStatus": "3",
"msgStatusName": "성공",
"resultCode": "1000",
"resultCodeName": "성공",
"telecomCode": 10003,
"telecomCodeName": "LGU",
"mtPr": "1",
"sendType": "1",
"messageType": "LMS",
"messageCount": 1,
"userId": null,
"adYn": "N",
"attachFileList": [
{
"fileId": 535191,
"filePath": "/temporary/71191/toast-mt-2023-09-18/1607/535191/",
"fileName": "attachment.jpg",
"saveFileName": "20230918KKkqQC0.jpg",
"uploadType": "TEMPORARY"
}
],
"resultMessage": "SUCCESS",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "recipientGroupingKey"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body | Object | Body area |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].requestId | String | Request ID |
body.data[].requestDate | String | Date and time of request |
body.data[].resultDate | String | Date and time of receiving |
body.data[].templateId | String | Template ID |
body.data[].templateName | String | Template name |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryName | String | Category name |
body.data[].body | String | Body message |
body.data[].sendNo | String | Sender number |
body.data[].countryCode | String | Country code |
body.data[].recipientNo | String | Recipient number |
body.data[].msgStatus | String | Message status code |
body.data[].msgStatusName | String | Name of message status code |
body.data[].resultCode | String | Result code of receiving [Table on Result Code of Receiving] |
body.data[].resultCodeName | String | Result code name of receiving |
body.data[].telecomCode | Integer | Code of telecom provider |
body.data[].telecomCodeName | String | Name of telecom provider |
body.data[].recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data[].sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data[].messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data[].messageCount | Integer | Number of messages sent |
body.data[].userId | String | Delivery request ID |
body.data[].adYn | String | Ad or not |
body.data[].attachFileList[].fileId | Integer | File ID |
body.data[].attachFileList[].filePath | String | Path of file saving (for internal purpose) |
body.data[].attachFileList[].fileName | String | File name |
body.data[].attachFileList[].saveFileName | String | Name of saved file |
body.data[].attachFileList[].uploadType | String | Type of uploaded |
body.data[].senderGroupingKey | String | Sender's group key |
body.data[].recipientGroupingKey | String | Recipient's group key |
[URL]
GET /sms/v3.0/appKeys/{appKey}/sender/mms/{requestId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Required | Description |
---|---|---|---|
recipientSeq | Integer | Required | Detail delivery ID |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/mms/'"${REQUEST_ID}"'?recipientSeq='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20230918160734BWt01iOWZm2",
"requestDate": "2023-09-18 16:07:34.0",
"resultDate": "2023-09-18 16:07:36.0",
"templateId": null,
"templateName": null,
"categoryId": null,
"categoryName": null,
"title": "Title",
"body": "본문",
"sendNo": "15771234",
"countryCode": "82",
"recipientNo": "01012341234",
"msgStatus": "3",
"msgStatusName": "성공",
"resultCode": "1000",
"resultCodeName": "성공",
"telecomCode": 10003,
"telecomCodeName": "LGU",
"mtPr": "1",
"sendType": "1",
"userId": null,
"adYn": "N",
"originCode": "123456789",
"attachFileList": [
{
"fileId": 535191,
"filePath": "/temporary/71191/toast-mt-2023-09-18/1607/535191/",
"fileName": "attachment.jpg",
"saveFileName": "20230918KKkqQC0.jpg",
"uploadType": "TEMPORARY"
}
],
"resultMessage": "SUCCESS",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "recipientGroupingKey"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body | Object | Body area |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data.requestId | String | Request ID |
body.data.requestDate | String | Date and time of sending |
body.data.resultDate | String | Date and time of receiving |
body.data.templateId | String | Template ID |
body.data.templateName | String | Template name |
body.data.categoryId | Integer | Category ID |
body.data.categoryName | String | Category name |
body.data.body | String | Body message |
body.data.sendNo | String | Sender number |
body.data.countryCode | String | Country code |
body.data.recipientNo | String | Recipient number |
body.data.msgStatus | String | Message status code |
body.data.msgStatusName | String | Name of message status code |
body.data.resultCode | String | Result code of receiving [Table on Result Code of Receiving] |
body.data.resultCodeName | String | Result code name of receiving |
body.data.telecomCode | Integer | Code of telecom provider |
body.data.telecomCodeName | String | Name of telecom provider |
body.data.recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data.sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data.messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data.userId | String | Delivery request ID |
body.data.adYn | String | Ad or not |
body.data.originCode | String | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) |
body.data.attachFileList[].fileId | Integer | File ID |
body.data.attachFileList[].filePath | String | Path of file saving (for internal purpose) |
body.data.attachFileList[].fileName | String | File name |
body.data.attachFileList[].saveFileName | String | Name of saved file |
body.data.attachFileList[].uploadType | String | Type of uploaded |
body.data.resultMessage | String | Result message |
body.data.senderGroupingKey | String | Sender's group key |
body.data.recipientGroupingKey | String | Recipient's group key |
Category | Authentication Words |
---|---|
Authentication SMS (for emergency) | auth, password, verify, にんしょう, 認証, password, authentication |
[URL]
POST /sms/v2.4/appKeys/{appKey}/sender/auth/sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"templateId": "TemplateId",
"body": "body",
"sendNo": "15446859",
"requestDate": "2018-08-10 10:00",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"countryCode": "82",
"internationalRecipientNo": "821000000000",
"templateParameter": {
"key": "value"
},
"recipientGroupingKey": "recipientGroupingKey"
}
],
"userId": "UserId",
"statsId": "statsId",
"originCode": "123456789",
"useConversion": true
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
templateId | String | 50 | X | Delivery template ID |
body | String | Standard: 90 bytes, Max: 255 characters (as of EUC-KR) [Precautions] | O | Body [Precautions] |
sendNo | String | 13 | O | Sender number |
requestDate | String | - | X | Date and time of schedule (yyyy-MM-dd HH:mm) Can be set up to 60 days from now |
senderGroupingKey | String | 100 | X | Sender's group key |
recipientList[].recipientNo | String | 20 | O | Recipient number Available in combination of the country code |
recipientList[].countryCode | String | 8 | X | Country code [default: 82 (Korea)] |
recipientList[].internationalRecipientNo | String | 20 | X | Recipient number including country code e.g.) 821012345678 To be ignored if recipientNo is available |
recipientList[].templateParameter | Object | - | X | Template parameter (with the input of template ID) |
recipientList[].templateParameter.{key} | String | - | X | Replacement key (##key##) |
recipientList[].templateParameter.{value} | Object | - | X | Value which is mapped for replacement key |
recipientList[].recipientGroupingKey | String | 100 | X | Recipient's group key |
userId | String | 100 | X | Delivery delimiter e.g.) admin,system |
statsId | String | 10 | X | Statistics ID (not included in the delivery search conditions) |
originCode | String | 9 | X | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) |
useConversion | Boolean | - | X | Request to call converion rate (Default: false) Cannot use when the date and time of schedule is set |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/auth/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"body": "Authentication Test",
"sendNo": "15446859",
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {}
}
],
"userId": ""
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.statusCode | String | Request status code (1: Requesting, 2: Request completed, 3: Request failed) |
body.data.senderGroupingKey | String | Sender's group key |
body.data.sendResultList[].recipientNo | String | Recipient number |
body.data.sendResultList[].resultCode | Integer | Result code |
body.data.sendResultList[].resultMessage | String | Result message |
body.data.sendResultList[].recipientSeq | Integer | Recipient sequence (mtPr) |
body.data.sendResultList[].recipientGroupingKey | String | Recipient's group key |
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/auth/sms |
[Request body]
{
"body": "body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"recipientGroupingKey": "RecipientGroupingKey2"
}
],
"statsId": "statsId"
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
},
{
"recipientNo": "01000000001",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 2,
"recipientGroupingKey": "RecipientGroupingKey2"
}
]
}
}
}
[URL]
GET /sms/v3.0/appKeys/{appKey}/sender/auth/sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | Required | Request ID |
startRequestDate | String | - | Required | Start date of sending (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Required | End date of sending (yyyy-MM-dd HH:mm:ss) |
startCreateDate | String | - | Required | Start date of registration (yyyy-MM-dd HH:mm:ss) |
endCreateDate | String | - | Required | End date of registration (yyyy-MM-dd HH:mm:ss) |
startResultDate | String | - | Optional | Start date of receiving (yyyy-MM-dd HH:mm:ss) |
endResultDate | String | - | Optional | End date of receiving (yyyy-MM-dd HH:mm:ss) |
sendNo | String | 13 | Optional | Sender number |
recipientNo | String | 20 | Optional | Recipient number |
templateId | String | 50 | Optional | Template number |
msgStatus | String | 1 | Optional | Message status code (0:Failed, 1: requesting, 2: processing, 3:successful, 4:Delivery Cancelled, 5:Duplicate Delivery, 6: Failed (Ad restricted), 7: Waiting for Resending (Ad restricted)) |
resultCode | String | 10 | Optional | Result code of receiving [Table on Query Codes] |
subResultCode | String | 10 | Optional | Detail result code of receiving [Table on Query Codes] |
senderGroupingKey | String | 100 | Optional | Sender's group key |
recipientGroupingKey | String | 100 | Optional | Recipient's group key |
pageNum | Integer | - | Optional | Page number (Default : 1) |
pageSize | Integer | 1000 | Optional | Number of queries (Default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/auth/sms?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"requestId": "20180810100630ReZQ6KZzAH0",
"requestDate": "2018-08-10 10:06:30.0",
"resultDate": "2018-08-10 10:06:42.0",
"templateId": "TemplateId",
"templateName": "template name",
"categoryId": 0,
"categoryName": "category name",
"body": "single text test",
"sendNo": "15446859",
"countryCode": "82",
"recipientNo": "01000000000",
"msgStatus": "3",
"msgStatusName": "successful",
"resultCode": "1000",
"resultCodeName": "successful",
"telecomCode": 10001,
"telecomCodeName": "SKT",
"recipientSeq": 1,
"sendType": "0",
"messageType": "AUTH",
"messageCount": 1,
"userId": "tester",
"adYn": "N",
"resultMessage": "",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].requestId | String | Request ID |
body.data[].requestDate | String | Date and time of sending |
body.data[].resultDate | String | Date and time of receiving |
body.data[].templateId | String | Template ID |
body.data[].templateName | String | Template name |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryName | String | Category name |
body.data[].body | String | Body message |
body.data[].sendNo | String | Sender number |
body.data[].countryCode | String | Country code |
body.data[].recipientNo | String | Recipient number |
body.data[].msgStatus | String | Message status code |
body.data[].msgStatusName | String | Name of message status code |
body.data[].resultCode | String | Result code of receiving [Table on Result Code of Receiving] |
body.data[].resultCodeName | String | Result code name of receiving |
body.data[].messageCount | Integer | Number of messages sent |
body.data[].telecomCode | Integer | Code of telecom provider |
body.data[].telecomCodeName | String | Name of telecom provider |
body.data[].recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data[].sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data[].messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data[].userId | String | Request ID for sending |
body.data[].adYn | String | Ad or not |
body.data[].resultMessage | String | Result message |
body.data[].senderGroupingKey | String | Sender's group key |
body.data[].recipientGroupingKey | String | Recipient's group key |
[URL]
GET /sms/v2.4/appKeys/{appKey}/sender/auth/sms/{requestId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Required | Description |
---|---|---|---|
recipientSeq | Integer | Required | Detail delivery ID |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/auth/sms/'"${REQUEST_ID}"'?recipientSeq='"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20180810100630ReZQ6KZzAH0",
"requestDate": "2018-08-10 10:06:30.0",
"resultDate": "2018-08-10 10:06:42.0",
"templateId": "TemplateId",
"templateName": "template name",
"categoryId": 0,
"categoryName": "category name",
"body": "body",
"sendNo": "15446859",
"countryCode": "82",
"recipientNo": "01000000000",
"msgStatus": "3",
"msgStatusName": "successful",
"resultCode": "1000",
"resultCodeName": "successful",
"telecomCode": 10001,
"telecomCodeName": "SKT",
"recipientSeq": 1,
"sendType": "0",
"messageType": "AUTH",
"messageCount": 1,
"userId": "tester",
"adYn": "N",
"originCode": "123456789",
"resultMessage": "",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "RecipientGroupingKey",
"dlr": {
"dlrStatus": "DELIVERED",
"networkCode": "12345",
"errorCode": "0"
}
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Requst ID |
body.data.requestDate | String | Date and time of sending |
body.data.resultDate | String | Date and time of receiving |
body.data.templateId | String | Template ID |
body.data.templateName | String | Template name |
body.data.categoryId | Integer | Category ID |
body.data.categoryName | String | Category name |
body.data.body | String | Body message |
body.data.sendNo | String | Sender number |
body.data.countryCode | String | Country code |
body.data.recipientNo | String | Recipient number |
body.data.msgStatus | String | Message status code |
body.data.msgStatusName | String | Name of message status code |
body.data.resultCode | String | Result code of receiving [Table on result code of receiving] |
body.data.resultCodeName | String | Result code name of receiving |
body.data.telecomCode | Integer | Code of telecom provider |
body.data.telecomCodeName | String | Name of telecom provider |
body.data.recipientSeq | Integer | Detail delivery ID (required to query details) |
body.data.sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data.messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data.messageCount | Integer | Number of messages sent |
body.data.userId | String | Request ID for sending |
body.data.adYn | String | Ad or not |
body.data.originCode | String | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) |
body.data.resultMessage | String | Result message |
body.data.senderGroupingKey | String | Sender's group key |
body.data.recipientGroupingKey | String | Recipient's group key |
body.data.dlr.dlrStatus | String | DLR status code |
body.data.dlr.networkCode | String | DLR network code |
body.data.dlr.errorCode | String | DLR error code |
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/auth/sms/do-convert
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original AppKey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original SecretKey |
[Request body]
{
"requestId": "requestId",
"recipientSeq": 1
}
Value | Type | Maximum Length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | O | Request ID |
recipientSeq | Integer | - | O | Recipient sequence |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/auth/sms/do-convert \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key:{secretkey}' \
-d '{
"requestId": "requestId",
"recipientSeq": 1
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/ad-sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request Body] Same as Send SMS in the above. [See Request Body]
However, required statements for ads must be included in the body.
080 numbers are available in Setting for Rejection of Receiving 080 Numbers on console.
Required statements for ads are as follows.
- Opening statement: (Ads)
- Last statement: Deny for free {080-unsubscribed-number}
or Deny for free {080-unsubscribed-number}
(the phrase can include spaces).
Example
(Ads)
[Deny for free]080XXXXXXX
(Ad)
[Deny for free]080XXXXXXX
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/ad-sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"body": "(Ad) Test\n [Unsubscribe for free]0808880327",
"sendNo": "15446859",
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {}
}
],
"userId": ""
}'
※ LMS/MMS cannot be sent internationally. However, for international SMS only, you can send long messages using the Concatenated Message feature of SMS. [International SMS sending policy].
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/ad-mms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Request Body] Same as Send MMS in the above. [See Request Body]
However, required statements for ads must be included in the body.
080 numbers are available in Setting for Rejection of Receiving 080 Numbers on console.
Required statements for ads are as follows.
- Opening statement: (Ads)
- Last statement: Deny for free {080-unsubscribed-number}
or Deny for free {080-unsubscribed-number}
(the phrase can include spaces).
Example
(Ads)
[Deny for free]080XXXXXXX
(Ad)
[Deny for free]080XXXXXXX
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/ad-mms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
-d '{
"title": "{Title}",
"body": "(Ad) Test\n [Unsubscribe for free]0808880327",
"sendNo": "15446859",
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {}
}
],
"userId": ""
}'
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/sms/do-convert
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original AppKey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original SecretKey |
[Request body]
{
"requestId": "requestId",
"recipientSeq": 1
}
Value | Type | Maximum Length | Required | Description |
---|---|---|---|---|
requestId | String | 25 | O | Request ID |
recipientSeq | Integer | - | O | Recipient Sequence |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/sms/do-convert \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key:{secretkey}' \
-d '{
"requestId": {requestId},
"recipientSeq": 1
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure core |
header.resultMessage | String | Failure message |
[URL]
GET /sms/v3.0/appKeys/{appKey}/message-results?startUpdateDate={startUpdateDate}&endUpdateDate={endUpdateDate}&messageType={messageType}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Required | Description |
---|---|---|---|
startUpdateDate | String | Required | Start time of query result updates yyyy-MM-dd HH:mm:ss |
endUpdateDate | String | Required | End time of query result updates yyyy-MM-dd HH:mm:ss |
messageType | String | Optional | Message type (SMS/LMS/MMS/AUTH) |
pageNum | Integer | Optional | Page number (default:1) |
pageSize | Integer | Optional | Number of queries (default:15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/message-results?startRequestDate='"${START_DATE}"'&endRequestDate='"${END_DATE}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 35,
"data": [
{
"messageType": "SMS",
"requestId": "20230914101505oAJTbxHkIB0",
"recipientSeq": 1,
"resultCode": "1000",
"resultCodeName": "성공",
"requestDate": "2023-09-14 10:15:05.0",
"resultDate": "2023-09-14 10:15:08.0",
"updateDate": "2023-09-14 10:15:12.0",
"telecomCode": "10002",
"telecomCodeName": "KT",
"senderGroupingKey": "SenderGroupingKey",
"recipientGroupingKey": "recipientGroupingKey"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.resultUpdateList[].messageType | String | Message type (SMS/LMS/MMS/AUTH) |
body.data.resultUpdateList[].requestId | String | Request ID |
body.data.resultUpdateList[].recipientSeq | Integer | Recipient sequence |
body.data.resultUpdateList[].resultCode | String | Result code |
body.data.resultUpdateList[].resultCodeName | String | Name of result code |
body.data.resultUpdateList[].requestDate | String | Date and time of request (yyyy-MM-dd HH:mm:ss.S) |
body.data.resultUpdateList[].resultDate | String | Date and time of receiving (yyyy-MM-dd HH:mm:ss.S) |
body.data.resultUpdateList[].updateDate | String | Date and time of result updates (yyyy-MM-dd HH:mm:ss.S) |
body.data.resultUpdateList[].telecomCode | String | Code of telecom provider |
body.data.resultUpdateList[].telecomCodeName | String | Name of telecom provider |
body.data.resultUpdateList[].senderGroupingKey | String | Sender's group key |
body.data.resultUpdateList[].recipientGroupingKey | String | Recipient's group key |
[URL]
GET /sms/v3.0/appKeys/{appKey}/mass-sender
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
sendType | required, String | 1 | O | Delivery type SMS : "0", MMS : "1" |
requestId | String | - | O | Request ID |
startRequestDate | String | - | O | Start date of delivery |
endRequestDate | String | - | O | End date of delivery |
startCreateDate | String | - | O | Start date of registration |
endCreateDate | String | - | O | End date of registration |
statusCode | String | 10 | X | Delivery status code WAIT : "MAS00" READY : "MAS01" SENDREADY : "MAS09" SENDWAIT : "MAS10" SENDING : "MAS11" COMPLETE : "MAS19" CANCELING : "MAS90" CANCEL : "MAS91" FAIL : "MAS99" |
pageNum | optional, Integer | - | X | Page number |
pageSize | optional, Integer | 1000 | X | Number of queries |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/mass-sender?requestId='"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"requestId": "20230918100859e1SoH6zC4o0",
"requestDate": "2023-09-18 10:08:59",
"masterStatusCode": "MAS19",
"masterStatus": "COMPLETE",
"templateId": "",
"sendNo": "12341234",
"title": null,
"body": "body",
"adYn": "N",
"autoSendYn": "Y",
"sendErrorCount": 0,
"createUser": "25d09a62-0bf7-4d6f-b823-80e49536cc08",
"createDate": "2023-09-18 10:08:59.0"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].requestId | String | Request ID |
body.data[].requestDate | String | Request time |
body.data[].masterStatusCode | String | Mass delivery status code |
body.data[].masterStatus | String | Mass delivery status |
body.data[].templateId | String | Template ID |
body.data[].sendNo | String | Sender number |
body.data[].title | String | Title |
body.data[].body | String | Body |
body.data[].adYn | String | Ad or Not |
body.data[].autoSendYn | String | Auto delivery or not |
body.data[].sendErrorCount | Integer | Error counts in recipients |
body.data[].createUser | String | Creator |
body.data[].createDate | String | Date and time of creation |
[URL]
GET /sms/v3.0/appKeys/{appKey}/mass-sender/receive/{requestId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
recipientNo | String | 20 | X | Recipient number |
startRequestDate | String | - | O | Start date of delivery request |
endRequestDate | String | - | O | End date of delivery request |
startResultDate | String | - | X | Start date of receiving |
endResultDate | String | - | X | End date of receiving |
msgStatusName | String | 10 | X | Message status code - READY:Ready - SENDING: Requesting for delivery - COMPLETED : Request for delivery completed - FAILED : Delivery failed |
resultCode | String | 10 | X | Result code of receiving |
pageNum | Integer | - | X | Page number |
pageSize | Integer | 1000 | X | Number of queries |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/mass-sender/receive/'"${REQUEST_ID}"' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"requestId": "20210901033436ZLdZtl8GWZ0",
"recipientSeq": 1,
"countryCode": "82",
"recipientNo": "01020060836",
"requestDate": "2021-09-01 03:34:36.0",
"msgStatus": "3",
"msgStatusName": "COMPLETED",
"messageCount": 1,
"resultCode": null,
"receiveDate": null
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].requestId | String | Request ID |
body.data[].recipientSeq | Integer | Recipient sequence |
body.data[].countryCode | String | Recipient's country code |
body.data[].recipientNo | String | Recipient number |
body.data[].requestDate | String | Date and time of request |
body.data[].msgStatus | String | Message status code |
body.data[].msgStatusName | String | Name of message status code |
body.data[].messageCount | Integer | Number of messages sent |
body.data[].resultCode | String | Result code of receiving [Table on result code of receiving] |
body.data[].receiveDate | String | Date and time of receiving |
[URL]
GET /sms/v3.0/appKeys/{appKey}/mass-sender/receive/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
recipientSeq | String | Sequence |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/mass-sender/receive/'"${REQUEST_ID}"'/'"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20210901033436ZLdZtl8GWZ0",
"recipientSeq": 1,
"sendType": "0",
"messageType": "SMS",
"templateId": "",
"templateName": null,
"sendNo": "01012345000",
"title": null,
"body": "test",
"recipientNo": "01020060836",
"countryCode": "82",
"requestDate": "2021-09-01 03:34:36.0",
"msgStatus": "3",
"msgStatusName": "COMPLETED",
"messageCount": 0,
"resultCode": null,
"receiveDate": null,
"createDate": null,
"attachFileList": [],
"dlr": {
"dlrStatus": "DELIVERED",
"networkCode": "12345",
"errorCode": "0"
}
}
}
}
Value | Type | Description |
---|---|---|
header | Object | Header area |
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.recipientSeq | Integer | Recipient sequence |
body.data.sendType | String | Delivery type |
body.data.messageType | String | Message type |
body.data.templateId | String | Template ID |
body.data.templateName | String | Template name |
body.data.sendNo | String | Sender number |
body.data.title | String | Title |
body.data.body | String | Body |
body.data.recipientNo | String | Recipient number |
body.data.countryCode | String | Recipient's country code |
body.data.requestDate | String | Date and time of request |
body.data.msgStatus | String | Message status |
body.data.msgStatusName | String | Message status name |
body.data.messageCount | Integer | Number of messages sent |
body.data.resultCode | String | Result code of receiving [Table on result code of receiving] |
body.data.receiveDate | String | Data and time of receiving |
body.data.createDate | String | Date and time of registration |
body.data.attachFileList[].filePath | String | Attached file - path |
body.data.attachFileList[].fileName | String | Attached file - file name |
body.data.attachFileList[].fileSize | Long | Attached file - size |
body.data.attachFileList[].fileSequence | Integer | Attached file - file sequence |
body.data.attachFileList[].createDate | String | Attached file - date and time of creation |
body.data.attachFileList[].updateDate | String | Attached file - date of modification |
body.data.dlr.dlrStatus | String | DLR status code |
body.data.dlr.networkCode | String | DLR network code |
body.data.dlr.errorCode | String | DLR error code |
[URL]
POST /sms/v3.0/appKeys/{appKey}/tag-sender/sms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"body": "body",
"sendNo": "15446859",
"requestDate": "2018-03-22 10:00",
"templateId": "TemplateId",
"templateParameter": {
"key": "value"
},
"tagExpression": [
"tag1",
"AND",
"tag2"
],
"userId": "user_id",
"adYn": "N",
"autoSendYn": "N",
"statsId": "statsId",
"originCode": "123456789"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
body | String | Standard: 90 bytes, Max: 255 characters (as of EUC-KR) [Precautions] | O | Body |
sendNo | String | 13 | O | Sender number |
requestDate | String | - | X | Date and time of schedule (yyyy-MM-dd HH:mm) Can be set up to 60 days from now |
templateId | String | 50 | X | Template ID |
templateParameter | Map |
- | X | Template parameter |
tagExpression | List |
- | O | Tag expression ex) ["tagA","AND","tabB"] |
userId | String | 100 | X | Requester ID |
adYn | String | 1 | X | Ad or not (default: N) |
autoSendYn | String | 1 | X | Auto delivery or not (immediate delivery) (default: Y) |
statsId | String | 10 | X | Statistics ID (not included in the delivery search conditions) |
originCode | String | 10 | X | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) Do not use unless you are special value-added telecommunications business operator. NHN Cloud's identification code is added by default. |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tag-sender/sms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"body": "body",
"sendNo": "15446859",
"templateParameter": {
"key": "value"
},
"tagExpression": ["TsNuyRPF"],
"userId": "user_id",
"adYn": "N",
"autoSendYn": "N",
"statsId": "statsId"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "201808130914102Y94ABMNF30"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
※ LMS/MMS are not available for overseas delivery.
[URL]
POST /sms/v3.0/appKeys/{appKey}/tag-sender/mms
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"body": "body",
"sendNo": "15446859",
"requestDate": "2018-03-22 10:00",
"templateId": "TemplateId",
"templateParameter": {
"key": "value"
},
"attachFileIdList": [
1,
2,
3
],
"tagExpression": [
"tag1",
"AND",
"tag2"
],
"userId": "user_id",
"adYn": "N",
"autoSendYn": "N",
"statsId": "statsId",
"originCode": "123456789"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
title | String | 40 bytes (in EUC-KR) | O | Title of text |
body | String | 2000 bytes (in EUC-KR) | O | Body message |
sendNo | String | 13 | O | Sender number |
requestDate | String | - | X | Date and time of schedule (yyyy-MM-dd HH:mm) Can be set up to 60 days from now |
templateId | String | 50 | X | Template ID |
templateParameter | Map |
- | X | Template parameter |
tagExpression | List |
- | O | Tax expression ex) ["tagA","AND","tabB"] |
attachFileIdList | List |
- | X | Attached file ID (fileId) |
userId | String | 100 | X | Requester ID |
adYn | String | 1 | X | Ad or not (default: N) |
autoSendYn | String | 1 | X | Auto delivery or not (immediate delivery) (default: Y) |
statsId | String | 10 | X | Statistics ID (not included in the delivery search conditions) |
originCode | String | 10 | X | Identification code (9-digit registration number, excluding symbols, letters, and spaces, as listed on certificates for special value-added telecommunications business operators) Do not use unless you are special value-added telecommunications business operator. NHN Cloud's identification code is added by default. |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tag-sender/mms' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"title": "Title",
"body": "Body",
"sendNo": "15446859",
"templateParameter": {
"key": "value"
},
"tagExpression": ["TsNuyRPF"],
"userId": "user_id",
"adYn": "N",
"autoSendYn": "Y"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "201808130914102Y94ABMNF30"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
[URL]
GET /sms/v3.0/appKeys/{appKey}/tag-sender
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
appKey | String | - | O | appkey |
sendType | required, String | 1 | O | Delivery Type SMS : "0", MMS : "1" |
requestId | String | - | O | Request ID |
startRequestDate | String | - | O | Start date of delivery |
endRequestDate | String | - | O | End date of delivery |
startCreateDate | String | - | O | Start date of registration |
endCreateDate | String | - | O | End date of registration |
statusCode | String | 10 | X | Delivery status code WAIT : "MAS00" READY : "MAS01" SENDREADY : "MAS09" SENDWAIT : "MAS10" SENDING : "MAS11" COMPLETE : "MAS19" CANCELING : "MAS90" CANCEL : "MAS91" FAIL : "MAS99" |
pageNum | optional, Integer | - | X | Page number |
pageSize | optional, Integer | 1000 | X | Number of queries |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tag-sender?requestId='"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "."
},
"body": {
"pageNum": 0,
"pageSize": 0,
"totalCount": 0,
"data": [
{
"requestId": "20171220141558eonMsyDI6P0",
"requestIp": "127.0.0.1",
"sendType": "0",
"templateId": "TemplateId",
"templateName": "template name",
"masterStatusCode": "READY",
"sendNo": "15446859",
"requestDate": "2017-12-20 14:15:58",
"tagExpression": [
"Kb6BjCY1"
],
"title": "title",
"body": "body",
"adYn": "N",
"autoSendYn": "Y",
"sendErrorCount": 0,
"createUser": "CreateUser",
"createDate": "2017-12-20 14:15:58.0",
"updateUser": "UpdateUser",
"updateDate": "2017-12-20 14:15:58.0"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].requestId | String | Request ID |
body.data[].requestIp | String | Request IP |
body.data[].requestDate | String | Request time |
body.data[].tagSendStatus | String | Tag delivery status |
body.data[].tagExpression[] | List |
Tag expression |
body.data[].templateId | String | Template ID |
body.data[].templateName | String | Template name |
body.data[].senderName | String | Sender's name |
body.data[].senderMail | String | Sender's address |
body.data[].title | String | Title |
body.data[].body | String | Body |
body.data[].adYn | String | Ad or not |
body.data[].autoSendYn | String | Auto delivery or not |
body.data[].sendErrorCount | Integer | Error counts in recipients |
body.data[].createUser | String | Creator |
body.data[].createDate | String | Date and time of creation |
body.data[].updateUser | String | Modifier |
body.data[].updateDate | String | Date and time of modification |
[URL]
GET /sms/v3.0/appKeys/{appKey}/tag-sender/{requestId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
recipientNum | String | 20 | X | Recipient number |
startRequestDate | String | - | O | Start date of delivery request |
endRequestDate | String | - | O | End date of delivery request |
startResultDate | String | - | X | Start date of receiving |
endResultDate | String | - | X | End date of receiving |
msgStatusName | String | 10 | X | Message status code - READY: Ready - SENDING: Requesting for delivery - COMPLETED : Request for delivery completed - FAILED : Delivery failed |
resultCode | String | 10 | X | Result code of receiving |
pageNum | Integer | - | X | Page number |
pageSize | Integer | 1000 | X | Number of queries |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tag-sender/'"${REQUEST_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "."
},
"body": {
"pageNum": 0,
"pageSize": 0,
"totalCount": 0,
"data": [
{
"requestId": "20180813022044Jps2xJ1qsv0",
"recipientSeq": 99,
"countryCode": "82",
"recipientNo": "01000000000",
"requestDate": "2018-08-13 02:20:44.0",
"msgStatus": "3",
"msgStatusName": "COMPLETED",
"messageCount": 1,
"resultCode": "3015",
"receiveDate": "2018-08-13 02:20:53.0",
"createDate": "2018-08-13 02:20:46.0",
"updateDate": "2018-08-13 02:27:00.0"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].requestId | String | Request ID |
body.data[].recipientSeq | Integer | Recipient sequence |
body.data[].countryCode | String | Recipient's country code |
body.data[].recipientNo | String | Recipient number |
body.data[].requestDate | String | Date and time of request |
body.data[].msgStatus | String | Message status code |
body.data[].msgStatusName | String | Name of message status code |
body.data[].messageCount | Integer | Number of messages sent |
body.data[].resultCode | String | Result code of receiving [Table on result code of receiving] |
body.data[].receiveDate | String | Date and time of receiving |
body.data[].createDate | String | Date and time of registration |
body.data[].updateDate | String | Date of modification |
[URL]
GET /sms/v3.0/appKeys/{appKey}/tag-sender/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
recipientSeq | String | Sequence |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
X
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tag-sender/'"${REQUEST_ID}"'/'"${RECIPIENT_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"requestId": "20180813022044Jps2xJ1qsv0",
"recipientSeq": 14,
"sendType": "0",
"messageType": "SMS",
"templateId": "TemplateId",
"templateName": "template name",
"sendNo": "15446859",
"recipientNum": "01000000000",
"countryCode": "82",
"title": "title",
"body": "body",
"requestDate": "2018-08-13 02:20:44.0",
"msgStatusName": "COMPLETED",
"msgStatus": "3",
"messageCount": 0,
"resultCode": "3015",
"receiveDate": "2018-08-13 02:20:48.0",
"attachFileList": [],
"originCode": "123456789",
"dlr": {
"dlrStatus": "DELIVERED",
"networkCode": "12345",
"errorCode": "0"
}
}
}
}
Value | Type | Description |
---|---|---|
header | Object | Header area |
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestId | String | Request ID |
body.data.recipientSeq | Integer | Recipient sequence |
body.data.sendType | String | Delivery type |
body.data.messageType | String | Message type |
body.data.templateId | String | Template ID |
body.data.templateName | String | Template name |
body.data.sendNo | String | Sender number |
body.data.title | String | Title |
body.data.body | String | Body |
body.data.recipientNum | String | Recipient number |
body.data.requestDate | String | Date and time of request |
body.data.msgStatusName | String | Message status name |
body.data.messageCount | Integer | Number of messages sent |
body.data.resultCode | String | Result code of receiving [Table on result code of receiving] |
body.data.receiveDate | String | Date and time of receiving |
body.data.attachFileList[].filePath | String | Attached file- path |
body.data.attachFileList[].fileName | String | Attached file - file name |
body.data.attachFileList[].fileSize | Long | Attached file - size |
body.data.attachFileList[].fileSequence | Integer | Attached file - file sequence |
body.data.attachFileList[].createDate | String | Attached file - date of creation |
body.data.attachFileList[].updateDate | String | Attached file - date of modification |
body.data.originCode | String | Identification code (For special value-added telecommunication business operators, must use the 9 digit registration number listed on certificates excluding symbols, letters, and spaces.) |
body.data.dlr.dlrStatus | String | DLR status code |
body.data.dlr.networkCode | String | DLR network code |
body.data.dlr.errorCode | String | DLR error code |
[URL]
POST /sms/v3.0/appKeys/{appKey}/attachfile/binaryUpload
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"fileName": "attachment.jpg",
"createUser": "CreateUser",
"fileBody": "{byte[] -> encoded value in Base64}"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
fileName | String | 45 | Required | File name (extensions available only in jpg or jpeg) |
fileBody | Byte[] | 300K | Required | File byte[] value encoded in Base64. * or byte arrangement value |
createUser | String | 100 | Required | File uploading user information |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/attachfile/binaryUpload' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"fileName": "attachement.jpg",
"createUser": "API Guide",
"fileBody": "1234567890"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"fileId": 0,
"fileName": "attachment.jpg",
"filePath": "0/toast-mt-2018-08-10/1609/178576"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.fileId | Integer | File ID |
body.data.fileName | String | File name |
body.data.filePath | String | Default path of attached file (https://domain/attachFile/filePath/fileName) |
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v3.0/appKeys/{appKey}/attachfile/binaryUpload |
[Request body]
{
"fileName": "attachement.jpg",
"createUser": "CreateUser",
"fileBody": "/9j/4AAQSkZJRgABAQEAYABgAAD/4RDSRXhpZgAATU0AKgAAAAgABAE7AAIAAAAESkdHAIdpAAQAAAABAAAISpydAAEAAAAIAAAQwuocAAcAAAgMAAAAPgAAAAAc6gAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFkAMAAgAAABQAABCYkAQAAgAAABQAABCskpEAAgAAAAM1MgAAkpIAAgAAAAM1MgAA6hwABwAACAwAAAiMAAAAABzqAAAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMjAxODowMjowOCAxNjoyOTo0MQAyMDE4OjAyOjA4IDE2OjI5OjQxAAAASgBHAEcAAAD/4QsWaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49J++7vycgaWQ9J1c1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCc/Pg0KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyI+PHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj48cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0idXVpZDpmYWY1YmRkNS1iYTNkLTExZGEtYWQzMS1kMzNkNzUxODJmMWIiIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIvPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIj48eG1wOkNyZWF0ZURhdGU+MjAxOC0wMi0wOFQxNjoyOTo0MS41MTc8L3htcDpDcmVhdGVEYXRlPjwvcmRmOkRlc2NyaXB0aW9uPjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSJ1dWlkOmZhZjViZGQ1LWJhM2QtMTFkYS1hZDMxLWQzM2Q3NTE4MmYxYiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj48ZGM6Y3JlYXRvcj48cmRmOlNlcSB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPjxyZGY6bGk+SkdHPC9yZGY6bGk+PC9yZGY6U2VxPg0KCQkJPC9kYzpjcmVhdG9yPjwvcmRmOkRlc2NyaXB0aW9uPjwvcmRmOlJERj48L3g6eG1wbWV0YT4NCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgPD94cGFja2V0IGVuZD0ndyc/Pv/bAEMABwUFBgUEBwYFBggHBwgKEQsKCQkKFQ8QDBEYFRoZGBUYFxseJyEbHSUdFxgiLiIlKCkrLCsaIC8zLyoyJyorKv/bAEMBBwgICgkKFAsLFCocGBwqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKv/AABEIABoAHQMBIgACEQEDEQH/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/APD6K6e88IxWemTamdQaSx+zW8trJ5GDPJLkGMjd8u0pKCcn7nTmq/jDTbHSvH2qadao1vY2940aqmZGRAe24/MQPU8+tVs7ev4f8OT0uYFFdvrmhWmo/Ee30wXVpp9rcWlvIs0FmIAQbZXX90ZCPMbgY34LHqM1zes6bbaXq81mHv18rAK3tiLeZWxyGj3tt/M5HpTWrsGyv/Wpb1bXIp/DekaLYzXEsFj5kztcRhP3shGVUBmyq44ORksxwM1JrfiyLXtSa/u/DmkpdSXHnzyRPdDz/VWBmIAPfaFPoRXO0UgOk1Pxemq6vb3914d0jMMAgeFftBjmRYxGgbMpYFVUYKlTnqTWfruuz69dQSTW8FrFa26W1vb24bZFGucKC7Mx5JOWYnn0wKy6KAP/2Q=="
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"fileId": 0,
"fileName": "attachment.jpg",
"filePath": "0/toast-mt-2018-08-10/1609/178576"
}
}
}
[URL]
POST /sms/v3.0/appKeys/{appKey}/categories
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"categoryParentId": 0,
"categoryName": "",
"categoryDesc": "",
"useYn": "",
"createUser": ""
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
categoryParentId | Integer | - | Optional | Parent category ID [Default: Highest category] |
categoryName | String | 50 | Required | Category ID |
categoryDesc | String | 100 | Optional | Category name |
useYn | String | 1 | Required | Use or Not (Y/N) |
createUser | String | 100 | Optional | Registered user |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/categories' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"categoryParentId": 0,
"categoryName": "API Guide",
"categoryDesc": "API Guide Test",
"useYn": "Y",
"createUser": "API Guide"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"categoryId": 0,
"categoryParentId": 0,
"depth": 0,
"sort": 0,
"categoryName": "",
"categoryDesc": "",
"useYn": "",
"createUser": ""
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryParentId | Integer | Parent category ID |
body.data[].depth | Integer | Depth of category |
body.data[].sort | Integer | Sorting order of category |
body.data[].categoryName | String | Category name |
body.data[].categoryDesc | String | Category description |
body.data[].useYn | String | Use or not |
body.data[].createUser | String | Registered user |
[URL]
GET /sms/v3.0/appKeys/{appKey}/categories
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
pageNum | Integer | - | Optional | Page number (default : 1) |
pageSize | Integer | 1000 | Optional | Query count (default : 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/categories' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"categoryId": 137612,
"categoryParentId": 0,
"depth": 0,
"sort": 0,
"categoryName": "Category",
"categoryDesc": "Highest category",
"useYn": "Y",
"createDate": "2018-04-17 15:39:56.0",
"createUser": "bb076dc0-ef5e-11e7-9ede-005056ac7022",
"updateDate": "2018-04-17 15:39:56.0",
"updateUser": "bb076dc0-ef5e-11e7-9ede-005056ac7022"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure messagae |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryParentId | Integer | Parent category ID |
body.data[].depth | Integer | Depth of category |
body.data[].sort | Integer | Sorting order of category |
body.data[].categoryName | String | Category name |
body.data[].categoryDesc | String | Category description |
body.data[].useYn | String | Use or not |
body.data[].createDate | String | Date of registration |
body.data[].createUser | String | Registered user |
body.data[].updateDate | String | Date of modification |
body.data[].updateUser | String | Modified user |
[URL]
GET /sms/v3.0/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
categoryId | Integer | Category ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"categoryId": 137612,
"categoryParentId": 0,
"depth": 0,
"sort": 0,
"categoryName": "Category",
"categoryDesc": "Highest category",
"useYn": "Y",
"createDate": "2018-04-17 15:39:56.0",
"createUser": "bb076dc0-ef5e-11e7-9ede-005056ac7022",
"updateDate": "2018-04-17 15:39:56.0",
"updateUser": "bb076dc0-ef5e-11e7-9ede-005056ac7022"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryParentId | Integer | Parent category ID |
body.data[].depth | Integer | Depth of category |
body.data[].sort | Integer | Sorting order of category |
body.data[].categoryName | String | Category name |
body.data[].categoryDesc | String | Category description |
body.data[].useYn | String | Use or not |
body.data[].createDate | String | Date of registration |
body.data[].createUser | String | Registered user |
body.data[].updateDate | String | Date of modification |
body.data[].updateUser | String | Modified user |
[URL]
PUT /sms/v3.0/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
categoryId | Integer | Category ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"categoryName": "",
"categoryDesc": "",
"useYn": "",
"updateUser": ""
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
categoryName | String | 50 | Required | Category ID |
categoryDesc | String | 100 | Optional | Category name |
useYn | String | 1 | Required | Use or not |
updateUser | String | 100 | Optional | Modified user |
curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/categories/'"${C_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"categoryParentId": 788,
"categoryName": "secondMMS",
"categoryDesc": "second category MMS",
"useYn": "Y",
"createUser": "467d9790-ea74-11e5-9ad3-005056ac76e8"
}'
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/categories/{categoryId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
categoryId | Integer | Category ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/categories/'"${CATEGORY_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
[URL]
POST /sms/v3.0/appKeys/{appKey}/templates
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"categoryId": 0,
"templateId": "",
"templateName": "",
"templateDesc": "",
"sendNo": "",
"sendType": "",
"title": "",
"body": "",
"useYn": "",
"attachFileIdList": [
0,
1
]
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
categoryId | Integer | - | Required | Category ID |
templateId | String | 50 | Required | Template ID |
templateName | String | 50 | Required | Template name |
templateDesc | String | 100 | Optional | Template description |
sendNo | String | 13 | Required | Sender number |
sendType | String | 1 | Required | Delivery type (0:Sms, 1:Lms/Mms) |
title | String | 120 | Optional | Text title (required, if delivery type is LMS/MMS) |
body | String | 4000 | Required | Text body |
useYn | String | 1 | Required | Use or not |
attachFileIdList | List |
- | Optional | Attached file ID(fileId) |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"categoryId": 199376,
"templateId": "TemplateId",
"templateName": "Template delivery example",
"templateDesc": "Template delivery example",
"sendNo": "01012341234",
"sendType": "1",
"title": "example",
"body": "Test for general delivery. Dear\r\n##key1##. This is \r\n##key2##.",
"useYn": "Y"
}'
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
Http method | URL |
---|---|
POST | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/templates |
[Request body]
{
"categoryId": 199376,
"templateId": "TemplateId",
"templateName": "Example of template delivery",
"templateDesc": "Example of template delivery",
"sendNo": "01012341234",
"sendType": "1",
"title": "example",
"body": "Test for general delivery.Dear \r\n##key1##. This is \r\n##key2##.",
"useYn": "Y",
"attachFileIdList": [
123123,
456456
]
}
[Response]
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
Http method | Type | URL |
---|---|---|
POST | SMS | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/sms |
POST | MMS | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/mms |
For Request URL, choose a delivery type selected to register templates.
If request parameter body is empty, replace it with the body of the corresponding templateId.
[Request body] Replace with key and value for those for replacement.
{
"templateId": "TemplateId",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {
"key1": "Toast Cloud",
"key2": "SMS"
},
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
[Response]
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20180813095534I4VcVuPBpd0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
Http method | Type | URL |
---|---|---|
POST | SMS | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/sms |
POST | MMS | https://api-sms.cloud.toast.com/sms/v2.4/appKeys/{appKey}/sender/mms |
For Request URL, choose a delivery type selected to register templates.
If template ID and request parameter body include values, sender number and body message are not replaced with template.
Nevertheless, with the input of template ID, it is available to query with the template.
Such case is applicable when template needs to be modified after queried.
[Request body]
{
"templateId": "TemplateId",
"body": "body",
"sendNo": "15446859",
"senderGroupingKey": "SenderGroupingKey",
"recipientList": [
{
"recipientNo": "01000000000",
"templateParameter": {
"key1": "Toast Cloud",
"key2": "SMS"
},
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
[Response]
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "20180813095534I4VcVuPBpd0",
"statusCode": "2",
"senderGroupingKey": "SenderGroupingKey",
"sendResultList": [
{
"recipientNo": "01000000000",
"resultCode": 0,
"resultMessage": "SUCCESS",
"recipientSeq": 1,
"recipientGroupingKey": "RecipientGroupingKey"
}
]
}
}
}
[URL]
GET /sms/v3.0/appKeys/{appKey}/templates
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Required | Description |
---|---|---|---|
categoryId | Integer | Optional | Category ID |
useYn | String | Optional | Use or Not (Y/N) |
pageNum | Integer | Optional | Page number (default : 1) |
pageSize | Integer | Optional | Query count (default : 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/templates' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"templateId": "ee13efe5-58c2-4e61-a59f-1fa47cc21cd0",
"serviceId": 71191,
"categoryId": 415978,
"categoryName": "categoryName",
"sort": 0,
"templateName": "templateName",
"templateDesc": "templateDescription",
"useYn": "Y",
"priority": "S",
"sendNo": "12341234",
"sendType": "0",
"sendTypeName": "SMS 발송",
"title": "title",
"body": "body",
"attachFileYn": "Y",
"delYn": "N",
"createDate": "2023-09-18 14:30:03.0",
"createUser": null,
"updateDate": "2023-09-18 14:30:03.0",
"updateUser": null,
"attachFileList": [
{
"fileId": 535186,
"filePath": "/permanent/71191/toast-mt-2023-09-18/1430/535186",
"fileName": "attachment.jpg",
"saveFileName": "20230918eA8JmR0.jpg",
"uploadType": "TEMPORARY"
}
]
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Faliure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].templateId | String | Template ID |
body.data[].serviceId | Integer | Service ID (unused, for internal purpose) |
body.data[].categoryId | Integer | Category ID |
body.data[].categoryName | String | Category name |
body.data[].sort | Integer | Sorted value |
body.data[].templateName | String | Template name |
body.data[].templateDesc | String | Template description |
body.data[].useYn | String | Use or not |
body.data[].priority | String | Priority value (unused) |
body.data[].sendNo | String | Sender number |
body.data[].sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data[].sendTypeName | String | Name of delivery type |
body.data[].title | String | Title |
body.data[].body | String | Body message |
body.data[].attachFileYn | String | Attached or not (Y/N) |
body.data[].delYn | String | Deleted or not (Y/N): only to show current status |
body.data[].createDate | String | Date of registration |
body.data[].createUser | String | Registered user |
body.data[].updateDate | String | Date of modification |
body.data[].updateUser | String | Modifier |
body.data[].attachFileList[].fileId | Integer | File ID |
body.data[].attachFileList[].filePath | String | Path of file saving (for internal purpose) |
body.data[].attachFileList[].fileName | String | File name |
body.data[].attachFileList[].saveFileName | String | Name of saved file |
body.data[].attachFileList[].uploadType | String | Type of uploaded |
[URL]
GET /sms/v2.4/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
templateId | String | Template ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"templateId": "ee13efe5-58c2-4e61-a59f-1fa47cc21cd0",
"serviceId": 71191,
"categoryId": 415978,
"categoryName": "categoryName",
"sort": 0,
"templateName": "templateName",
"templateDesc": "templateDescription",
"useYn": "Y",
"priority": "S",
"sendNo": "12341234",
"sendType": "0",
"sendTypeName": "SMS 발송",
"title": "title",
"body": "body",
"attachFileYn": "Y",
"delYn": "N",
"createDate": "2023-09-18 14:30:03.0",
"createUser": null,
"updateDate": "2023-09-18 14:30:03.0",
"updateUser": null,
"attachFileList": [
{
"fileId": 535186,
"filePath": "/permanent/71191/toast-mt-2023-09-18/1430/535186",
"fileName": "attachment.jpg",
"saveFileName": "20230918eA8JmR0.jpg",
"uploadType": "TEMPORARY"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data.templateId | String | Template ID |
body.data.serviceId | Integer | Service ID (unused, for internal purpose) |
body.data.categoryId | Integer | Category ID |
body.data.categoryName | String | Category name |
body.data.sort | Integer | Sorted value |
body.data.templateName | String | Template name |
body.data.templateDesc | String | Template description |
body.data.useYn | String | Use or not |
body.data.priority | String | Priority value (unused) |
body.data.sendNo | String | Sender number |
body.data.sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data.sendTypeName | String | Name of delivery type |
body.data.title | String | Title |
body.data.body | String | Body message |
body.data.attachFileYn | String | Attached or not (Y/N) |
body.data.delYn | String | Deleted or not (Y/N): only to show current status |
body.data.createDate | String | Date of registration |
body.data.createUser | String | Registered user |
body.data.updateDate | String | Date of modification |
body.data.updateUser | String | Modifier |
body.data[].attachFileList[].fileId | Integer | File ID |
body.data[].attachFileList[].filePath | String | Path of file saving (for internal purpose) |
body.data[].attachFileList[].fileName | String | File name |
body.data[].attachFileList[].saveFileName | String | Name of saved file |
body.data[].attachFileList[].uploadType | String | Type of uploaded |
[URL]
PUT /sms/v3.0/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"templateName": "",
"templateDesc": "",
"sendNo": "",
"sendType": "",
"title": "",
"body": "",
"useYn": "",
"attachFileIdList": [
0,
1
]
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
templateName | String | 50 | Required | Template name |
templateDesc | String | 100 | Optional | Template description |
sendNo | String | 13 | Required | Sender number |
sendType | String | 1 | Required | Delivery type (0:Sms, 1:Lms/Mms) |
title | String | 120 | Optional | Text title (required, if delivery type is Lms/MmS) |
body | String | 4000 | Required | Text body |
useYn | String | 1 | Required | Use or not |
attachFileIdList | List |
- | Optional | Attached file ID(fileId) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v2.4/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8'
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/templates/{templateId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
templateId | String | Template ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/templates/'"${TEMPLATE_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": "",
"resultMessage": ""
}
}
[URL]
POST /sms/v3.0/appKeys/{appKey}/blockservice/recipients
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"unsubscribeNo": "0800000000",
"recipientNoList": [
"0100000000",
"0100000001"
]
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
unsubscribeNo | String | 25 | O | 080 numbers to reject receiving |
recipientNoList | List |
10 | O | Contact number of unsubscribers to be added |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/blockservice/recipients' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"unsubscribeNo": "0800000000",
"recipientNoList": [
"0100000000",
"0100000001"
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "Success"
}
}
[URL]
GET /sms/v3.0/appKeys/{appKey}/blockservice/recipients
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
unsubscribeNo | String | 25 | Required | 080 numbers to reject receiving |
recipientNo | String | 25 | Optional | Contact number of unsubscribers |
startRequestDate | String | - | Optional | Start value of request for reject receiving (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Optional | End value of request for reject receiving (yyyy-MM-dd HH:mm:ss) |
pageNum | Integer | - | Optional | Page number (default: 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/blockservice/recipients' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 1,
"data": [
{
"unsubscribeNo": "0808888888",
"recipientNo": "01000000000",
"requestDate": "2018-05-14 17:07:29.0"
}
]
}
}
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/blockservice/recipients/removes?unsubscribeNo={unsubscribeNo}&updateUser={updateUser}&recipientNoList={recipientNo},{recipientNo}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
unsubscribeNo | String | 20 | Required | 080 numbers to reject receiving |
updateUser | String | 100 | Required | User who delete rejection of receiving |
recipientNo | String | 20 | Required | Rejected numbers to be deleted |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/blockservice/recipients/removes?unsubscribeNo='"${UNSUB_NO}"'&updateUser='"${UPDATE_USER}"'&recipientNoList='"${RECIPIENT_NO}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"body": null
}
[URL]
Http method | URI |
---|---|
GET | /sms/v3.0/appKeys/{appKey}/sendNos?sendNo={sendNo}&useYn={useYn}&blockYn={blockYn}&pageNum={pageNum}&pageSize={pageSize} |
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Description |
---|---|---|
sendNo | String | Sender number |
useYn | String | Use or not |
blockYn | String | Block or not |
pageNum | Integer | Page number (default : 1) |
pageSize | Integer | Number of queries (default : 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sendNos' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 2,
"data": [
{
"appKey": null,
"serviceId": 71191,
"sendNo": "01012341234",
"useYn": "Y",
"blockYn": "N",
"blockReason": null,
"createDate": "2023-07-18 12:05:35",
"createUser": "test@nhn.com",
"updateDate": "2023-07-31 13:45:48",
"updateUser": "test@nhn.com"
},
{
"appKey": null,
"serviceId": 71191,
"sendNo": "12341234",
"useYn": "Y",
"blockYn": "N",
"blockReason": null,
"createDate": "2023-09-14 10:30:30",
"createUser": "test@nhn.com",
"updateDate": "2023-09-14 10:30:30",
"updateUser": null
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].serviceId | Integer | Service ID |
body.data[].sendNo | String | Sender number |
body.data[].useYn | String | Use or not |
body.data[].blockYn | String | Block or not |
body.data[].blockReason | String | Cause of blockage |
body.data[].createDate | String | Date and time of creation |
body.data[].createUser | String | Creator |
body.data[].updateDate | String | Date of modification |
body.data[].updateUser | String | Modified user |
[URL]
Http method | URI |
---|---|
GET | /sms/v3.0/appKeys/{appKey}/stats |
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Maximum length | Required | Description |
---|---|---|---|---|
statisticsType | String | - | Required | Statistics tpye NORMAL: Normal, MINUTELY: Minutely, HOURLY: Hourly, DAILY: Daily, BY_DAY: By day |
from | String | - | Required | Start date of statistics search yyyy-MM-dd HH:mm:ss |
to | String | - | Required | End date of statistics search yyyy-MM-dd HH:mm:ss |
statsIds | List |
- | Option | Statistics ID list |
messageType | String | - | Option | Message type SMS, LMS, MMS, AUTH |
isAd | Boolean | - | Option | Advertise or not true/false |
templateIds | List |
- | Option | Template ID list |
requestIds | List |
5 | Option | Request ID list |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/stats?statisticsType='"${STATISTICS_TYPE}"'&from='"${FROM}"'&to='"${TO}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"eventDateTime": "",
"events": {
"requested": 10,
"sent": 10,
"sentFailed" : 0,
"received": 0
}
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data | List | Statistical event objects |
Value | Type | Description |
---|---|---|
eventDateTime | String | Display name Minutely, Hourly, Daily, Monthly |
events | Object | Statistics value object |
events.requested | Integer | Number of requests |
events.sent | Integer | Number of sent items |
events.sentFailed | Integer | Number of failures |
events.received | Integer | Number of successes |
[URL]
Http method | URI |
---|---|
GET | /sms/v3.0/appKeys/{appKey}/stats/legacy |
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
statisticsType | String | - | Required | Statistics Category NORMAL:Default, MINUTELY:By the minute, HOURLY:By the hour, DAILY: By the day, BY_DAY:By day |
from | String | - | Required | Start date of statistics search yyyy-MM-dd HH:mm:ss |
to | String | - | Required | End date of statistics search yyyy-MM-dd HH:mm:ss |
statsIds | List |
- | Optional | Statistics ID List |
messageType | String | - | Optional | Message Type SMS, LMS, MMS, AUTH |
isAd | Boolean | - | Optional | Ad or not true/false |
templateIds | List |
- | Optional | Template ID List |
requestIds | List |
5 | Optional | Request ID List |
statsCriteria | List |
Option | Stats criteria - EVENT: event(default value) - TEMPLATE_ID,EVENT: template, event - EXTRA_1,EVENT: message type, event - EXTRA_2,EVENT: ad on/off, event - EXTRA_3,EVENT: calling number, event |
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"eventDateTime": "",
"events": {
"requested": 10,
"sent": 10,
"sentFailed": 0,
"received": 0,
"pending": 0
}
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data | List | Statistical event objects |
Value | Type | Description |
---|---|---|
eventDateTime | String | Display name Minutely, Hourly, Daily, Monthly |
events | Object | Statistics value object |
events.requested | Integer | Number of requests |
events.sent | Integer | Number of sent items |
events.sentFailed | Integer | Number of failures |
events.received | Integer | Number of successes |
events.pending | Integer | Number of pending items |
[URL]
Http method | URI |
---|---|
GET | /sms/v3.0/appKeys/{appKey}/stats/international |
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Unique appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Unique secret key |
[Query parameter]
Value | Type | Maximum length | Required | Description |
---|---|---|---|---|
statisticsType | String | - | Required | Statistics Type NORMAL: Normal, MINUTELY: Minutely, HOURLY: Hourly, DAILY: Daily, BY_DAY: By day |
from | String | - | Required | Start date of statistics search yyyy-MM-dd HH:mm:ss |
to | String | - | Required | End date of statistics search yyyy-MM-dd HH:mm:ss |
statsIds | List |
- | Option | Statistics ID list |
countryCode | String | - | Option | Country code |
requestIds | List |
5 | Option | Request ID list |
statsCriteria | List |
- | Option | Statistics criteria - EVENT: Event (Default Value) - COUNTRY_CODE,EVENT: Country code, event |
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"eventDateTime": "",
"events": {
"REQUESTED": 10,
"SENT": 10,
"SENT_FAILED": 0,
"CONCAT": 20,
"READY": 5,
"CONVERTED": 3
}
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data | List | Statistical event objects |
Value | Type | Description |
---|---|---|
eventDateTime | String | Display name Minutely, Hourly, Daily, Monthly |
events | Object | When statsCriteria is set only as EVENT {statsCriteriaValue} is omitted |
events.REQUESTED | Integer | Number of requests |
events.SENT | Integer | Number of sent items |
events.SENT_FAILED | Integer | Number of failures |
events.CONCAT | Integer | Number of successes |
events.READY | Integer | Number of conversion rate collection requests successfuly sent |
events.CONVERTED | Integer | Number of converted items |
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"eventDateTime": "",
"events": {
"{statsCriteriaValue}": {
"REQUESTED": 10,
"SENT": 10,
"SENT_FAILED": 0,
"CONCAT": 10,
"READY": 5,
"CONVERTED": 3
},
"{statsCriteriaValue}": {
"REQUESTED": 10,
"SENT": 10,
"SENT_FAILED": 0,
"CONCAT": 20
"READY": 5,
"CONVERTED": 3
}
}
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data | List | Statistical event objects |
Value | Type | Description |
---|---|---|
eventDateTime | String | Display name Minutely, Hourly, Daily, Monthly |
events.{statsCriteriaValue} | Object | Value for statsCriteria Can be country code |
events.{statsCriteriaValue}.REQUESTED | Integer | Number of requests |
events.{statsCriteriaValue}.SENT | Integer | Number of sent items |
events.{statsCriteriaValue}.SENT_FAILED | Integer | Number of failures |
events.{statsCriteriaValue}.CONCAT | Integer | Number of successes |
events.{statsCriteriaValue}.READY | Integer | Number of conversion rate collection requests successfuly sent |
events.{statsCriteriaValue}.CONVERTED | Integer | Number of converted items |
[URL]
Http method | URI |
---|---|
GET | /sms/v3.0/appKeys/{appKey}/statistics/view?searchType={searchType}&from={from}&to={to}&messageTypes={messageType}&contentTypes={contentType}&templateId={templateId} |
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
searchType | String | 10 | O | Type of statistics DATE:By date, TIME:By time, DAY:By day |
from | String | - | O | Start date of query statistics yyyy-MM-dd HH:mm |
to | String | - | O | End date of query statistics yyyy-MM-dd HH:mm |
messageType | String | 10 | X | Message type SMS: Short messages, LMS: Long messages, MMS: Attachment, AUTH: Authentication |
contentType | String | 10 | X | Content type NORMAL: General, AD: Advertisement |
templateId | String | 50 | X | Template ID |
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": [
{
"divisionName": "2018-06-01",
"statisticsView": {
"requestedCount": 10,
"succeedCount": 10,
"failedCount": 0,
"pendingCount": 0,
"succeedRate": "100.00",
"failedRate": "0.00",
"pendingRate": "0.00"
}
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].divisionName | String | Display name Date, time, Day |
body.data[].statisticsView | Object | |
body.data[].requestedCount | Integer | Number of requests |
body.data[].succeedCount | Integer | Success count |
body.data[].failedCount | Integer | Failure count |
body.data[].pendingCount | Integer | Delivery count |
body.data[].succeedRate | String | Success rate |
body.data[].failedRate | String | Failure rate |
body.data[].pendingRate | String | Delivery rate |
[URL]
GET /sms/v3.0/appKeys/{appKey}/reservations
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
sendType | String | 1 | Optional | Delivery type (0:SMS, 1:LMS/MMS, 2:AUTH) |
requestId | String | 25 | Optional | Request ID |
startRequestDate | String | - | Optional | Start date of sending (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Optional | End date of sending (yyyy-MM-dd HH:mm:ss) |
startCreateDate | String | - | Optional | Start date of registration (yyyy-MM-dd HH:mm:ss) |
endCreateDate | String | - | Optional | End date of registration (yyyy-MM-dd HH:mm:ss) |
sendNo | String | 13 | Optional | Sender number |
recipientNo | String | 20 | Optional | Recipient number |
templateId | String | 50 | Optional | Template number |
messageStatus | String | 10 | Optional | Message status (RESERVED: Ready for schedule, SENDING: Sending, COMPLETED:Delivery completed, FAILED: Delivery failed, CANCEL: Canceled, DUPLICATED: Duplicate delivery, FAILED_AD: Failed (Ad restricted), RESEND_AD: Waiting for Resending (Ad restricted)) |
pageNum | Integer | - | Optional | Page number (default: 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/reservations' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"pageNum": 1,
"pageSize": 15,
"totalCount": 15,
"data": [
{
"requestId": "{request ID}",
"recipientSeq": 1,
"requestDate": "{scheduled date}",
"sendNo": "{sender number}",
"recipientNo": "{recipient number}",
"countryCode": "{country code}",
"sendType": "{delivery type}",
"messageType": "{message type}",
"adYn": "{Ad or not}",
"templateId": "{template ID}",
"templateParameter": "{template parameter}",
"templateName": "{template name}",
"title": "{title}",
"body": "{body}",
"messageStatus": "{message status}",
"createUser": "{registered user}",
"createDate": "{date and time of registration}",
"updateDate": "{modified date}"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data[].requestId | String | Request ID |
body.data[].recipientSeq | Integer | Recipient sequence |
body.data[].requestDate | String | Date and time of sending |
body.data[].sendNo | String | Sender number |
body.data[].recipientNo | String | Recipient number |
body.data[].countryCode | String | Country code |
body.data[].sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data[].messageType | String | Message type (SMS,LMS,MMS,AUTH) |
body.data[].adYn | String | Ad or not |
body.data[].templateId | String | Template ID |
body.data[].templateParameter | String(json) | Template parameter |
body.data[].templateName | String | Template name |
body.data[].title | String | Title |
body.data[].body | String | Body message |
body.data[].messageStatus | String | Message status (RESERVED: Ready for schedule, SENDING: Sending, COMPLETED:Delivery completed, FAILED: Delivery failed, CANCEL: Canceled, DUPLICATED: Duplicate delivery, FAILED_AD: Failed (Ad restricted), RESEND_AD: Waiting for Resending (Ad restricted)) |
body.data[].createUser | String | Registered user |
body.data[].createDate | String | Date of registration |
body.data[].updateDate | String | Date of modification |
[URL]
GET /sms/v2.4/appKeys/{appKey}/reservations/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
requestId | String | Request ID |
recipientSeq | Integer | Recipient sequence |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/reservations/'"${R_ID}"'/'"${R_SEQ}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"requestId": "{request ID}",
"recipientSeq": 1,
"requestDate": "{scheduled date}",
"sendNo": "{sender number}",
"recipientNo": "{recipient number}",
"countryCode": "{country code}",
"sendType": "{delivery type}",
"messageType": "{message type}",
"adYn": "{ad or not}",
"templateId": "{template ID}",
"templateParameter": "{template parameter}",
"templateName": "{template name}",
"title": "{title}",
"body": "{body}",
"messageStatus": "{message status}",
"createUser": "{registered user}",
"createDate": "{date and time of registration}",
"updateDate": "{modified date}",
"attachFileList": [
{
"fileId": 535186,
"filePath": "/permanent/71191/toast-mt-2023-09-18/1430/535186",
"fileName": "attachment.jpg",
"saveFileName": "20230918eA8JmR0.jpg",
"uploadType": "TEMPORARY"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Current page number |
body.pageSize | Integer | Queried data count |
body.totalCount | Integer | Total data count |
body.data.requestId | String | Request ID |
body.data.recipientSeq | Integer | Recipient sequence |
body.data.requestDate | String | Date and time of sending |
body.data.sendNo | String | Sender number |
body.data.recipientNo | String | Recipient number |
body.data.countryCode | String | Country code |
body.data.sendType | String | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
body.data.messageType | String | Message type (SMS,LMS,MMS,AUTH) |
body.data.adYn | String | Ad or not |
body.data.templateId | String | Template ID |
body.data.templateParameter | String(json) | Template parameter |
body.data.templateName | String | Template name |
body.data.title | String | Title |
body.data.body | String | Body message |
body.data.messageStatus | String | Message status (RESERVED: Ready for schedule, SENDING: Sending, COMPLETED:Delivery completed, FAILED: Delivery failed, CANCEL: Canceled, DUPLICATED: Duplicate delivery, FAILED_AD: Failed (Ad restricted), RESEND_AD: Waiting for Resending (Ad restricted)) |
body.data.createUser | String | Registered user |
body.data.createDate | String | Date of registration |
body.data[].attachFileList[].fileId | Integer | File ID |
body.data[].attachFileList[].filePath | String | Path of file saving (for internal purpose) |
body.data[].attachFileList[].fileName | String | File name |
body.data[].attachFileList[].saveFileName | String | Name of saved file |
body.data[].attachFileList[].uploadType | String | Type of uploaded |
[URL]
PUT /sms/v2.4/appKeys/{appKey}/reservations/cancel
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"reservationList": [
{
"requestId": "{requestId}",
"recipientSeq": 1
}
],
"updateUser": "{updateUser}"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
reservationList[].requestId | String | 25 | O | Request ID |
reservationList[].recipientSeq | Integer | - | O | Recipient sequence |
updateUser | String | 100 | O | Requesting user for cancellation |
curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/reservations/cancel' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"reservationList": [
{
"requestId": "1",
"recipientSeq": 1
}
],
"updateUser": "API Guide"
}'
[Response body]
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"requestedCount": 1,
"canceledCount": 1
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.requestedCount | Integer | Number of failed requests |
body.data.canceledCount | Integer | Number of successful cancellation |
[URL]
PUT /sms/v2.4/appKeys/{appKey}/reservations/search-cancels
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"searchParameter": {
"sendType": "0",
"startRequestDate": "2020-02-01 00:00",
"endRequestDate": "2020-02-01 10:00",
"startCreateDate": "2020-02-01 00:00",
"endCreateDate": "2020-02-01 10:00",
"sendNo": "15880000",
"recipientNo": "0100000000",
"templateId": "TemplateId",
"requestId": "20200201010630ReZQ6KZzAH0",
"createUser": "CreateUser",
"senderGroupingKey": "SenderGroupingKey"
},
"updateUser": "UpdateUser"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
searchParameter.sendType | String | 1 | Required | Delivery type(0:Sms, 1:Lms/Mms, 2:Auth) |
searchParameter.startRequestDate | String | - | Required | Start date of delivery |
searchParameter.endRequestDate | String | - | Required | End date of delivery |
searchParameter.startCreateDate | String | - | Required | Start date of registration |
searchParameter.endCreateDate | String | - | Required | End date of registration |
searchParameter.sendNo | String | 20 | Optional | Sender number |
searchParameter.recipientNo | String | 20 | Optional | Recipient number |
searchParameter.templateId | String | 50 | Optional | Delivery template ID |
searchParameter.requestId | String | 25 | Optional | Request ID |
searchParameter.createUser | String | 100 | Optional | Request Creator of Scheduled Delivery |
searchParameter.senderGroupingKey | String | 100 | Optional | Sender group key |
searchParameter.recipientGroupingKey | String | 100 | Optional | Recipient group key |
updateUser | String | 100 | Required | Requester of Scheduled Cancellation |
curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"searchParameter": {
"sendType": "0",
"startRequestDate": "2020-02-01 00:00",
"endRequestDate": "2020-02-01 10:00",
"startCreateDate": "2020-02-01 00:00",
"endCreateDate": "2020-02-01 10:00",
"sendNo": "15880000",
"recipientNo": "0100000000",
"templateId": "TemplateId",
"requestId": "20200201010630ReZQ6KZzAH0",
"createUser": "CreateUser",
"senderGroupingKey": "SenderGroupingKey"
},
"updateUser": "API Guide"
}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": {
"reservationCancelId": "20200210113330OepQ1sAzSDa",
"requestedDateTime": "2020-02-10 11:33:30",
"reservationCancelStatus": "READY"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.reservationCancelId | Integer | Schedule Cancellation ID |
body.data.requestedDateTime | String | Time for Schedule Cancellation(yyyy-MM-dd HH:mm:ss) |
body.data.reservationCancelStatus | String | Status of Schedule Cancellation - READY : Preparing for Scheduling - PROCESSING : Cancelling Schedule - COMPLETED : Schedule Cancellation Completed - FAILED : Schedule Cancellation Failed |
[URL]
GET /sms/v3.0/appKeys/{appKey}/reservations/search-cancels?startRequestedDateTime={startRequestedDateTime}&endRequestedDateTime={endRequestedDateTime}&reservationCancelId={reservationCancelId}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
startRequestedDateTime | String | - | Optional | Request Start Time for Schedule Cancellation(yyyy-MM-dd HH:mm:ss) |
endRequestedDateTime | String | - | Optional | Request End Time for Schedule Cancellation(yyyy-MM-dd HH:mm:ss) |
reservationCancelId | String | 25 | Optional | Schedule Cancellation ID |
pageNum | Integer | - | Optional | Page number (default: 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/reservations/search-cancels' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"resultCode": 0,
"resultMessage": "success",
"isSuccessful": true
},
"body": {
"data": [
{
"reservationCancelId": "",
"searchParameter": {
},
"requestedDateTime": "",
"completedDateTime": "",
"reservationCancelStatus": "",
"totalCount": 0,
"successCount": 0,
"createUser": "",
"createdDateTime": "",
"updatedDateTime": ""
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data[].reservationCancelId | String | Schedule Cancellation ID |
body.data[].searchParameter | Map |
Request Parameter for Schedule Cancellation |
body.data[].requestedDateTime | String | Request Time for Schedule Cancellation |
body.data[].completedDateTime | String | Request End Time for Schedule Cancellation |
body.data[].reservationCancelStatus | String | Status of Schedule Cancellation - READY : Preparing for Scheduling - PROCESSING : Cancelling Schedule - COMPLETED : Schedule Cancellation Completed - FAILED : Schedule Cancellation Failed |
body.data[].totalCount | Integer | Number of Scheduled Cancellation Targets |
body.data[].successCount | Integer | Number of Successful Schedule Cancellation |
body.data[].createUser | String | Requester of Scheduled Cancellation |
body.data[].createdDateTime | String | Request Creation Time for Schedule Cancellation |
body.data[].updatedDateTime | String | Modified Time for Scheduled Cancellation |
[URL]
POST /sms/v3.0/appKeys/{appKey}/sender/download-reservations
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"sendType": "1",
"requestId": "20190601100630ReZQ6KZzAH0",
"startRequestDate": "2019-06-01 00:00:00",
"endRequestDate": "2019-06-08 00:00:00",
"startCreateDate": "2019-06-01 00:00:00",
"endCreateDate": "2019-06-08 00:00:00",
"startResultDate": "2019-06-01 00:00:00",
"endResultDate": "2019-06-08 00:00:00",
"sendNo": "15446859",
"recipientNo": "01000000000",
"templateId": "TemplateId",
"msgStatus": "3",
"resultCode": "MTR2",
"subResultCode": "MTR2_3",
"senderGroupingKey": "{sender's group key}",
"recipientGroupingKey": "{recipient's group key}",
"isIncludeTitleAndBody": true
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
sendType | String | 1 | O | Delivery type (0:Sms, 1:Lms/Mms, 2:Auth) |
requestId | String | 25 | Conditionally required (no.1) | Request ID |
startRequestDate | String | - | Conditionally required (no.2) | Start date of delivery (yyyy-MM-dd HH:mm:ss) |
endRequestDate | String | - | Conditionally required (no.2) | End date of delivery (yyyy-MM-dd HH:mm:ss) |
startCreateDate | String | - | Required | Start date of registration (yyyy-MM-dd HH:mm:ss) |
endCreateDate | String | - | Required | End date of registration (yyyy-MM-dd HH:mm:ss) |
startResultDate | String | - | Optional | Start date of receiving (yyyy-MM-dd HH:mm:ss) |
endResultDate | String | - | Optional | End date of receiving (yyyy-MM-dd HH:mm:ss) |
sendNo | String | 13 | Optional | Sender number |
recipientNo | String | 20 | Optional | Receiving number |
templateId | String | 50 | Optional | Template number |
msgStatus | String | 1 | Optional | Message status code (0:Failed, 1: requesting, 2: processing, 3:successful, 4:Delivery Cancelled, 5:Duplicate Delivery, 6: Failed (Ad restricted), 7: Waiting for Resending (Ad restricted)) |
resultCode | String | 10 | Optional | Result code of receiving [Table on Query Codes] |
subResultCode | String | 10 | Optional | Detail code of receiving [Table on Query Codes] |
senderGroupingKey | String | 100 | Optional | Sender's group key |
recipientGroupingKey | String | 100 | Optional | Recipient's group key |
isIncludeTitleAndBody | Boolean | - | Optional | Title and body included or not |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/sender/download-reservations' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"sendType": "1",
"startRequestDate": "2020-08-01T00:00:00",
"endRequestDate": "2020-08-08T00:00:00"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "success"
},
"body": {
"data": {
"downloadId": "20190610100630ReZQ6KZzAH0",
"downloadType": "NORMAL",
"fileType": "CSV",
"downloadStatusCode": "COMPLETED",
"expiredDate": "2019-07-09 10:06:00.0"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.downloadId | String | Download ID |
body.data.downloadType | String | Download type - BLOCK: Block receiving - NORMAL: General delivery - MASS: Mass delivery - TAG: Tag delivery |
body.data.fileType | String | File type (currently supports csv only) |
body.data.downloadStatusCode | String | Status of File Creation - READY: Preparing to create - MAKING: Creating - COMPLETED: Creation completed - FAILED: Creation failed - EXPIRED: Download period expired |
body.data.expiredDate | String | Date and time of expiration for download period |
[URL]
GET /sms/v2.4/appKeys/{appKey}/download-reservations?downloadId={downloadId}&downloadStatusCode={downloadStatusCode}&pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
downloadId | String | 25 | Optional | Download ID |
downloadStatusCode | String | 10 | Optional | Status code of download file |
pageNum | Integer | - | Optional | Page number (default: 1) |
pageSize | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/download-reservations' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"totalCount": 0,
"data": [
{
"downloadId": "",
"downloadType": "",
"fileType": "",
"parameter": "",
"size": 0,
"downloadStatusCode": "",
"resultMessage": "",
"expiredDate": "",
"createUser": "",
"createDate": "",
"updateDate": ""
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.totalCount | Integer | Total count |
body.data[].downloadId | String | Download ID |
body.data[].downloadType | String | Download type - BLOCK: Block receiving - NORMAL: General delivery - MASS: Mass delivery - TAG: Tag delivery |
body.data[].fileType | String | File type |
body.data[].parameter | String | Request parameter |
body.data[].size | Integer | Size of query data |
body.data[].downloadStatusCode | String | Status of file creation - READY: Preparing to create - MAKING: Creating - COMPLETED: Creation completed - FAILED: Creation failed - EXPIRED: Download period expired |
body.data[].resultMessage | String | Result message (respond when it fails) |
body.data[].expiredDate | String | Date and time of file expiration |
body.data[].createUser | String | Requester for file creation |
body.data[].createDate | String | Date and time of request for file creation |
body.data[].updateDate | String | Date and time of completion or failure of file creation |
[URL]
GET /sms/v3.0/appKeys/{appKey}/download-reservations/{downloadId}/download
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
downloadId | String | Download ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/download-reservations/'"${DOWNLOAD_RESERVATION_ID}"'/download' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
file byte
[URL]
GET /sms/v3.0/appKeys/{appKey}/tags?pageNum={pageNum}&pageSize={pageSize}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
pageNum | Integer | - | Optional | Page number (Default : 1) |
pageSize | Integer | 1000 | Optional | Number of queries (Default : 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"pageNum": 1,
"pageSize": 1,
"totalCount": 1,
"data": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
]
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.pageNum | Integer | Page number |
body.pageSize | Integer | Number of queries |
body.totalCount | Integer | Total data count |
body.data[].tagId | String | Tag ID |
body.data[].tagName | String | Tag name |
body.data[].createdDate | String | Date and time of creation |
body.data[].tagId | String | Date and time of modification |
[URL]
POST /sms/v3.0/appKeys/{appKey}/tags
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"tagName": "TAG"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
tagName | String | 30 | Required | Tag name |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tags' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"tagName": "API-Guide"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"tagId": "ABCD1234"
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.tagId | String | Tag ID |
[URL]
PUT /sms/v2.4/appKeys/{appKey}/tags/{tagId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
tagId | String | Tag ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"tagName": "TAG"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
tagName | String | 30 | Required | Tag name |
curl -X PUT \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"tagName": "API-Guide2"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/tags/{tagId}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
tagId | String | Tag ID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/tags/'"${TAG_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
GET /sms/v2.4/appKeys/{appKey}/uids?wheres={wheres}&offsetUid={offsetUid}&offset={offset}&limit={limit}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Query parameter]
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
wheres | List |
- | Optional | Query conditions. Character strings comprised of alphabets, numbers, and parentheses. Allows one parenthesis, and up to three AND or ORs. e.g.) tagId1,AND,tagId2 |
offsetUid | String | - | Optional | offset UID |
offset | Integer | - | Optional | offset (default: 0) |
limit | Integer | 1000 | Optional | Number of queries (default: 15) |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"uids": [
{
"uid": "UID",
"tags": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
],
"contacts": [
{
"contactType": "PHONE_NUMBER",
"contact": "test@nhn.com",
"createdDate": "2019-01-01 00:00:00"
}
]
}
],
"last": false,
"totalCount": 5
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.uids[].uid | String | UID |
body.data.uids[].tags[].tagId | String | Tag ID |
body.data.uids[].tags[].tagName | String | Tag name |
body.data.uids[].tags[].createdDate | String | Date and time of tag creation |
body.data.uids[].tags[].updatedDate | String | Date and time of tag modification |
body.data.uids[].contacts[].contactType | String | Contact type(PHONE_NUMBER) |
body.data.uids[].contacts[].contact | String | Contact (phone number) |
body.data.uids[].contacts[].createdDate | String | Date and time of contact creation |
body.data.uids[].last | Boolean | Last on list or not |
[URL]
GET /sms/v3.0/appKeys/{appKey}/uids/{uid}
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
uid | String | UID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X GET \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": {
"data": {
"uid": "UID",
"tags": [
{
"tagId": "ABCD1234",
"tagName": "TAG",
"createdDate": "2019-01-01 00:00:00",
"updatedDate": "2019-01-01 00:00:00"
}
],
"contacts": [
{
"contactType": "PHONE_NUMBER",
"contact": "0100000000",
"createdDate": "2019-01-01 00:00:00"
}
]
}
}
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
body.data.uid | String | UID |
body.data.tags[].tagId | String | Tag ID |
body.data.tags[].tagName | String | Tag name |
body.data.tags[].createdDate | String | Date and time of tag creation |
body.data.tags[].updatedDate | String | Date and time of tag modification |
body.data.contacts[].contactType | String | Contact type |
body.data.contacts[].contact | String | Contact(phone number) |
body.data.contacts[].createdDate | String | Date and time of contact creation |
[URL]
POST /sms/v2.4/appKeys/{appKey}/uids
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"uids": [
{
"uid": "UID",
"tagIds": [
"ABCD1234"
],
"contacts": [
{
"contactType": "PHONE_NUMBER",
"contact": "0100000000"
}
]
}
]
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
uid | String | - | Required | UID |
tagIds[] | String | - | Required | List of tag IDs |
contacts[].contactType | String | - | Required | Contact type(PHONE_NUMBER) |
contacts[].contact | String | - | Required | Contact (phone number) |
[Caution]
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids/' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"uids": [
{
"uid": "USER ID",
"contacts": [
{
"contactType": "PHONE_NUMBER",
"contact": "0100000000"
}
]
}
]
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/uids/{uid}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
uid | String | UID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
POST /sms/v3.0/appKeys/{appKey}/uids/{uid}/phone-numbers
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
uid | String | UID |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
[Request body]
{
"phoneNumber": "0100000000"
}
Value | Type | Max Length | Required | Description |
---|---|---|---|---|
phoneNumber | String | - | Required | Phone number |
curl -X POST \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}/phone-numbers" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}' \
-d '{
"phoneNumber": "0100000000"
}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |
[URL]
DELETE /sms/v3.0/appKeys/{appKey}/uids/{uid}/phone-numbers/{phoneNumber}
Content-Type: application/json;charset=UTF-8
[Path parameter]
Value | Type | Description |
---|---|---|
appKey | String | Original appkey |
uid | String | UID |
phoneNumber | String | Mobile phone number |
[Header]
{
"X-Secret-Key": "{secret-key}"
}
Value | Type | Description |
---|---|---|
X-Secret-Key | String | Original secret key |
curl -X DELETE \
'https://api-sms.cloud.toast.com/sms/v3.0/appKeys/'"${APP_KEY}"'/uids/'"${USER_ID}"'/phone-numbers/'"${P_NO}" \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Secret-Key: {secretkey}'
{
"header": {
"isSuccessful": true,
"resultCode": 0,
"resultMessage": "SUCCESS"
},
"body": null
}
Value | Type | Description |
---|---|---|
header.isSuccessful | Boolean | Successful or not |
header.resultCode | Integer | Failure code |
header.resultMessage | String | Failure message |