MENU
      Friend Talk API

        Friend Talk API


        Article summary

        Basic information

        API URL

        https://sens.apigw.ntruss.com/friendtalk/v2
        HTTP

        Go to SENS Friend Talk API Swagger

        API Header

        CategoryMandatoryDescription
        Content-TypeMandatorySpecify the request body content type as application/json (POST)
        x-ncp-apigw-timestampMandatoryThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
        Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
        x-ncp-iam-access-keyMandatoryThis is the access key ID issued by the portal or Sub Account
        x-ncp-apigw-signature-v2MandatorySignature that encrypts the body of the example above with secret key mapped to the access key ID
        Use the HMAC-SHA256 encryption algorithm

        Go to Guide for how to generate NAVER Cloud Platform authentication key and signature


        Message

        Send message

        Sends a message.

        Request URL

        POST https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages
        
        Content-Type: application/json; charset=utf-8
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project

        Headers

        Go to API header

        Request body

        {
            "plusFriendId":"string",
            "messages":[
                {
                    "isAd":"string",
                    "countryCode":"string",
                    "to":"string",
                    "content":"string",
                    "buttons":[
                        {
                            "type":"string",
                            "name":"string",
                            "linkMobile":"string",
                            "linkPc":"string",
                            "schemeIos":"string",
                            "schemeAndroid":"string"
                        }
                    ],
                    "image":{
                        "imageId":"string",
                        "imageLink":"string"
                    },
                    "useSmsFailover": "boolean",
                    "failoverConfig": {
                        "type": "string",
                        "from": "string",
                        "subject": "string",
                        "content": "string"
                    }
                }
            ],
            "reserveTime": "yyyy-MM-dd HH:mm",
            "reserveTimeZone": "string"
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        plusFriendIdMandatoryStringName of Kakao Talk Channel ((formerly) Plus Friend ID)
        messagesMandatoryObjectMessage informationSee items below (messages.XXX).
        Up to 100
        messages.isAdOptionalBooleanAd message statusdefault: true
        If you send an ad message (isAd: true),
        you must comply with the obligation to indicate that an ad message is being sent when SMS failover is in operation
        messages.countryCodeOptionalStringRecipient country codedefault: 82
        messages.toMandatoryStringRecipient number
        messages.contentMandatoryStringFriend Talk message content
        messages.buttonsOptionalArray of ObjectFriend Talk message buttonSee Button information
        messages.buttons.typeMandatoryStringButton typeSee the following template button information.
        messages.buttons.nameMandatoryStringButton nameSee the following template button information.
        messages.imageOptionalObjectImage informationSee Upload image
        messages.image.imageIdMandatoryStringID of uploaded image
        messages.image.imageLinkMandatoryStringImage link
        messages.useSmsFailoverOptionalBooleanSMS failover use statusAvailable only on Kakao Talk Channels where failover is configured
        Default: Follow the failover settings of Kakao Talk Channel
        messages.failoverConfigOptionalObjectFailover settingsSee the items below.
        messages.failoverConfig.typeOptionalStringFailover SMS message typeSMS or LMS
        Default: automatically applied according to the content length (SMS if 90 bytes or less, LMS if it exceeds 90 bytes)
        messages.failoverConfig.fromOptionalStringFailover SMS caller IDDefault: caller ID selected when setting up failover
        Failover does not work when using an unauthorized caller ID.
        messages.failoverConfig.subjectOptionalStringFailover SMS titleUsed when operating in LMS type
        Default: Kakao Talk Channel name
        messages.failoverConfig.contentOptionalStringFailover SMS contentDefault: Friend Talk message content (excluding button)
        reserveTimeOptionalStringReserved date and timeReserved date and time for message delivery (yyyy-MM-dd HH:mm)
        reserveTimeZoneOptionalStringTime zone of reserved date and timeTime zone of reserved date and time (default: Asia/Seoul)
        *List of supported time zones
        * Use the TZ database name value
        • If you use mandatory fields in the request body, no spaces are allowed (only applicable when adding)
        • SMS failover works if the Biz Message reception result code is not successful, and SMS alternative delivery through the failover feature is not performed for codes with the prefix B.
        StatusError textDesc
        0000-Normal delivery
        3022NoSendAvailableTimeExceptionOutside the time available for sending messages (Friend Talk/marketing messages can be sent from 8:00 AM to 8:50 PM KST)
        BxxxSee the Biz Message reception result code belowSee the Biz Message reception result code below
        • When sending an ad message, use the 080 call block service of the SMS service set in SMS failover.
          • SMS failover fails if the 080 call block service is not available for the configured SMS service.
          • If failoverConfig.content is not specified, the ad text is automatically inserted when SMS failover is used.
            [Ad] {Message content}
            Free unsubscribe number 08012345678
            Plain text
          • If you specify failoverConfig.content separately, the ad text won't be inserted. Add it yourself when sending the ad message.
          • If you send SMS messages that do not comply with the obligation to display advertisements, you may be required to provide an explanation later.
        • When sending a wide image, you can send text + link button (1 button) + image.
          • When adding two or more buttons, the message will fail to be sent. (Invalid parameter request)
          • The text is limited to 76 characters.

        Button information

        TypeNameMandatory item
        WLWeb linklinkMobile, linkPc (URL starting with http:// or https://)
        ALApp linkschemeIos, schemeAndroid
        BKBot keyword
        MDSend message
        ACAdd channel

        Response body

        {
            "requestId":"string",
            "requestTime":"string",
            "statusCode":"string",
            "statusName":"string",
            "messages":[
                {
                    "messageId":"string",
                    "countryCode":"string",
                    "to":"string",
                    "content":"string",
                    "requestStatusCode":"string",
                    "requestStatusName":"string",
                    "requestStatusDesc":"string",
                    "useSmsFailover":"boolean"
                }
            ]
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        requestIdMandatoryStringDelivery request ID
        requestTimeMandatoryDateTimeDelivery request timeyyyy-MM-dd'T'HH:mm:ss.SSS
        statusCodeMandatoryStringRequest status code202 - Success
        Others - Failure
        * Follows the HTTP status specification.
        statusNameMandatoryStringRequest status namesuccess - Success
        processing - Being processed
        reserved - Being reserved
        fail - Failure
        messages.messageIdMandatoryStringMessage ID
        messages.countryCodeOptionalStringRecipient country codedefault: 82
        messages.toMandatoryStringRecipient number
        messages.contentMandatoryStringFriend Talk message content
        messages.requestStatusCodeMandatoryStringDelivery request status codeA000 - Success
        Other codes - Failure (reason for failure specified in the Desc category)
        messages.requestStatusNameMandatoryStringDelivery request status namesuccess - Success
        fail - Failure
        messages.requestStatusDescMandatoryStringDelivery request status content
        messages.useSmsFailoverMandatoryBooleanSMS failover use status

        Response status

        HTTP StatusDesc
        202Accepted (delivery request completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Get message delivery request

        Get the message delivery request.

        Request URL

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages?requestId=
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project

        Parameters

        CategoryMandatoryTypeDescriptionNote
        requestIdMandatoryStringRequest IDDelivery request ID
        plusFriendIdMandatoryStringKakao channelName of the registered channel
        requestStartTimeMandatoryStringQuery start timeyyyy-MM-dd'T'HH:mm:ss
        requestEndTimeMandatoryStringQuery end timeyyyy-MM-dd'T'HH:mm:ss
        completeStartTimeMandatoryStringDelivery completion start timeyyyy-MM-dd'T'HH:mm:ss
        completeEndTimeMandatoryStringDelivery completion end timeyyyy-MM-dd'T'HH:mm:ss
        messageIdOptionalStringMessage ID
        requestStatusNameOptionalStringRequest statussuccess, fail
        messageStatusNameOptionalStringRequest statussuccess, processing, fail
        toOptionalStringMessage recipient numberNumber excluding hyphens (-)
        pageIndexOptionalIntegerPage numberdefault: 0
        pageSizeOptionalIntegerPage sizeDefault: 20, Max: 100
        When querying including requestId, Default: 100
        Note
        • You can only see the history of messages sent within the last 30 days.
        • One of the following must be specified: requestId, requestStartTime + requestEndTime, or completeStartTime + completeEndTime.
        • requestStartTime + requestEndTime and completeStartTime + completeEndTime can't be used at the same time.
        • The query range of requestStartTime to requestEndTime is limited to a maximum of 31 days.
        • The query range of completeStartTime to completeEndTime is limited to a maximum of 24 hours.
        • If the query condition does not include a requestId, plusFriendId is required.

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        {
            "requestId": "string",
            "statusCode": "string",
            "statusName": "string",
            "messages": [
                {
                    "requestTime": "string",
                    "messageId": "string",
                    "countryCode": "string",
                    "to": "string",
                    "content": "string",
                    "plusFriendId": "string",
                    "completeTime": "string",
                    "requestStatusCode": "string",
                    "requestStatusName": "string",
                    "requestStatusDesc": "string",
                    "messageStatusCode": "string",
                    "messageStatusName": "string",
                    "messageStatusDesc": "string",
                    "isWide": "boolean",
                    "isAd": "boolean",
                    "useSmsFailover": "boolean",
                    "failover": {
                        "smsServiceId": "string",
                        "requestId": "string",
                        "messageId": "string",
                        "requestStatusCode": "string",
                        "requestStatusName": "string",
                        "requestStatusDesc": "string",
                        "messageStatus": "string",
                        "messageStatusCode": "string",
                        "messageStatusName": "string",
                        "messageStatusDesc": "string"
                    }
                }
            ],
            "pageSize": "integer",
            "pageIndex": "integer",
            "itemCount": "integer",
            "hasMore": "boolean"
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        requestIdOptionalStringDelivery request IDDisplayed only when queried by requestId
        statusCodeMandatoryStringRequest status code202 - Success
        Others - Failure
        * Follows the HTTP status specification.
        statusNameMandatoryStringRequest status namesuccess - Success
        processing - Being delivered
        reserved - Being reserved
        fail - Failure
        messages.requestTimeMandatoryDateTimeDelivery request timeyyyy-MM-dd'T'HH:mm:ss.SSS
        messages.messageIdMandatoryStringMessage ID
        messages.countryCodeOptionalStringRecipient country codedefault: 82
        messages.toMandatoryStringRecipient number
        messages.contentMandatoryStringFriend Talk message content
        messages.plusFriendIdMandatoryStringName of Kakao Talk Channel ((formerly) Plus Friend ID)
        messages.completeTimeOptionalDateTimeDelivery reporting (processing completion) timeyyyy-MM-dd'T'HH:mm:ss
        messages.requestStatusCodeMandatoryStringDelivery request status codeA000 - Success
        Other codes - Failure (reason for failure specified in the Desc category)
        messages.requestStatusNameMandatoryStringDelivery request status namesuccess - Success
        fail - Failure
        messages.requestStatusDescMandatoryStringDelivery request status content
        messages.messageStatusCodeMandatoryStringDelivery result status code0000 - Success
        Other codes - Failure (reason for failure specified in the Desc category)
        messages.messageStatusNameMandatoryStringDelivery result status namesuccess - Success
        processing - Being processed
            * Undergoing processing in the message delivery server after successful sending request
            * messageCode and messageDesc are not searched.
        fail - Failure
        messages.messageStatusDescMandatoryStringDelivery result status content
        messages.isWideMandatoryBooleanWide status
        messages.isAdMandatoryBooleanAd message status
        messages.useSmsFailoverMandatoryBooleanSMS failover use status
        messages.failoverOptionalObjectSMS Failover
        messages.failover.smsServiceIdOptionalStringSMS failover service ID
        messages.failover.requestIdOptionalStringSMS failover delivery request ID
        messages.failover.messageIdOptionalStringSMS failover delivery message ID
        messages.failover.requestStatusCodeOptionalStringSMS failover delivery request status codeSee the Error code table.
        messages.failover.requestStatusNameOptionalStringSMS failover delivery request status namesuccess - Success
        fail - Failure
        messages.failover.requestStatusDescOptionalStringSMS failover delivery request status content
        messages.failover.messageStatusOptionalStringSMS failover delivery request statusREADY: ready
        PROCESSING: being processed
        COMPLETED: processing completed
        messages.failover.messageStatusCodeOptionalStringSMS failover delivery device received status result codeSee the Error code table.
        messages.failover.messageStatusNameOptionalStringSMS failover delivery device received result name
        messages.failover.messageStatusDescOptionalStringSMS failover delivery device received content
        pageSizeMandatoryIntegerPage size
        pageIndexMandatoryIntegerPage index (starts from 0)
        itemCountMandatoryIntegerNumber of messages in the pages retrieved
        hasMoreMandatoryBooleanIt indicates whether there is a next page

        Response status

        HTTP StatusDesc
        200OK (search completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Get message delivery result

        Searches the message delivery result.

        Request URL

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/messages/{messageId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project
        messageIdMandatoryStringMessage IDMessage identifier that is returned when the message is sent

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        {
            "messageId":"string",
            "requestId":"string",
            "requestTime":"string",
            "completeTime":"string",
            "plusFriendId":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "requestStatusCode":"string",
            "requestStatusName":"string",
            "requestStatusDesc":"string",
            "messageStatusCode":"string",
            "messageStatusName":"string",
            "messageStatusDesc":"string",
            "isWide":"boolean",
            "isAd":"boolean",
            "imageId":"string",
            "imageName":"string",
            "imageUrl":"string",
            "imageLink":"string",
            "useSmsFailover":"boolean",
            "failover": {
                "smsServiceId":"string",
                "requestId":"string",
                "requestStatusCode":"string",
                "requestStatusName":"string",
                "requestStatusDesc":"string",
                "messageId":"string",
                "messageStatus":"string",
                "messageStatusCode":"string",
                "messageStatusName":"string",
                "messageStatusDesc":"string"
            }
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        messageIdMandatoryStringMessage ID
        requestIdMandatoryStringDelivery request ID
        requestTimeMandatoryDateTimeDelivery request timeyyyy-MM-dd'T'HH:mm:ss.SSS
        completeTimeOptionalDateTimeDelivery reporting (processing completion) timeyyyy-MM-dd'T'HH:mm:ss
        plusFriendIdMandatoryStringName of Kakao Talk Channel ((formerly) Plus Friend ID)
        templateCodeMandatoryStringTemplate code
        countryCodeOptionalStringRecipient country codedefault: 82
        toMandatoryStringRecipient number
        contentMandatoryStringFriend Talk message content
        requestStatusCodeMandatoryStringDelivery request status codeA000 - Success
        Other codes - Failure (reason for failure specified in the Desc category)
        requestStatusNameMandatoryStringDelivery request status namesuccess - Success
        fail - Failure
        requestStatusDescMandatoryStringDelivery request status content
        messageStatusCodeMandatoryStringDelivery result status code0000 - Success
        Other codes - Failure (reason for failure specified in the Desc category)
        messageStatusNameMandatoryStringDelivery result status namesuccess - Success
        processing - Being processed
            * Undergoing processing in the message delivery server after successful sending request
            * messageCode and messageDesc are not searched.
        fail - Failure
        messageStatusDescMandatoryStringDelivery result status content
        isWideMandatoryBooleanWide status
        isAdMandatoryBooleanAd message status
        imageIdOptionalStringImage ID
        imageNameOptionalStringImage name
        imageUrlOptionalStringImage URL
        imageLinkOptionalStringImage link
        useSmsFailoverMandatoryBooleanSMS failover use status
        failoverOptionalObjectSMS failover use status
        failover.smsServiceIdOptionalStringSMS failover service ID
        failover.requestIdOptionalStringSMS failover delivery request ID
        failover.requestStatusCodeOptionalStringSMS failover delivery request status codeSee the Error code table.
        failover.requestStatusNameOptionalStringSMS failover delivery request status namesuccess - Success
        fail - Failure
        failover.requestStatusDescOptionalStringSMS failover delivery request status content
        failover.messageIdOptionalStringSMS failover delivery message ID
        failover.messageStatusOptionalStringSMS failover delivery request statusREADY: ready
        PROCESSING: being processed
        COMPLETED: processing completed
        failover.messageStatusCodeOptionalStringSMS failover delivery device received status result codeSee the Error code table.
        failover.messageStatusNameOptionalStringSMS failover delivery device received result name
        failover.messageStatusDescOptionalStringSMS failover delivery device received content

        Failover request status code

        requestStatusCodeDesc
        0Succeeded
        E4000The failover settings are not valid
        E4001The failover settings information is omitted
        E4002The failover SMS service is not configured
        E4003The failover SMS type (SMS, LMS) is not configured
        E4004The failover SMS caller ID is not configured.
        E4005The failover SMS title is not configured
        E4006The failover SMS content is not configured
        E4007The failover SMS recipient number is not configured
        E4008The failover SMS service is not available
        E4009The failover SMS caller ID is not authenticated
        E4010The failover SMS free 080 unsubscribing service is not available
        E4999Failover settings parsing error (required to contact Support)
        E5000Internal error (required to contact Support)

        Response status

        HTTP StatusDesc
        200OK (search completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Reserved message

        Get reserved message status

        Get the reservation status of message delivery.

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/reservations/{reserveId}/reserve-status
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project
        reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching the reserved delivery requests (requestId)

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        {
          "reserveId": "string",
          "reserveTimeZone": "string",
          "reserveTime": "string",
          "reserveStatus": "string"
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching the reserved delivery requests (requestId)
        reserveTimeMandatoryStringReserved date and timeReserved date and time for message delivery (yyyy-MM-dd HH:mm)
        reserveTimeZoneMandatoryStringTime zone of reserved date and timeTime zone of reserved date and time (default: Asia/Seoul)
        *List of supported time zones
        * Use the TZ database name value
        reserveStatusMandatoryStringReservation statusREADY - Waiting to be sent
        PROCESSING - Requesting to send
        CANCELED - Delivery canceled
        FAIL - Delivery request failure
        DONE - Successful delivery request
        STALE - Delivery request failure (timeout)

        Response status

        HTTP StatusDesc
        200OK (search completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Cancel reserved message

        Cancel the reserved message delivery.

        DELETE https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/reservations/{reserveId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project
        reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching the reserved delivery requests (requestId)

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        None
        JSON

        Response status

        HTTP StatusDesc
        204No Content (deletion completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Kakao Talk Channel

        Get channel

        Get Kakao Talk Channels.

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/channels
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project

        Parameters

        CategoryMandatoryTypeDescriptionNote
        pageSizeOptionalIntegerPage sizedefault: 100 (Only numbers between 1 and 100 can be entered.)
        pageIndexOptionalIntegerPage indexdefault: 0

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        [
            {
                "createTime": "string",
                "updateTime": "string",
                "serviceId": "string",
                "channelId": "string",
                "channelName": "string",
                "channelStatus": "string",
                "useSmsFailover": "boolean"
            }
        ]
        JSON
        CategoryMandatoryTypeDescriptionNote
        createTimeMandatoryStringCreation timeformat: LocalDateTime
        updateTimeOptionalStringEdited timeformat: LocalDateTime
        serviceIdMandatoryStringService IDService ID issued when registering the project
        channelIdMandatoryStringKakao Talk Channel ID
        channelNameMandatoryStringKakao Talk Channel name
        channelStatusMandatoryStringKakao Talk Channel status- Normal: ACTIVE
        - Deleted: DELETED
        - Being deleted permanently: DELETING_PERMANENTLY
        - Deleted permanently: PERMANENTLY_DELETED
        - Blocked: BLOCKED
        - Deletion pending: PENDING_DELETE
        useSmsFailoverMandatoryBooleanUse status of alternative SMS delivery

        Response status

        HTTP StatusDesc
        200OK
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        429Too Many Requests
        500Internal Server Error

        Image

        Upload image

        This uploads the image to be used for sending Friend Talk.
        Images are stored for one year, after which they are automatically deleted and cannot be used.

        Request URL

        POST https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images
        
        Content-Type: multipart/form-data; boundary=a29b1180-70f5-42f7-afbe-0d68a15f2370
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project

        Headers

        Go to API header

        Request parameter

        CategoryMandatoryTypeDescriptionNote
        plusFriendIdMandatoryStringName of Kakao Talk Channel ((formerly) Plus Friend ID)
        imageFileMandatoryFileImage files- Common
        * JPG and PNG only
        * 500 KB or less
        - General
        * Recommended size: 720 px x 720 px
        * Upload only images that are at least 500 px wide and have an aspect ratio of 2:1 or greater and less than 3:4
        - Wide
        * Size limit: 800 px x 600 px
        * Upload only images that are 4:3 aspect ratio
        isWideOptionalBooleanWide image statusWhen uploading a wide image, it is sent as a wide Friend Talk message
        *default: false

        Response body

        {
            "imageId":"string",
            "imageName":"string",
            "imageUrl":"string",
            "isWide":"boolean",
            "createTime":"string"
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        imageIdMandatoryStrngImage ID
        imageNameMandatoryStringImage file name
        imageUrlMandatoryStringImage URL
        isWideMandatoryBooleanWide status
        createTimeMandatoryDateTimeImage uploading time

        Response status

        HTTP StatusDesc
        200OK (Successfully uploaded)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Get image list

        Get the list of uploaded images.

        Request URL

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project

        Headers

        Go to API header

        Parameters

        CategoryMandatoryTypeDescriptionNote
        pageIndexOptionalIntegerPage indexdefault: 0
        pageSizeOptionalIntegerPage sizedefault: 20 (Only numbers between 1 and 100 can be entered.)

        Request body

        None
        JSON

        Response body

        {
          "items": [
            {
              "imageId": "string",
              "imageName": "string",
              "imageUrl": "string",
              "isWide": "boolean",
              "createTime": "string"
            }
          ],
          "pageIndex": "integer",
          "pageSize": "integer",
          "itemCount": "integer",
          "totalCount": "integer"
        }
        JSON
        CategoryMandatoryTypeDescriptionNote
        itemsMandatoryArray of ObjectImage data listSee image data
        pageIndexMandatoryIntegerPage index
        pageSizeMandatoryIntegerPage size
        itemCountMandatoryIntegerNumber of items retrieved
        totalCountMandatoryIntegerTotal count

        Response status

        HTTP StatusDesc
        200OK (Successfully searched)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Get single image

        Get a single uploaded image.

        Request URL

        GET https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images/{imageId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project
        imageIdMandatoryStringImage IDID of uploaded image

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        {
            "imageId":"string",
            "imageName":"string",
            "imageUrl":"string",
            "isWide":"boolean",
            "createTime":"string"
        }
        JSON

        Image data

        CategoryMandatoryTypeDescriptionNote
        imageIdMandatoryStrngImage ID
        imageNameMandatoryStringImage file name
        imageUrlMandatoryStringImage URL
        isWideMandatoryBooleanWide status
        createTimeMandatoryDateTimeImage uploading time

        Response status

        HTTP StatusDesc
        200OK (Successfully searched)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Delete images

        This deletes uploaded images.

        Request URL

        DELETE https://sens.apigw.ntruss.com/friendtalk/v2/services/{serviceId}/images/{imageId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        CategoryMandatoryTypeDescriptionNote
        serviceIdMandatoryStringService IDService ID issued when registering the project
        imageIdMandatoryStringImage IDID of uploaded image

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        None
        JSON

        Response status

        HTTP StatusDesc
        204No Content (deletion completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Errors

        Biz Message reception result code

        StatusError textDesc
        0000-Normal delivery
        1001NoJsonBodyRequest body is not in JSON format.
        1002InvalidHubPartnerKeyInvalid partner key
        1003InvalidSenderKeyInvalid outgoing profile key
        1004NoValueJsonElementName not found in request body (JSON)
        1005SenderNotFoundOutgoing profile not found
        1006DeletedSenderDeleted outgoing profile
        1007StoppedSenderBlocked outgoing profile
        1011ContractNotFoundContract information not found
        1012InvalidUserKeyExceptionInvalid format of user key request
        1013InvalidAppLinkInvalid app connection
        1014InvalidBizNumInvalid business registration number
        1015TalkUserIdNotFonudInvalid app user id request
        1016BizNumNotEqualMismatched business registration number
        1020InvalidReceiveUserExceptionNo valid user identifier value
        1021BlockedProfileBlocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
        1022DeactivatedProfileClosed Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
        1023DeletedProfileDeleted Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
        1024DeletingProfileDeletion-pending Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
        1025SpammedProfileMessage-blocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
        1026UnableUseMessageTypeThe request was made with response_method unavailable for the msg_type (image Alim Talk (AI) can't be sent in real time)
        1027-Message delivery failure due to channel message restriction status
        1030InvalidParameterExceptionInvalid parameter request
        1033-Template type and message type mismatch
        2000FailedToCheckFriendshipExceptionError when checking the friend relationship with the Talk Channel (system error)
        2003FailedToSendMessageByNoFriendshipExceptionMessage delivery failure (if Kakao Talk Channel is not added in the test server)
        2004FailedToMatchTemplateExceptionError when checking template match (internal Kakao error)
        2005FailedToReadImageExceptionError reading image meta information from Kakao
        2006FailedToMatchSerialNumberPrefixPatternSerial number format mismatch
        3000UnexceptedExcetpionOccurrence of an unexpected error
        3005AckTimeoutExceptionA message was sent, but the read receipt was not confirmed (success uncertain)
        3006FailedToSendMessageExceptionMessage delivery failed due to Kakao's internal system error.
        3008InvalidPhoneNumberExceptionPhone number error
        3010JsonParsseExcetpionJSON parsing error
        3011MessageNotFoundExceptionMessage does not exist.
        3012SerialNumberDuplicatedExceptionMessage serial number is duplicated. (A unique value must be assigned for the message serial number.)
        3013MessageEmptyExceptionBlank message
        3014MessageLengthOverLimitExceptionMessage length limit error (exceeding 1000 characters for text type, 400 characters for image type)
        3015TemplateNotFoundExceptionTemplate not found
        3016NoMatchedTemplateExceptionMessage content does not match the template.
        3018NoSendAvailableExceptionMessage could not be sent.
        3019MessageNoUserExceptionNot a Talk user
        3020MessageUserBlockedAlimTalkExceptionAlim Talk blocked
        3021MessageNotSupportedKakaotalkExceptionMinimum support version for Talk not met
        3022NoSendAvailableTimeExceptionOutside the time available for sending messages (Friend Talk/marketing messages can be sent from 08:00 to 20:00.)
        3023MessageInvalidVideoExceptionUnable to send the video embedded in the message (the video address or thumbnail image address is incorrect or the thumbnail image does not meet the specifications)
        3024MessageInvaildImageExceptionThe image contained in the message can't be sent.
        3025ExceedMaxVariableLengthExceptionVariable character limit exceeded
        3026Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})'Inquiry/bot switching button extra, event character limit exceeded
        3027NoMatchedTemplateButtonExceptionButton content does not match the template.
        3028NoMatchedTemplateTitleExceptionMessage highlighting title does not match the template.
        3029ExceedMaxTitleLengthExceptionMessage highlighting title length limit exceeded (50 characters)
        3031-Text type mismatch
        3030NoMatchedTemplateWithMessageTypeExceptionMessage type does not match the template highlight type.
        3031NoMatchedTemplateHeaderExceptionHeader does not match the template.
        3032ExceedMaxHeaderLengthExceptionHeader length limit exceeded (16 characters)
        3033NoMatchedTemplateItemHighlightExceptionItem highlight does not match the template.
        3034ExceedMaxItemHighlightTitleLengthExceptionItem highlight title length limit exceeded (30 characters with no images, 21 characters with images)
        3035ExceedMaxItemHighlightDescriptionLengthExceptionItem highlight description length limit exceeded (19 characters with no images, 14 characters with images)
        3036NoMatchedTemplateItemListExceptionItem list does not match the template.
        3037ExceedMaxItemDescriptionLengthExceptionItem's description length limit exceeded in the item list (23 characters)
        3038NoMatchedTemplateItemSummaryExceptionItem summary information does not match the template
        3039ExceedMaxItemSummaryDescriptionLengthExceptionItem summary information's description length limit exceeded (14 characters)
        3040InvalidItemSummaryDescriptionExceptionItem summary information's description includes characters that are not allowed (inclusion of characters other than currency symbol/code, number, comma, period, and space)
        3041MessageInvalidWideItemListLengthExceptionWide item list count minimum, maximum mismatch
        3042NoMatchedTemplateRepresentLinkExceptionRepresentative link does not match template
        3046ExceedMaxAdditionalContentLengthExceptionAdditional information maximum length limit error
        3047ExceedMaxCommerceTitleLengthExceptionCommerce information, product name maximum length limit error
        3050MessageNotSupportedUnsubscribeExceptionOpt-out specifications (N type) not supported
        3051InvalidateCarouselItemMinException or InvalidateCarouselItemMaxExceptionCarousel item list count minimum, maximum mismatch
        3052CarouselMessageLengthOverLimitExceptionCarousel item message length exceeded
        3056WideItemListTitleLengthOverLimitExceptionWide item list title length limit error
        3058CarouselHeaderLengthOverLimitExceptionCarousel header length limit error
        3059MessageNotSupportedCouponExceptionCoupon specifications not supported
        4000ResponseHistoryNotFoundExceptionMessage delivery result not found
        4001UnKnownMessageStatusErrorUnknown message status
        7011-Serial number pattern error
        7014-Message validity timeout error
        8512-Recipient type not found
        8514-request_id not found
        8520-Unsupported product type error
        8521-Message type not supported error
        8522-Test type not supported error
        8523-Response method not supported error
        8530-Recipient list size error
        8999-Internal server error
        9998The service is not currently provided.The admin is checking a problem that occurred in the system
        9999The admin is checking an unknown problem that occurred in the systemThe admin is checking a problem that occurred in the system
        B000Prepare to relay failedFailure of preliminary work for forwarding to the relay company
        B001Request to relay failedRelay company delivery failure
        B002Filtering for request to relay failedFiltered due to invalid request
        B003Invalid phone number formatInvalid caller ID format
        B004Quota ExceedQuota exceeded
        B005Message processing timeout exceedThe difference between the message request time and processing time is outside the allowable range
        B400Invalid RequestMessage format error
        B999Unexpected server errorUnexpected error

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.