- Print
- PDF
SMS API
- Print
- PDF
The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Basic information
API URL
API Header
Item | Mandatory | Description |
---|---|---|
Content-Type | Mandatory | Specifies the request body content type as application/json (POST) |
x-ncp-apigw-timestamp | Mandatory | - Time elapsed in milliseconds since January 1, 1970 00:00:00 (UTC) - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid |
x-ncp-iam-access-key | Mandatory | This is the Access Key ID issued by the portal or Sub Account |
x-ncp-apigw-signature-v2 | Mandatory | - Signature comprising the above example body encrypted with a SecretKey mapped with Access Key ID - HmacSHA256 is used as the HMAC encryption algorithm |
NAVER Cloud Platform authentication key and Signature creation guide
Messages
Send message
This sends SMS/LMS/MMS messages.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Headers
Request body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
type | Mandatory | String | SMS Type | SMS, LMS, MMS (lowercase) |
contentType | Optional | String | Message type | - COMM: regular message - AD: ad message - default: COMM |
countryCode | Optional | String | Country number | - Can only send to countries provided by SENS - default: 82 - Country list to send international SMS |
from | Mandatory | String | Caller ID | Only the pre-registered caller ID can be used |
subject | Optional | String | Title of default message | Only available in LMS and MMS - LMS, MMS: up to 40 bytes |
content | Mandatory | String | Content of default message | - SMS: up to 90 bytes - LMS, MMS: up to 2000 bytes |
messages | Mandatory | Object | Message information | - Refer to items below (messages.XXX) - Up to 100 |
messages.to | Mandatory | String | Called number | Only numbers except (-) can be entered |
messages.subject | Optional | String | Title of individual message | Only available in LMS and MMS - LMS, MMS: up to 40 bytes |
messages.content | Optional | String | Content of individual message | - SMS: up to 90 bytes - LMS, MMS: up to 2000 bytes |
files.fileId | Optional | String | File ID | Only available in MMS See Upload File |
reserveTime | Optional | String | Reserved date and time | Reserved date and time for message delivery (yyyy-MM-dd HH:mm) |
reserveTimeZone | Optional | String | Time zone of reserved date and time | - Time zone of reserved date and time (default: Asia/Seoul) - List of supported time zones - Use the TZ database name value |
- If the maximum supported size is exceeded, some content will be cut off and sent.
- A message (subject, content) is encoded based on EUC-KR, and the message will be unable to be sent if it contains unsupported emoji characters.
- If the subject and content are not specified in the messages, the values designated as default subject and content are sent.
- The subject and content in the messages have priority over the default subject and content.
- It is MMS type, but if there is no file to attach, it is sent as LMS.
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
requestId | Mandatory | String | Request ID | |
requestTime | Mandatory | DateTime | Request time | yyyy-MM-dd'T'HH:mm:ss.SSS |
statusCode | Mandatory | String | Request status code | - 202: success - Others: failed - Follows the HTTP status specification |
statusName | Mandatory | String | Request status name | - Success: success - Fail: failed |
Response status
HTTP Status | Desc |
---|---|
202 | Accept (Successfully requested) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Upload files
Upload files for sending MMS.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Headers
Request body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
fileName | Mandatory | String | File name | - File name with .jpg or .jpeg extension - Up to 40 characters |
fileBody | Mandatory | String | File body | - Values that encoded .jpg or .jpeg images as Base64 - Up to 300 KB per original file - Resolution up to 1500 * 1440 |
If a file with the same file name and file size to be uploaded already exists, it is recognized as the same file and reused. (stored for 6 days)
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
fileId | Mandatory | String | File ID | Used when sending MMS messages |
createTime | Mandatory | DateTime | File upload time | |
expireTime | Mandatory | DateTime | File expired time |
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully uploaded) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Search for message delivery request
Search for the message delivery request.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
requestId | Mandatory | String | Request ID | Delivery request ID |
requestStartTime | Mandatory | String | Start time of search | yyyy-MM-dd HH:mm:ss |
requestEndTime | Mandatory | String | End time of search | yyyy-MM-dd HH:mm:ss |
completeStartTime | Mandatory | String | Start time to complete delivery | yyyy-MM-dd HH:mm:ss |
completeEndTime | Mandatory | String | End time to complete delivery | yyyy-MM-dd HH:mm:ss |
messageId | Optional | String | Message ID | |
type | Optional | String | Message type | SMS, LMS, MMS |
contentType | Optional | String | Content type | - COMM: regular message - AD: ad message |
countryCode | Optional | String | Country code | |
status | Optional | String | Delivery request status | - READY: ready - PROCESSING: being processed - COMPLETED: processing completed |
from | Optional | String | Message calling number | Numbers without hyphens (-) |
to | Optional | String | Message received number | Numbers without hyphens (-) |
statusName | Optional | String | Device reception status | - SUCCESS: success - FAIL: failed |
pageIndex | Optional | Integer | Page number | default: 0 |
pageSize | Optional | Integer | Page size | default: 20, max: 100 When viewing including requestId, default: 1000 |
- History of delivering message can only be viewed within the last 90 days.
- Either requestId or requestStartTime + requestEndTime or completeStartTime + completeEndTime is required.
- requestStartTime + requestEndTime and completeStartTime + completeEndTime cannot be used simultaneously.
- The query range from requestStartTime to requestEndTime is limited to a maximum of 30 days.
- The query range from completeStartTime to completeEndTime is limited to a maximum of 24 hours.
Headers
Request body
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
statusCode | Mandatory | String | Message delivery status to the messaging server | - 202: success - Others: failed - Follows the HTTP status specification |
statusName | Mandatory | String | Name of the status of sending a message to the messaging server | - Success: success - reserved: being reserved - Fail: failed |
messages.requestId | Mandatory | String | Message request ID | |
messages.messageId | Mandatory | String | Message ID | |
messages.requestTime | Mandatory | String | Delivery request time | yyyy-MM-dd HH:mm:ss |
messages.contentType | Mandatory | String | Message type | - COMM: regular message - AD: ad message |
messages.countryCode | Mandatory | String | Country number | |
messages.from | Mandatory | String | Caller ID | |
messages.to | Mandatory | String | Called number | |
messages.status | Mandatory | String | Delivery request status | - READY: ready - PROCESSING: being processed - COMPLETED: processing completed |
messages.statusCode | Optional | String | Code of device reception status result | - 0: success - Others: Failure (refer to the Error Code table) |
messages.statusName | Optional | String | Name of device reception status result | - Success: success - Fail: failed |
messages.statusMessage | Optional | String | Message of device reception status result | |
messages.completeTime | Optional | String | Delivery completion time | yyyy-MM-dd HH:mm:ss |
messages.telcoCode | Optional | String | Network operator code | |
pageIndex | Mandatory | Integer | Page index (starting from 0) | |
pageSize | Mandatory | Integer | Page size | |
itemCount | Mandatory | Integer | The number of messages within the viewed page | |
hasMore | Mandatory | Boolean | Indicates whether there is a next page |
The fields below that correspond to the received result are not queried until the request status is completed (status: COMPLETED).
- statusCode
- statusName
- statusMessage
- completeTime
- telcoCode
If the name of the delivery request status to the messaging server is "Reserved", the messages fields are not searched.
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully requested) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Search for message delivery result
Search for the message delivery result.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
messageId | Mandatory | String | Message ID | Message identifier that is returned when searching for the message sending requests |
Headers
Request body
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
statusCode | Mandatory | String | Message delivery status to the messaging server | - 200: success - Others: failed |
statusName | Mandatory | String | Name of the status of sending a message to the messaging server | - Success: success - Fail: failed |
messages.requestTime | Mandatory | DateTime | Request time | yyyy-MM-dd HH:mm:ss |
messages.contentType | Mandatory | String | Message type | - COMM: regular message - AD: ad message |
messages.content | Mandatory | String | Message content | It is possible to view the content requested for delivery as it is or to send the actual content according to the length limit for each type of request |
messages.countryCode | Mandatory | String | Country number | |
messages.from | Mandatory | String | Caller ID | |
messages.to | Mandatory | String | Called number | |
messages.status | Mandatory | String | Delivery status in the messaging server | - READY: ready - PROCESSING: being processed - COMPLETED: processing completed |
messages.statusCode | Mandatory | String | Code of device reception status result | - 0: success - Others: failure (refer to the Error Code table) |
messages.statusName | Mandatory | String | Name of device reception status result | - Success: success - Fail: failed |
messages.statusMessage | Mandatory | String | Message of device reception status result | |
messages.completeTime | Mandatory | DateTime | Delivery completion time | yyyy-MM-dd HH:mm:ss |
messages.telcoCode | Mandatory | String | Network operator code | |
files.name | Optional | String | Name of attached file | Only searchable in MMS |
files.fileId | Optional | String | Attached file ID | Only searchable in MMS |
History of message delivery result can only be viewed within the last 90 days.
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully requested) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Reserved message
Search for reserved message status
Search for the reservation status of message delivery.
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
reserveId | Mandatory | String | Reserved message ID | Message identifier that is returned when searching for the reserved delivery requests (requestId) |
Headers
Request body
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
reserveId | Mandatory | String | Reserved message ID | Message identifier that is returned when searching for the reserved delivery requests (requestId) |
reserveTime | Mandatory | String | Reserved date and time | Reserved date and time for message delivery (yyyy-MM-dd HH:mm) |
reserveTimeZone | Mandatory | String | Time zone of reserved date and time | - Time zone of reserved date and time (default: Asia/Seoul) - List of supported time zones - Use the TZ database name value |
reserveStatus | Mandatory | String | Reserved status | - READY: waiting to be sent - PROCESSING: requesting delivery - CANCELED: delivery canceled - FAIL: delivery request failure - DONE: successful delivery request - STALE: delivery request failure (timeout) |
Response status
HTTP Status | Desc |
---|---|
200 | OK (successfully searched) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Cancel reserved message
Cancel the reserved message delivery.
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
reserveId | Mandatory | String | Reserved message ID | Message identifier that is returned when searching for the reserved delivery requests (requestId) |
Headers
Request body
Response body
Response status
HTTP Status | Desc |
---|---|
204 | No Content (successfully deleted) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
080 call block number
Search for call block number
Searches for the call block numbers.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
clientTelNo | Optional | String | Blocked call number | Call block numbers registered in 080 service number |
pageSize | Optional | Integer | Page size | - default: 100 - Only numbers between 0 and 100 can be entered |
pageIndex | Optional | Integer | Page index | default: 0 |
startTime | Optional | Integer | Search start time | - Standard of call block registration time - default: all |
endTime | Optional | Integer | Search end time | - Standard of call block registration time - default: all |
Headers
Request body
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
clientTelNo | Mandatory | String | Blocked call number | |
registerTime | Mandatory | String | Registered time | foramt: LocalDateTime |
registerType | Mandatory | Char | Registering method | - M(manual): manual registration - C(call): phone registration |
Response status
HTTP Status | Desc |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Register call block number
This registers the numbers to be blocked.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Headers
Request body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
clientTelNo | Mandatory | String | Blocked call number | Up to 1000 requests available at a time (list) |
Response body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
clientTelNo | Mandatory | String | Blocked call number | |
registerTime | Mandatory | String | Registered time | foramt: LocalDateTime |
registerType | Mandatory | Char | Registering method | - M(manual): manual registration - C(call): phone registration |
Response status
HTTP Status | Desc |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Delete call block number
This deletes the call block numbers.
Request URL
Path Variables
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Headers
Request body
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
clientTelNo | Mandatory | String | Blocked call number | Up to 1000 requests available at a time (list) |
Response body
Response status
HTTP Status | Desc |
---|---|
204 | No Content (successfully deleted) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
Message sending examples
SMS message
Regular message
Reserved message
Ad message
LMS message
Regular message
Reserved message
Ad message
MMS message
Regular message
Reserved message
Ad message
Error Code
EMMA v.3 reception result code
- EMMA Version: EMMA V3.5.1 and above
- IB G/W Report Code: result code received after transferring to the mobile operator
- IB G/W Response Code: result code given by the relay company G/W after receiving the message
- IB EMMA: Error Code processed by EMMA for message delivery request
IB G/W Report Code
Code | Classification | Meaning |
---|---|---|
0 | success | Succeeded |
2000 | failure | Delivery timeout |
2001 | failure | Delivery failure (wireless network) |
2002 | failure | Delivery failure (wireless network -> device) |
2003 | failure | Device power off |
2004 | failure | Device message buffer full |
2005 | failure | Shadow area |
2006 | failure | Message deleted |
2007 | failure | Temporary device problem |
3000 | Invalid | Delivery unavailable |
3001 | Invalid | No subscriber |
3002 | Invalid | Adult authentication failure |
3003 | Invalid | Called number format error |
3004 | Invalid | Device service temporarily unavailable |
3005 | Invalid | Device call processing status |
3006 | Invalid | Call denied |
3007 | Invalid | Phone can't receive callback URL |
3008 | Invalid | Other device problems |
3009 | Invalid | Message format error |
3010 | Invalid | Device not supporting MMS |
3011 | Invalid | Server error |
3012 | Invalid | Spam |
3013 | Invalid | Service denied |
3014 | Invalid | Others |
3015 | Invalid | No delivery path |
3016 | Invalid | Attachment size limit failure |
3017 | Invalid | Caller ID protection rules violation |
3018 | Invalid | Individual mobile phone subscriber number subscribed to caller ID protection service |
3019 | Invalid | Caller ID requested to be blocked by KISA (Korea Internet & Security Agency) or MSIT for all clients |
3022 | Invalid | Charset Conversion Error |
3023 | Invalid | Numbers not registered by Caller ID pre-registration |
IB G/W Response Code
Code | Meaning |
---|---|
1001 | Server Busy (RS internal queue full) |
1002 | Called number format error |
1003 | Callback number error |
1004 | SPAM |
1005 | No. of use exceeded |
1006 | No attachment |
1007 | Attachment |
1008 | Attachment saving failure |
1009 | No CLIENT_MSG_KEY |
1010 | No CONTENT |
1011 | No CALLBACK |
1012 | No RECIPIENT_INFO |
1013 | No SUBJECT |
1014 | No attachment KEY |
1015 | No attachment name |
1016 | No attachment size |
1017 | No attachment content |
1018 | No delivery permission |
1019 | TTL exceeded |
1020 | charset conversion error |
S000 | Relay company request failed (server error) |
S001 | Relay company request failed (server error) |
S002 | Relay company request failed (invalid error) |
S003 | Relay company request failed (send to spam) |
S004 | Over quota |
S005 | Invalid MMS file |
S006 | MMS file not found |
S007 | Expired MMS file |
S008 | MMS file size exceeded |
S009 | MMS file resolution exceeded |
S010 | MMS file upload quota exceeded |
S011 | MMS file upload failed |
S012 | Calling number detail error |
S998 | Unexpected server error |
S999 | Other errors |
IB EMMA
Code | Meaning |
---|---|
E900 | No Invalid-IB transfer key |
E901 | No called number |
E902 | For broadcast messages) No order of called numbers |
E903 | No title |
E904 | No message |
E905 | No callback number |
E906 | No message key |
E907 | No broadcast messages status |
E908 | No service type |
E909 | No delivery request time |
E910 | No TTL time |
E911 | No attachment extension when the service type is MMS MT |
E912 | No attachment in the attach_file folder when the service type is MMS MT |
E913 | Attachment size is 0 when the service type is MMS MT |
E914 | There are file group keys in the message table but no data in the file table when the service type is MMS MT |
E915 | Duplicate message |
E916 | Blocked number by auth server |
E917 | Blocked number by customer DB |
E918 | USER CALLBACK FAIL |
E919 | When it is prohibited to re-send the message because there is a delivery time limit. |
E920 | File group keys in the message table when the service type is LMS MT |
E921 | No file group keys in the message table when the service type is MMS MT |
E922 | Error in using restricted characters for broadcast message |
E999 | Other errors |