- HOME
- API overview
- API overview
- Calling and authenticating API
- API data types
- VPC
- Platform
- Account
- AppliedCreditHistory
- AppliedProductDiscountHistory
- Coin
- CoinHistory
- CoinHistoryList
- CoinUseHistory
- Contract
- ContractList
- ContractDemandCost
- ContractDemandCostList
- ContractProduct
- ContractSummary
- ContractSummaryList
- ContractUsageList
- ContractUsageByDaily
- ContractUsageListByDaily
- CostRelationCode
- CostRelationCodeList
- CountryPeriodUnit
- CountryUnit
- Credit
- CreditHistory
- CreditHistoryList
- CreditUseHistory
- DemandCost
- DemandCostList
- Discount
- DiscountList
- PackageUnit
- PeriodUnit
- Price
- PriceList
- Product(For Billing)
- ProductList(For Billing)
- ProductCategoryList
- ProductDemandCost
- ProductDemandCostList
- ProductDemandCostByDiscount
- ProductDemandCostByDiscountList
- ProductDemandType
- ProductDiscount
- ProductDiscountHistory
- ProductDiscountHistoryList
- ProductDiscountUseHistory
- ProductPrice
- ProductPriceList
- Region(For Billing)
- RegionList(For Billing)
- SectionPrice
- SectionPriceList
- ShareCoinSnapshot
- Usage
- UseDate
- Compute
- AccessControlGroup
- AccessControlGroupList
- AccessControlGroupNoList
- AccessControlGroupRule
- AccessControlGroupRuleList
- ActivityLog
- ActivityLogList
- AdjustmentType
- AdjustmentTypeList
- AutoScalingGroup
- AutoScalingGroupList
- BlockDevicePartition
- BlockStorageInstance
- BlockStorageInstanceList
- BlockStorageMapping
- BlockStorageSnapshotInstance
- BlockStorageSnapshotInstanceList
- BlockStorageVolumeType
- BlockStorageVolumeTypeList
- CommonCode
- CommonResponse
- FlowLogConfiguration
- FlowLogConfigurationList
- HypervisorTypeList
- InAutoScalingGroupServerInstance
- InitScript
- InitScriptList
- KeyName
- LaunchConfiguration
- LaunchConfigurationList
- LoginKey
- LoginKeyList
- MemberServerImage
- MemberServerImageInstance
- MemberServerImageInstanceList
- NetworkInterface
- NetworkInterfaceList
- NetworkInterfaceNoList
- PlacementGroup
- PlacementGroupList
- PrivateKey
- Process
- ProcessList
- Product
- ProductList
- ProtocolType
- PublicIpInstance
- PublicIpInstanceList
- Raid
- RaidList
- Region
- RegionList
- RootPassword
- RootPasswordServerInstance
- RootPasswordServerInstanceList
- ScalingPolicy
- ScalingPolicyList
- ScheduledUpdateGroupAction
- ScheduledUpdateGroupActionList
- SecondaryIpList
- ServerImage
- ServerImageList
- ServerInstance
- ServerInstanceList
- ServerInstanceNoList
- ServerSpec
- ServerSpecList
- SharedLoginIdList
- SuspendedProcess
- Zone
- ZoneList
- Storage
- Networking
- HostHeaderCondition
- HostHeaderList
- HostHeaderList
- IpList
- LoadBalancerInstance
- LoadBalancerInstanceList
- LoadBalancerIpList
- LoadBalancerListener
- loadBalancerListenerCertificate
- LoadBalancerListenerNoList
- LoadBalancerRule
- loadBalancerListenerCertificateList
- LoadBalancerListenerList
- LoadBalancerRuleAction
- LoadBalancerRuleNoList
- LoadBalancerSubnet
- LoadBalancerRuleCondition
- LoadBalancerRuleList
- NatGatewayInstance
- NatGatewayInstanceList
- NetworkAcl
- NetworkAclDenyAllowGroup
- NetworkAclRule
- NetworkAclDenyAllowGroupList
- NetworkAclList
- NetworkAclRuleList
- PathPatternCondition
- PathPatternList
- PolicyDetailResponse
- PolicyListResponse
- PolicyRequest
- ProfileDetailResponse
- ProfileListResponse
- ProfileRequest
- RedirectionAction
- Route
- RouteList
- RouteTable
- RouteTableList
- Subnet
- SubnetList
- SubnetNoList
- Target
- TargetGroup
- TargetNoList
- TargetSubnet
- TargetGroupAction
- TargetGroupNoList
- TargetGroupWeight
- TargetGroupList
- TargetList
- TargetSubnetList
- TargetVpc
- TargetVpcList
- Vpc
- VpcList
- VpcPeeringInstance
- VpcPeeringInstanceList
- CipherSuiteList
- Database
- CloudDbProduct
- CloudDbProductList
- Cloud DB for MySQL
- CloudMysqlBackup
- CloudMysqlBackupList
- CloudMysqlBackupDetail
- CloudMysqlBackupDetailList
- CloudMysqlConfigList
- CloudMysqlDatabase
- CloudMysqlDatabaseList
- CloudMysqlDbServerLog
- CloudMysqlDbServerLogList
- CloudMysqlEventHistory
- CloudMysqlEventHistoryList
- CloudMysqlInstance
- CloudMysqlInstanceList
- CloudMysqlInstanceForHiveMetaStore
- CloudMysqlInstanceListForHiveMetaStore
- CloudMysqlRecoveryTime
- CloudMysqlServerInstance
- CloudMysqlUser
- CloudMysqlUserList
- CloudMysqlUserForHiveMetaStore
- CloudMysqlUserListForHiveMetaStore
- Cloud DB for Redis
- CloudRedisBackup
- CloudRedisBackupList
- CloudRedisBackupDetail
- CloudRedisBackupDetailList
- CloudRedisBucket
- CloudRedisBucketList
- CloudRedisConfigGroup
- CloudRedisConfigGroupList
- CloudRedisConfigGroupVersion
- CloudRedisConfigGroupVersionList
- CloudRedisInstance
- CloudRedisInstanceList
- CloudRedisServerInstance
- Cloud DB for MSSQL
- CloudMssqlBackup
- CloudMssqlBackupList
- CloudMssqlBackupDetail
- CloudMssqlBackupDetailList
- CloudMssqlBucket
- CloudMssqlBucketList
- CloudMssqlCharacterSet
- CloudMssqlCharcterSetList
- CloudMssqlConfigGroup
- CloudMssqlConfigGroupList
- CloudMssqlFolder
- CloudMssqlFolderList
- CloudMssqlInstance
- CloudMssqlInstanceList
- CloudMssqlLogBackupFile
- CloudMssqlLogBackupFileList
- CloudMssqlLogFile
- CloudMssqlLogFileList
- CloudMssqlServerInstance
- Cloud DB for MongoDB
- Cloud DB for PostgreSQL
- CloudPostgresqlBackup
- CloudPostgresqlBackupList
- CloudPostgresqlBackupDetail
- CloudPostgresqlBackupDetailList
- CloudPostgresqlBucket
- CloudPostgresqlBucketList
- CloudPostgresqlConfigList
- CloudPostgresqlDatabase
- CloudPostgresqlDatabaseList
- CloudPostgresqlDbServerLog
- CloudPostgresqlDbServerLogList
- CloudPostgresqlInstance
- CloudPostgresqlInstanceList
- CloudPostgresqlServerInstance
- CloudPostgresqlUser
- CloudPostgresqlUserList
- AI·NAVER API
- Application Services
- GeoLocation
- Cloud Outbound Mailer
- AddressBookRequest
- AddressBookResponse
- AttachFile
- Category
- CountByStatus
- EmailRecipientType
- EmailReservationStatus
- EmailStatus
- HistoryActionType
- MailListResponse
- NesDateTime
- Recipient
- RecipientForRequest
- RecipientGroupFilter
- RequesterType
- RequestListResponse
- SendBlockHistoryResponse
- Sort
- TemplateBackupStatus
- TemplateExportRequestResponse
- TemplateStructureResponse
- UnsubscribersListResponse
- GeolocationList
- Big Data & Analytics
- Cloud Hadoop (VPC)
- CloudHadoopAddOn
- CloudHadoopAddOnList
- CloudHadoopBucket
- CloudHadoopBucketList
- CloudHadoopClusterType
- CloudHadoopClusterTypeList
- CloudHadoopInstance
- CloudHadoopInstanceList
- CloudHadoopLoginKey
- CloudHadoopLoginKeyList
- CloudHadoopNotebookBucket
- CloudHadoopNotebookBucketList
- CloudHadoopNotebookComponent
- CloudHadoopNotebookComponentList
- CloudHadoopNotebookInstance
- CloudHadoopNotebookInstanceList
- CloudHadoopNotebookServerInstance
- CloudHadoopNotebookVersion
- CloudHadoopObject
- CloudHadoopObjectList
- CloudHadoopServerInstance
- CloudHadoopVersion
- Data Forest
- AccountResponse
- AiAppContainer
- AiAppData
- AiAppDocker
- AiAppResource
- AiAppResponse
- AiAppTypeSpec
- AiWorkspaceConfig
- AiWorkspaceResponse
- AppComponentRequest
- AppComponentResponse
- AppContainerResponse
- AppResponse
- CreateAppRequest
- DependableApp
- GetAccountDetailResponse
- GetAccountListResponse
- GetAiAppDetailResponse
- GetAiAppListResponse
- GetAiWorkspaceConfigurationListResponse
- GetAiWorkspaceDetailResponse
- GetAiWorkspaceListResponse
- GetAppBasicSettingResponse
- GetAppDetailResponse
- GetAppListResponse
- QuotaResponse
- SubmitAiAppResponse
- Cloud Hadoop (VPC)
- Platform
- Classic
- Platform
- Account
- AppliedCreditHistory
- AppliedProductDiscountHistory
- Coin
- CoinHistory
- CoinHistoryList
- CoinUseHistory
- Contract
- ContractList
- ContractDemandCost
- ContractDemandCostList
- ContractProduct
- ContractSummary
- ContractSummaryList
- ContractUsageList
- ContractUsageByDaily
- ContractUsageListByDaily
- CostRelationCode
- CostRelationCodeList
- CountryPeriodUnit
- CountryUnit
- Credit
- CreditHistory
- CreditHistoryList
- CreditUseHistory
- DemandCost
- DemandCostList
- Discount
- DiscountList
- PackageUnit
- PeriodUnit
- Price
- PriceList
- Product (For Billing)
- ProductList (For Billing)
- ProductCategoryList
- ProductDemandCost
- ProductDemandCostList
- ProductDemandCostByDiscount
- ProductDemandCostByDiscountList
- ProductDemandType
- ProductDiscount
- ProductDiscountHistory
- ProductDiscountHistoryList
- ProductDiscountUseHistory
- ProductPrice
- ProductPriceList
- Region(For Billing)
- RegionList(For Billing)
- SectionPrice
- SectionPriceList
- ShareCoinSnapshot
- Usage
- UseDate
- Compute
- AccessControlGroup
- AccessControlGroupList
- AccessControlRule
- AccessControlRuleList
- ActivityLog
- ActivityLogList
- AsgPolicy
- AutoScalingGroup
- AutoScalingGroupList
- BlockDevicePartition
- BlockStorageInstance
- BlockStorageInstanceList
- BlockStorageSnapshotInstance
- BlockStorageSnapshotInstanceList
- CollectingInfo
- CollectingInfoList
- CommonCode
- CommonResponse
- ConfigurationLog
- ConfigurationLogList
- InAutoScalingGroupServerInstance
- InitScript
- InitScriptList
- InstanceTag
- InstanceTagList
- LaunchConfiguration
- LaunchConfigurationList
- LoginKey
- LoginKeyList
- MemberServerImage
- MemberServerImageList
- PortForwardingConfiguration
- PortForwardingConfigurationList
- PortForwardingRule
- PortForwardingRuleList
- PrivateKey
- Process
- ProcessList
- Product
- ProductList
- PublicIpInstance
- PublicIpInstanceList
- Raid
- RaidList
- Region
- RegionList
- RootPassword
- RootPasswordServerInstance
- RootPasswordServerInstanceList
- ScalingPolicy
- ScalingPolicyList
- ScheduledUpdateGroupAction
- ScheduledUpdateGroupActionList
- ServerInstance
- ServerInstanceList
- ServerInstanceNoList
- SharedLoginIdList
- SuspendedProcess
- Zone
- ZoneList
- Storage
- Networking
- DomainCreateRequest
- DomainDetailResponse
- DomainListResponse
- DomainQueryResponse
- DomainResponse
- DomainUsage
- LbRecordResponse
- LoadBalancedServerInstance
- LoadBalancerInstance
- LoadBalancerInstanceList
- LoadBalancerInstanceSummary
- LoadBalancerRule
- RecordCreateRequest
- RecordResponse
- RecordUpdateRequest
- ServerHealthCheckStatus
- SslCertificate
- SslCertificateList
- Application Services
- GeoLocation
- Cloud Outbound Mailer
- AddressBookRequest
- AddressBookResponse
- AttachFile
- Category
- CountByStatus
- EmailRecipientType
- EmailReservationStatus
- EmailStatus
- HistoryActionType
- MailListResponse
- NesDateTime
- Recipient
- RecipientForRequest
- RecipientGroupFilter
- RequesterType
- RequestListResponse
- SendBlockHistoryResponse
- Sort
- TemplateBackupStatus
- TemplateExportRequestResponse
- TemplateStructureResponse
- UnsubscribersListResponse
- Big Data & Analytics
- AggregatedResult
- AggregateSchema
- AutocompleteSearchQuery
- AutocompleteSearchSchema
- BuildInfo
- Container
- DocProperty
- GroupBySchema
- Index
- IndexProcessor
- QueryAnalysisField
- Schema
- SearchAggregate
- SearchHighlighting
- SearchPassage
- SearchQuery
- SearchResultProcessing
- SearchScope
- SearchSetting
- Section
- UserDbUpload
- Management & Governance
- ChartDataWidgetDto
- CreateOrUpdateMetricsGrpDto
- CreateOrUpdateRuleGroupDto
- DataQueryRequest
- DataQueryRequestMetricInfo
- DeleteRuleGroupItemDto
- DimensionDto
- DimensionsSelected
- DirectRuleGroupCreateDto
- EventSearchRequest
- EventSearchRequestById
- FieldDto
- MetricListRequest
- MetricsGroupItem
- MonitorGroupItem
- MonitorGrpDto
- PersonalRecipientNotification
- PMCreateUpdateDto
- RecipientNotification
- RuleGroupItemDto
- SuspendRuleItemDto
- TypeGroupRelatedRuleDto
- WidgetMetricInfoDto
- Platform
- VPC
- Platform
- Compute
- Server (VPC)
- Server (VPC) overview
- Server
- Login Key
- Placement Group
- getServerInstanceList
- getServerInstanceDetail
- createServerInstances
- startServerInstances
- stopServerInstances
- rebootServerInstances
- terminateServerInstances
- changeServerInstanceSpec
- getRootPassword
- getRootPasswordServerInstanceList
- setProtectServerTermination
- interruptServerInstance
- Server Image
- removeServerImageSharingPermission
- addServerImageSharingPermission
- getServerImageList
- getServerImageDetail
- createServerImageFromSnapshot
- createServerImage
- deleteServerImage
- getMemberServerImageInstanceList
- getMemberServerImageInstanceDetail
- createMemberServerImageInstance
- deleteMemberServerImageInstances
- setMemberServerImageSharingPermission
- addMemberServerImageSharingPermission
- removeMemberServerImageSharingPermission
- Storage
- Snapshot
- Public IP
- Init Script
- Network Interface
- getNetworkInterfaceList
- unassignSecondaryIps
- assignSecondaryIps
- getNetworkInterfaceDetail
- createNetworkInterface
- deleteNetworkInterface
- attachNetworkInterface
- detachNetworkInterface
- addNetworkInterfaceAccessControlGroup
- removeNetworkInterfaceAccessControlGroup
- enableFlowLog
- disableFlowLog
- getFlowLogConfigurationList
- ACG
- Common
- Server (VPC) metrics
- Server
- Server Overview
- getServerProductList
- getServerImageProductList
- getRaidList
- getZoneList
- getRegionList
- getInitScriptList
- getLoginKeyList
- createLoginKey
- deleteLoginKey
- importLoginKey
- getAccessControlGroupList
- getAccessControlGroupServerInstanceList
- getAccessControlRuleList
- getServerInstanceList
- createServerInstances
- recreateServerInstance
- terminateServerInstances
- changeServerInstanceSpec
- rebootServerInstances
- startServerInstances
- stopServerInstances
- getRootPassword
- getRootPasswordServerInstanceList
- getMemberServerImageList
- createMemberServerImage
- deleteMemberServerImages
- getBlockStorageInstanceList
- createBlockStorageInstance
- deleteBlockStorageInstances
- changeBlockStorageVolumeSize
- attachBlockStorageInstance
- detachBlockStorageInstances
- createBlockStorageSnapshotInstance
- deleteBlockStorageSnapshotInstances
- getBlockStorageSnapshotInstanceList
- getPublicIpTargetServerInstanceList
- createPublicIpInstance
- associatePublicIpWithServerInstance
- disassociatePublicIpFromServerInstance
- deletePublicIpInstances
- getPortForwardingRuleList
- getPublicIpInstanceList
- deletePortForwardingRules
- createInstanceTags
- deleteInstanceTags
- getInstanceTagList
- addPortForwardingRules
- getPortForwardingConfigurationList
- setMemberServerImageSharingPermission
- addMemberServerImageSharingPermission
- removeMemberServerImageSharingPermission
- setProtectServerTermination
- interruptServerInstance
- Server metrics
- Auto Scaling (VPC)
- Auto Scaling Overview
- Launch Configuration
- Auto Scaling Group
- getAutoScalingGroupList
- getAutoScalingGroupDetail
- createAutoScalingGroup
- updateAutoScalingGroup
- deleteAutoScalingGroup
- setDesiredCapacity
- getScheduledActionList
- putScheduledUpdateGroupAction
- deleteScheduledUpdateGroupAction
- getScalingProcessTypeList
- suspendProcesses
- resumeProcesses
- getAutoScalingActivityLogList
- getAutoScalingPolicyList
- getAdjustmentTypeList
- putScalingPolicy
- deleteScalingPolicy
- executePolicy
- Auto Scaling (VPC) metrics
- Auto Scaling
- Auto Scaling Overview
- setServerInstanceHealth
- putScheduledUpdateGroupAction
- updateAutoScalingGroup
- resumeProcesses
- executePolicy
- deletePolicy
- deleteScheduledAction
- getLaunchConfigurationList
- terminateServerInstanceInAutoScalingGroup
- getAutoScalingGroupList
- deleteAutoScalingLaunchConfiguration
- getScheduledActionList
- putScalingPolicy
- getAutoScalingActivityLogList
- createLaunchConfiguration
- getScalingProcessTypeList
- suspendProcesses
- getAutoScalingConfigurationLogList
- getAdjustmentTypeList
- createAutoScalingGroup
- getAutoScalingPolicyList
- deleteAutoScalingGroup
- setDesiredCapacity
- Auto Scaling metrics
- Cloud Functions
- Cloud Functions overview
- v2.1
- Get package list
- Get package
- Put Package
- Delete package
- Get action list
- Get action
- Put Action
- Post action
- Delete action
- Get action's activation list
- Get action's activation detail
- Get Trigger List
- Get trigger
- Put Trigger
- Post trigger
- Delete trigger
- Post Trigger Link Action
- Delete Trigger Link Action
- Get trigger's activation list
- Get trigger's activation detail
- Get activation list
- v2.0
- Get package list
- Get package
- Put package
- Delete package
- Get action list
- Get action
- Put Action
- Post action
- Delete action
- Get action's activation list
- Get action's activation detail
- Get trigger list
- Get trigger
- Put Trigger
- Post trigger
- Delete trigger
- Post trigger link action
- Delete trigger link action
- Get trigger's activation list
- Get trigger's activation detail
- Get activation list
- Metadata (VPC)
- Server (VPC)
- Containers
- Container Registry
- Ncloud Kubernetes Service (VPC)
- Ncloud Kubernetes Service overview
- Get cluster list
- Get cluster
- Create cluster
- Upgrade cluster version
- Set cluster audit log
- Add cluster subnet
- Set cluster OIDC
- View cluster OIDC
- Set cluster IP ACL
- View cluster IP ACL
- Edit cluster LB subnet
- Set cluster termination protection
- Set cluster secret encryption
- Set cluster authentication mode
- Get cluster IAM access list
- Get cluster IAM access
- Create cluster IAM access
- Edit cluster IAM access
- Delete cluster IAM access
- Delete cluster
- View WorkerNode
- Delete WorkerNode
- View NodePool
- Create NodePool
- Edit NodePool
- Edit NodePool subnet
- Edit NodePool label
- Edit NodePool taint
- Upgrade NodePool
- Delete NodePool
- View kubeconfig
- Reset kubeconfig
- View supported K8s versions
- View server image
- View server specifications
- Ncloud Kubernetes Service (VPC) metrics
- Storage
- Object Storage
- Object Storage overview
- ListBuckets
- PutBucket
- ListObjects
- ListObjectsV2
- HeadBucket
- DeleteBucket
- PutBucketACL
- GetBucketACL
- PutBucketCORS
- GetBucketCORS
- DeleteBucketCORS
- ListMultipartUploads
- PutObject
- PutObject (Copy)
- GetObject
- HeadObject
- DeleteObject
- DeleteMultipleObjects
- PutObjectACL
- GetObjectACL
- OptionsObjectCORS
- InitiateMultipartUpload
- UploadPart
- ListParts
- CompleteMultipartUpload
- AbortMultipartUpload
- Object Storage metrics
- Archive Storage
- NAS (VPC)
- NAS
- Object Storage
- Networking
- VPC
- VPC Overview
- VPC Management
- Subnet Management
- Network ACL
- getNetworkAclList
- getNetworkAclDetail
- createNetworkAcl
- deleteNetworkAcl
- setSubnetNetworkAcl
- getNetworkAclRuleList
- addNetworkAclInboundRule
- addNetworkAclOutboundRule
- removeNetworkAclInboundRule
- removeNetworkAclOutboundRule
- setNetworkAclDescription
- getNetworkAclDenyAllowGroupList
- getNetworkAclDenyAllowGroupDetail
- createNetworkAclDenyAllowGroup
- deleteNetworkAclDenyAllowGroup
- setNetworkAclDenyAllowGroupIpList
- setNetworkAclDenyAllowGroupDescription
- NAT Gateway
- VPC Peering
- Route Table
- Load Balancer (VPC)
- Load Balancer Overview
- Load Balancer
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- setLoadBalancerDescription
- setLoadBalancerInstanceSubnet
- deleteLoadBalancerInstances
- getLoadBalancerInstanceDetail
- getLoadBalancerInstanceList
- createLoadBalancerListener
- changeLoadBalancerListenerConfiguration
- deleteLoadBalancerListeners
- getLoadBalancerListenerList
- getLoadBalancerRuleList
- addLoadBalancerListenerCertificate
- removeLoadBalancerListenerCertificate
- getLoadBalancerListenerCertificateList
- Target Group
- Load Balancer metrics
- Load Balancer
- Load Balancer Overview
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- changeLoadBalancedServerInstances
- deleteLoadBalancerInstances
- getLoadBalancerInstanceList
- getLoadBalancedServerInstanceList
- getLoadBalancerTargetServerInstanceList
- addLoadBalancerSslCertificate
- deleteLoadBalancerSslCertificate
- getLoadBalancerSslCertificateList
- Load Balancer metrics
- Global DNS
- Global Traffic Manager
- Profile
- Policy
- Policy overview
- Create traffic policy
- Edit traffic policy
- Delete traffic policy
- View traffic policy
- View traffic policy details
- View traffic policy resource details
- Edit traffic policy resource
- Edit specific resource of traffic policy
- Edit traffic policy health check
- Delete traffic policy health check
- View traffic policy resource type
- View traffic policy health check region
- View traffic policy Load Balancer type
- Geo / CIDR Map
- Monitoring
- VPC
- Database
- Cloud DB
- CloudDB Overview
- createCloudDBInstance
- deleteCloudDBServerInstance
- getCloudDBInstanceList
- getCloudDBConfigGroupList
- getCloudDBImageProductList
- getCloudDBProductList
- rebootCloudDBServerInstance
- flushCloudDBInstance
- setObjectStorageInfo
- downloadDmsFile
- uploadDmsFile
- getObjectStorageBackupList
- getBackupList
- restoreDmsDatabase
- restoreDmsTransactionLog
- getDmsOperation
- getCloudDBBackupDetailList
- exportBackupToObjectStorage
- getDbServerLogList
- exportDbServerLogToObjectStorage
- Cloud DB for Redis metrics
- Cloud DB for PostgreSQL (VPC)
- Cloud DB for PostgreSQL (on VPC) overview
- addCloudPostgresqlDatabaseList
- addCloudPostgresqlUserList
- changeCloudPostgresqlUserList
- createCloudPostgresqlInstance
- createCloudPostgresqlReadReplicaInstance
- deleteCloudPostgresqlDatabaseList
- deleteCloudPostgresqlInstance
- deleteCloudPostgresqlReadReplicaInstance
- deleteCloudPostgresqlUserList
- exportBackupToObjectStorage
- exportDbServerLogToObjectStorage
- getCloudPostgresqlBackupDetailList
- getCloudPostgresqlBackupList
- getCloudPostgresqlBucketList
- getCloudPostgresqlDatabaseList
- getCloudPostgresqlImageProductList
- getCloudPostgresqlInstanceDetail
- getCloudPostgresqlInstanceList
- getCloudPostgresqlProductList
- getCloudPostgreSqlTargetSubnetList
- getCloudPostgresqlTargetVpcList
- getCloudPostgresqlUserList
- getDbServerLogList
- rebootCloudPostgresqlServerInstance
- Cloud DB for PostgreSQL (VPC) metrics
- Cloud DB for MySQL (VPC)
- Cloud DB for MySQL (VPC) overview
- addCloudMysqlDatabaseList
- addCloudMysqlUserList
- changeCloudMysqlServerSpec
- changeCloudMysqlUserList
- createCloudMysqlInstance
- createCloudMysqlRecoveryInstance
- createCloudMysqlSlaveInstance
- deleteCloudMysqlDatabaseList
- deleteCloudMysqlInstance
- deleteCloudMysqlServerInstance
- deleteCloudMysqlUserList
- exportBackupToObjectStorage
- exportDbServerLogToObjectStorage
- getCloudMysqlBackupDetailList
- getCloudMysqlBackupList
- getCloudMysqlDatabaseList
- getCloudMysqlEventHistoryList
- getCloudMysqlImageProductList
- getCloudMysqlInstanceDetail
- getCloudMysqlInstanceList
- getCloudMysqlProductList
- getCloudMysqlRecoveryTime
- getCloudMysqlTargetSubnetList
- getCloudMysqlTargetVpcList
- getCloudMysqlUserList
- getDbServerLogList
- rebootCloudMysqlServerInstance
- Cloud DB for MySQL (VPC) metrics
- Cloud DB for Redis (VPC)
- Cloud DB for Redis (on VPC) Overview
- createCloudRedisConfigGroup
- createCloudRedisInstance
- deleteCloudRedisConfigGroup
- deleteCloudRedisInstance
- getCloudRedisBackupDetailList
- getCloudRedisBackupList
- getCloudRedisConfigGroupList
- getCloudRedisImageProductList
- getCloudRedisInstanceDetail
- getCloudRedisInstanceList
- getCloudRedisProductList
- getCloudRedisManualBackupList
- flushAllCloudRedisServerInstance
- createCloudRedisManualBackup
- deleteCloudRedisManualBackup
- getCloudRedisConfigGroupVersionList
- getCloudRedisTargetSubnetList
- getCloudRedisTargetVpcList
- exportBackupToObjectStorage
- getCloudRedisBucketList
- rebootCloudRedisServerInstance
- getCloudRedisManualBackupDetailList
- Cloud DB for Redis (VPC) metrics
- Cloud DB for MSSQL (VPC)
- Cloud DB for MSSQL (VPC) overview
- createCloudMssqlInstance
- createCloudMssqlSlaveInstance
- deleteCloudMssqlInstance
- deleteCloudMssqlServerInstance
- exportBackupToObjectStorage
- exportDbServerLogsToObjectStorage
- getCloudMssqlLogBackupFileList
- getCloudMssqlBackupDetailList
- getCloudMssqlBackupList
- getCloudMssqlCharacterSetList
- getCloudMssqlConfigGroupList
- getCloudMssqlImageProductList
- getCloudMssqlInstanceDetail
- getCloudMssqlInstanceList
- getCloudMssqlProductList
- getCloudMssqlTargetSubnetList
- getCloudMssqlTargetVpcList
- getCloudMssqlBucketList
- getCloudMssqlFolderList
- getCloudMssqlLogFileList
- rebootCloudMssqlServerInstance
- Cloud DB for MSSQL (VPC) metrics
- Cloud DB for MongoDB (VPC)
- Cloud DB for MongoDB (VPC) 概述
- exportDbServerLogToObjectStorage
- getDbServerLogList
- addCloudMongoDbUserList
- changeCloudMongoDbConfigCount
- changeCloudMongoDbMongosCount
- changeCloudMongoDbShardCount
- changeCloudMongoDbSecondaryCount
- changeCloudMongoDbUserList
- createCloudMongoDbInstance
- deleteCloudMongoDbInstance
- deleteCloudMongoDbUserList
- getCloudMongoDbBucketList
- exportBackupToObjectStorage
- getCloudMongoDbBackupDetailList
- getCloudMongoDbBackupList
- getCloudMongoDbImageProductList
- getCloudMongoDbInstanceDetail
- getCloudMongoDbInstanceList
- getCloudMongoDbProductList
- getCloudMongoDbTargetSubnetList
- getCloudMongoDbTargetVpcList
- getCloudMongoDbUserList
- rebootCloudMongoDbServerInstance
- Cloud DB for MongoDB (VPC) metrics
- Cloud DB
- Security
- Secure Zone
- Secure Zone overview
- addAddressGroup
- addPolicy
- checkAddressGroupNameDuplicated
- checkPolicyNameDuplicated
- deleteAddressGroup
- deletePolicy
- getAddressGroup
- getAddressGroupList
- getDefaultDenyEventLogStatus
- getHourlyTrafficUsageList
- getIpsecAddress
- getMemberActionLog
- getMemberInfo
- getPolicy
- getPolicyList
- getTrafficLog
- getTrafficUsage
- rearrangePolicy
- setDefaultDenyEventLogStatus
- updateAddressGroup
- updatePolicy
- File Safer
- Security Monitoring
- Web Security Checker
- Key Management Service
- Key Management Service overview
- KMS API 1.0
- KMS API 2.0
- Account Auth API
- Create Key
- Get Key Info
- Get Key List
- Get Public Key
- Delete Key
- Enable Key
- Disable Key
- Enable Key Version
- Disable Key Version
- Rotate Key
- Request Key Deletion
- Cancel Key Deletion
- Enable IP ACL
- Disable IP ACL
- Get ACL Rule List
- Add ACL Rule
- Delete ACL Rule
- Create Token Generator
- Get Token Generator
- Update Token Generator
- Delete Token Generator
- Create Token Set
- Get Key Activity Logs
- Get Latest Use Info
- Get Key Version List
- Update Memo
- Update Rotation Period
- Enable Auto Rotation
- Disable Auto Rotation
- Encrypt
- Decrypt
- Create Custom Key
- Re-encrypt
- Sign
- Verify
- Token Auth API
- Account Auth API
- Certificate Manager
- PrivateCA
- Private CA overview
- Activate Sub CA
- Add CA User
- Create CA
- Create Ocsp
- Delete CA
- Delete CA User
- Delete Ocsp
- Get CA
- Get CA Chain
- Get CA Crl
- Get CA List
- Get CA User List
- Get Crl Config
- Get End Cert
- Get End Cert List
- Get Sub Csr
- Issue End Cert
- Revoke End Cert
- Rotate CRL
- Sign End Csr
- Sign Sub Csr
- Trim Ca
- Update CA
- Update Crl Config
- Webshell Behavior Detector
- Secret Manager
- Secret Manager overview
- Secret Management
- Create Secret
- Get Secret List
- Get Secret Detail
- Get Secret Value
- Update Secret Value
- Update Secret Stage Value
- Get Protection Key List
- Update Protection Key
- Update Secret Memo
- Update Rotation Period
- Update Rotation Trigger
- Delete Rotation Trigger
- Execute Rotation Job
- Cancel Rotation Job
- Retry Rotation Job
- Rollback Rotation Job
- Enable Secret
- Disable Secret
- Enable Auto Rotation
- Disable Auto Rotation
- Request Secret Deletion
- Cancel Secret Deletion
- Delete Secret
- Secret Rotate Control
- Secure Zone
- AI Services
- AiTEMS
- CLOVA Chatbot
- CLOVA OCR
- NCLUE
- NCLUE overview
- Get feature
- Get feature list
- Create feature
- Delete feature
- Get task
- Get task list
- Create task
- Delete task
- Get task run
- Get task run list
- Create task run
- Delete task run
- Get shopping intent
- Get shopping intent list
- Create shopping intent
- Delete shopping intent
- Download shopping intent
- Get custom attributes
- Get custom attributes list
- Create custom attributes
- Delete custom attributes
- CLOVA Speech
- CLOVA Studio
- CLOVA GreenEye
- Papago Translation
- Papago Image Translation
- AI·NAVER API
- Application Services
- GeoLocation
- Simple & Easy Notification Service
- API Gateway
- API Gateway overview
- API
- API Key
- Authorizer
- Canary Test
- Dashboard API Key
- Dashboard Event
- Dashboard Product
- Document
- Export
- Gateway Response
- Gateway Response Header
- Gateway Response Template
- Method
- Method Request Body
- Method Request Parameter
- Method Response
- Method Response Body
- Method Response Header
- Model
- Product
- Published Product
- Resource
- Stage
- Stage Deployment
- Stage Resource
- Usage Plan
- API Gateway Release Notes
- Cloud Outbound Mailer
- Cloud Outbound Mailer Overview
- createMailRequest
- getMail
- getMailList
- getMailRequestList
- getMailRequestStatus
- createFile
- getFile
- deleteFile
- createTemplate
- createTemplateExportRequest
- getTemplate
- getTemplateExportRequestList
- getTemplateStructure
- updateTemplate
- updateTemplateLocationOrName
- exportTemplate
- importTemplate
- deleteTemplate
- restoreTemplate
- createCategory
- updateCategory
- deleteCategory
- createAddressBook
- getAddressBook
- deleteAddressBook
- deleteAddress
- deleteRecipientGroup
- deleteRecipientGroupRelation
- deleteRecipientGroupRelationEmpty
- getSendBlockList
- registerUnsubscribers
- getUnsubscribersList
- deleteUnsubscribers
- createConfig
- getConfig
- Big Data & Analytics
- Cloud Hadoop (VPC)
- Cloud Hadoop (VPC) Overview
- backupClusterConfiguration
- changeCloudHadoopNodeCount
- changeCloudHadoopNodeSpec
- createCloudHadoopInstance
- createCloudHadoopNotebookInstance
- deleteCloudHadoopInstance
- deleteCloudHadoopNotebookInstance
- getCloudHadoopAddOnList
- getCloudHadoopBucketList
- getCloudHadoopClusterTypeList
- getCloudHadoopImageProductList
- getCloudHadoopInstanceDetail
- getCloudHadoopInstanceList
- getCloudHadoopLoginKeyList
- getCloudHadoopMysqlInstanceList
- getCloudHadoopMysqlUserList
- getCloudHadoopNotebookBucketList
- getCloudHadoopNotebookComponentList
- getCloudHadoopNotebookImageProductList
- getCloudHadoopNotebookInstanceDetail
- getCloudHadoopNotebookInstanceList
- getCloudHadoopNotebookProductList
- getCloudHadoopObjectList
- getCloudHadoopProductList
- getCloudHadoopTargetSubnetList
- getCloudHadoopTargetVpcList
- saveExternalHiveMetaStore
- testConnectExternalHiveMetaStore
- Cloud Hadoop (VPC) metrics
- Cloud Hadoop
- Cloud Search
- Cloud Search overview
- Get domain list
- Delete domain
- Create domain
- Edit domain
- Get domain
- Check domain name
- Change Default Ranking
- View Ranking List
- Delete Ranking
- Create Ranking
- View Ranking
- Get autocomplete
- View temporary domain lists
- Delete temporary domain
- Create temporary domain
- Edit temporary domain
- Temporary domain view
- Validate schema
- Edit schema
- Get schema history
- Get schema
- Search documents
- Document management
- Manage Object Storage documents
- Query Analysis Count
- Query Analysis Group By Count
- Query Analysis Time Series
- View DB Connection
- DB Connection check (VPC)
- Map DB table
- Map DB table (VPC)
- Search DB table
- Search DB table (VPC)
- Run DB upload
- Run DB upload (VPC)
- Search DB upload
- Search autocomplete
- Enable and edit autocomplete
- Get autocomplete history
- Change container count
- Get container list
- Change container type
- Get monitoring data
- Get stop word policy list
- Delete stop word policy
- Set stop word policy
- Get stop word policy
- Get available language
- Get morphological analysis options - available languages
- Get morphological analyzer - specific language
- Search thesaurus list
- Search thesaurus version
- Delete thesaurus
- Thesaurus settings
- Edit thesaurus
- Search thesaurus name
- Synonym dictionary view
- Confirm duplicate thesaurus
- Change usage limits
- Get usage limits
- Cloud Search metrics
- Search Engine Service (VPC)
- Overview of the Search Engine Service
- Cluster
- Create search engine cluster
- Get Search Engine version
- Search OS product
- Search node product
- Search VPC list
- Search subnet list
- Delete Search Engine Cluster
- Add Search Engine Cluster node
- Restart Search Engine Cluster
- Reset Search Engine User password
- Get Elasticsearch Cluster list
- Get Search Engine Cluster Data node
- Get Search Engine Cluster ACG
- Search the specifications of each Search Engine Cluster node group
- Search the specifications that can be changed for each Search Engine Cluster node group
- Change the node specifications of the Search Engine Cluster
- Change search engine cluster node type
- Search authentication key list
- Rolling Upgrade Pre Check
- Rolling Upgrade Cluster
- View Rolling Upgrade progress status
- Dashboard
- Monitoring
- Snapshot
- Import
- Search Engine Service metrics
- Cloud Data Streaming Service(VPC)
- Overview of the Cloud data streaming service
- Cluster
- View Cluster Rolling restart progress status
- Cluster Rolling restart requests
- Cluster Rolling restart precheck
- View Rolling Upgrade progress status
- Rolling UpGrade requests
- Rolling Upgrade precheck
- Creating a cloud data streaming service cluster
- Creating a Cloud Data Streaming Service Cluster (Return ID)
- Search Cloud Data Streaming Service Version
- Get OS product
- Search node product
- Search VPC list
- Search subnet list
- Delete Cloud Data Streaming Service Cluster
- Add Cloud Data Streaming Service Cluster node
- Restart all services
- Restart CMAK
- Restart Kafka
- Restart Kafka by node
- Reset CMAK connection password
- Search Cloud Data Streaming Service Cluster list
- Search single Cloud Data Streaming Service cluster
- Search Cloud Data Streaming Service Cluster node
- Cloud Data Streaming Service Cluster Get an ACG
- Check cluster status
- Check broker node information
- Download certificate
- Enable public domain
- Disable public domain
- View a list of load balancers
- Enable the broker node's public endpoint
- Disable the broker node's public endpoint
- Search the specifications by node group
- Search the specifications that can be changed for each node group
- Change Node specifications
- Monitoring
- ConfigGroup
- Create config group
- Delete Config Group
- View Config Group information
- Modify Config Group description
- View list of ConfigGroup for each Kafka version
- Get list of clusters using config group
- View list of Config Group Kafka properties
- Save Config Group Kafka properties settings
- Apply Config Group to cluster
- Cloud Data Streaming Service metrics
- Data Forest
- Data Forest Overview
- Accounts
- Notebooks
- getVpcList
- getVpcDetail
- getSubnetList
- getSubnetDetail
- getTypeList
- getServerTypeList
- getList
- getDetail
- getUserConfigurationSpecList
- checkAvailableName
- getLoginKeyList
- getObjectStorageBucketDetail
- getObjectStorageBucketList
- getAcgRuleList
- restart
- delete
- create
- setUserConfigurationList
- setObjectStorageBucket
- Apps
- AI workspaces
- AI Apps
- Data Box Frame
- Data Box Frame overview
- Data Box Frame Code
- get-data-box-frame-list
- get-data-box-frame-detail
- get-data-box-frame-infra-list
- get-data-box-list
- get-data-box-summary-info
- get-data-box-infra-list
- get-hadoop-cluster-info
- get-linux-info
- get-tensor-flow-info
- get-bucket-list
- get-import-apply-list
- get-import-apply-detail
- get-target-nas-list
- get-export-apply-list
- get-export-apply-detail
- get-ssl-vpn-account-list
- get-source-nas-list
- get-export-file-approve-list
- get-export-file-approve-detail
- return-data-box-frame
- change-data-box-frame-nas-volume-size
- return-data-box
- change-data-box-nas-volume-size
- set-block-external-network
- apply-file-import
- apply-file-export
- return-file-export-apply
- export-file-approve
- export-file-reject
- modify-data-box-frame-admin-infra
- modify-data-box
- create-data-box
- Data Catalog
- Data Flow
- Data Query
- Cloud Data Box
- Cloud Hadoop (VPC)
- Blockchain
- Blockchain Service
- Blockchain Service overview
- Get network list
- Get network information
- Get organization list
- Get organization information
- Download organization connection information
- Get orderer list
- Get orderer information
- Download orderer connection information
- Get orderer pod log
- Get orderer pod usage
- Get peer list
- Get peer information
- Get peer pod log
- Get peer pod usage
- Get CA list
- Get CA information
- Get CA identity
- Download CA identity
- Get CA pod log
- Get CA pod usage
- Blockchain Service
- Business Applications
- Content Delivery
- Developer Tools
- SourceCommit
- SourceBuild
- SourceBuild Overview
- Project List
- View project details
- Create Project
- Change Project Settings
- Delete Project
- Start Build
- Cancel build
- build history
- Operating System List
- compute type list
- runtime type list
- runtime version list
- Docker Engine List
- SourceCommit Repository Lookup
- SourceCommit Branch Lookup
- Object Storage Bucket List
- Container Registry List
- SourceDeploy
- SourceDeploy Overview
- Project List
- Create Project
- Delete Project
- Stage List
- Stage Detail
- Stage Create
- Stage Update
- Stage Delete
- Scenario List
- Scenario details
- Create scenario
- Edit scenario
- Delete Scenario
- Start Deployment
- Cancel Deployment
- Request Deployment Approval
- Approve Deployment
- Deployment Rejection
- Approve Canary Deployment
- Canary Deployment Rejection
- Deployment History List
- Deployment History Details
- Querying the Canary
- Canary Analysis Report
- Server list
- AutoScalingGroup List Lookup
- KubernetesService Cluster List
- targetGroup list(VPC)
- SourceCommit Repository list
- SourceCommit Branch list
- SourceBuild list
- ObjectStorage Bucket List
- ObjectStorage Object List
- SourcePipeline
- SourcePipeline Overview
- Project List
- Project details
- Project creation
- Edit project
- Delete Project
- Run Pipeline
- Pipeline cancel
- Execution History List
- Running history details
- SourceCommit repository list
- SourceCommit branch list
- SourceBuild project list
- SourceDeploy project list
- SourceDeploy stage list
- SourceDeploy scenario list
- List of scheduled trigger time zones
- Digital Twin
- Gaming
- GAMEPOT
- GAMEPOT overview
- User Lookup
- Searching blocked user
- User stop settings
- Daily access (DAU) inquiry
- New User (NRU) Lookup
- Simultaneous access (CCU) inquiry
- Payment inquiry
- Payment cancellation inquiry
- Billing Sales Statistics Inquiry
- Character inquiry
- General coupon usage inquiry
- Using coupon
- Post notice
- Leaderboard
- Manage friend
- Advance reservation participation
- Advance reservation verification code sending
- Advance reservation verification code check
- Identity authentication result query
- Game Chat
- GAMEPOT
- Hybrid & Private Cloud
- Management & Governance
- Cloud Log Analytics
- Sub Account
- Sub Account overview
- Subaccounts
- Get sub account list
- Get sub account
- Create sub account
- Edit sub account
- Delete sub account
- Get access key
- Create access key
- Delete access key
- Set access key status
- Get login access key
- Set login access key
- Check login ID
- Check login password
- Get idle session expiration time
- Set idle session expiration time
- Get login password expiration date
- Set login password expiration date
- Reset login password
- Assign policy
- Delete policy
- Add group
- Delete group
- Get console access rule
- Edit console access rule
- Get API access rule
- Edit sub account API access rule
- Get two-factor authentication information
- Get tag
- Add tag
- Delete tag
- Get user ID
- Get user information
- Groups
- Policies
- Roles
- Get role list
- Get role
- Create role
- Edit role
- Delete role
- Assign policy
- Delete policy
- Get role (Account) application target
- Add role (Account) application target
- Delete role (Account) application target
- Add role (Server, Service) application target
- Delete role (Server, Service) application target
- Set role list status
- Set role status
- Get tag
- Add tag
- Remove tag
- Get switchable role
- Register switchable role
- Edit switchable role
- Delete switchable role
- External access
- Get trust anchor list
- Get trust anchor
- Create trust anchor
- Edit trust anchor
- Enable trust anchor
- Disable trust anchor
- Delete trust anchor
- Get profile list
- Get profile
- Create profile
- Edit profile
- Enable profile
- Disable profile
- Delete profile
- Get subject list
- Get subject
- Get subject activity list
- Get CRL list
- Get CRL
- Create CRL
- Edit CRL
- Enable CRL
- Disable CRL
- Delete CRL
- Secure Token Service
- Web service Monitoring System
- Effective Log Search & Analytics
- Network Traffic Monitoring
- Cloud Activity Tracer
- Resource Manager
- Cloud Insight
- Cloud Insight overview
- Dashboard
- Event
- Event Rule
- CopyRuleGroup
- CreateMetricsGrp
- CreateMonitorGrp
- CreateRuleDirectly
- CreateRuleGroup
- DeleteMetricGroupForce
- DeleteMetricsGrp
- DeleteMetricsGrpByProdKeyAndId
- DeleteMonitorGroupForce
- DeleteMonitorGrp
- DeleteRuleGroup
- DeleteRuleGroupByProdKeyAndId
- GetAllMonitorGrp
- GetMetricsGroup
- GetMetricsGroupList
- GetMonitorGrp
- GetNotificationRecipientList
- GetRuleGroup
- GetRuleGroupByMetricGroupIds
- GetRuleGroupByMonitorGroupIds
- GetRuleGroupList
- RemoveResourceFromRules
- SearchMetricList
- UpdateMetricsGroup
- UpdateMonitorGrp
- UpdateRuleGroup
- Schema
- Custom Resource
- Planned Maintenance
- Plugin
- Server
- Data
- Integration
- Cloud Insight metrics
- Ncloud Single Sign-On
- Ncloud Single Sign-On overview
- Application
- Tenant
- External IdP
- Viewing external IDP
- Registering external IDP
- Editing external IDP
- Deleting external IDP
- Viewing attribute mapper
- Editing attribute mapper
- External IDP metadata parsing
- Viewing metadata of Ncloud Single Sign-On
- Viewing URL data of Ncloud Single Sign-On
- Set login with external IDP
- Connecting Organization
- SSO User
- Viewing user list
- Viewing single user
- Creating user
- Creating users in batch
- Editing user
- Deleting user list
- Deleting user
- User login ID validation
- Viewing User Access Rules
- Editing User Access Rules
- Viewing user profile
- Viewing list of groups including user
- Viewing single group including user
- Adding user to group
- Deleting user from group
- Changing user status
- Viewing user session
- Expire user session
- Viewing list of assignments to which user belongs
- Deleting user from assignment
- View MFA device owned by user
- Add MFA device to user
- Delete MFA device from user
- Group
- Permission Set
- Viewing Permission Set list
- View single permission set
- Creating Permission Set
- Editing Permission Set
- Deleting multiple Permission Sets
- Delete permission set
- Validating Permission Set name
- Deleting policies in Permission Set
- Viewing list of policies in Permission Set
- Checking whether Permission Set has policy
- Assignment
- Viewing assignment list
- Viewing single assignment
- Creating assignment
- Edit assignment
- Deleting assignment
- Assignment status change
- View assignment target
- Add Assignment Target
- Deleting assignment target
- Viewing list of IP ACLs in assignment
- Adding IP ACL to assignment
- Deleting IP ACL in assignment
- Viewing account list
- Checking whether account has user-defined policy
- IP ACL
- Cloud Advisor (VPC)
- Cloud Advisor overview
- Search for check categories
- Search for checklist status
- Search for checklist
- Search for a summary of the results
- Request for check
- Search for a summary of check results
- Search for details of check results
- Check results detailed inclusion settings
- Check results detailed exclusion settings
- Download check results
- Organization
- Media
- Live Station
- Live Station overview
- Channel Management
- Quality Profile
- Quality Setting
- Recording
- Re-Stream Management
- VOD to Live Management
- Event
- Live Station error codes
- VOD Station
- Video Player Enhancement
- One Click Multi DRM
- B2B Prism Live Studio
- Media Connect Center
- Live Station
- Migration
Article summary
Did you find this summary helpful?
Thank you for your feedback
Basic information
API URL
https://sens.apigw.ntruss.com/friendtalk/v2
HTTP
Go to SENS Friend Talk API Swagger
API Header
Category | Mandatory | Description |
---|---|---|
Content-Type | Mandatory | Specify the request body content type as application/json (POST) |
x-ncp-apigw-timestamp | Mandatory | This 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-key | Mandatory | This is the access key ID issued by the portal or Sub Account |
x-ncp-apigw-signature-v2 | Mandatory | Signature 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Headers
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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
plusFriendId | Mandatory | String | Name of Kakao Talk Channel ((formerly) Plus Friend ID) | |
messages | Mandatory | Object | Message information | See items below (messages.XXX). Up to 100 |
messages.isAd | Optional | Boolean | Ad message status | default: 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.countryCode | Optional | String | Recipient country code | default: 82 |
messages.to | Mandatory | String | Recipient number | |
messages.content | Mandatory | String | Friend Talk message content | |
messages.buttons | Optional | Array of Object | Friend Talk message button | See Button information |
messages.buttons.type | Mandatory | String | Button type | See the following template button information. |
messages.buttons.name | Mandatory | String | Button name | See the following template button information. |
messages.image | Optional | Object | Image information | See Upload image |
messages.image.imageId | Mandatory | String | ID of uploaded image | |
messages.image.imageLink | Mandatory | String | Image link | |
messages.useSmsFailover | Optional | Boolean | SMS failover use status | Available only on Kakao Talk Channels where failover is configured Default: Follow the failover settings of Kakao Talk Channel |
messages.failoverConfig | Optional | Object | Failover settings | See the items below. |
messages.failoverConfig.type | Optional | String | Failover SMS message type | SMS or LMS Default: automatically applied according to the content length (SMS if 90 bytes or less, LMS if it exceeds 90 bytes) |
messages.failoverConfig.from | Optional | String | Failover SMS caller ID | Default: caller ID selected when setting up failover Failover does not work when using an unauthorized caller ID. |
messages.failoverConfig.subject | Optional | String | Failover SMS title | Used when operating in LMS type Default: Kakao Talk Channel name |
messages.failoverConfig.content | Optional | String | Failover SMS content | Default: Friend Talk message content (excluding button) |
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 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.
Status | Error text | Desc |
---|---|---|
0000 | - | Normal delivery |
3022 | NoSendAvailableTimeException | Outside the time available for sending messages (Friend Talk/marketing messages can be sent from 8:00 AM to 8:50 PM KST) |
Bxxx | See the Biz Message reception result code below | See 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
Type | Name | Mandatory item |
---|---|---|
WL | Web link | linkMobile, linkPc (URL starting with http:// or https://) |
AL | App link | schemeIos, schemeAndroid |
BK | Bot keyword | |
MD | Send message | |
AC | Add 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
requestId | Mandatory | String | Delivery request ID | |
requestTime | Mandatory | DateTime | Delivery request time | yyyy-MM-dd'T'HH:mm:ss.SSS |
statusCode | Mandatory | String | Request status code | 202 - Success Others - Failure * Follows the HTTP status specification. |
statusName | Mandatory | String | Request status name | success - Success processing - Being processed reserved - Being reserved fail - Failure |
messages.messageId | Mandatory | String | Message ID | |
messages.countryCode | Optional | String | Recipient country code | default: 82 |
messages.to | Mandatory | String | Recipient number | |
messages.content | Mandatory | String | Friend Talk message content | |
messages.requestStatusCode | Mandatory | String | Delivery request status code | A000 - Success Other codes - Failure (reason for failure specified in the Desc category) |
messages.requestStatusName | Mandatory | String | Delivery request status name | success - Success fail - Failure |
messages.requestStatusDesc | Mandatory | String | Delivery request status content | |
messages.useSmsFailover | Mandatory | Boolean | SMS failover use status |
Response status
HTTP Status | Desc |
---|---|
202 | Accepted (delivery request completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
requestId | Mandatory | String | Request ID | Delivery request ID |
plusFriendId | Mandatory | String | Kakao channel | Name of the registered channel |
requestStartTime | Mandatory | String | Query start time | yyyy-MM-dd'T'HH:mm:ss |
requestEndTime | Mandatory | String | Query end time | yyyy-MM-dd'T'HH:mm:ss |
completeStartTime | Mandatory | String | Delivery completion start time | yyyy-MM-dd'T'HH:mm:ss |
completeEndTime | Mandatory | String | Delivery completion end time | yyyy-MM-dd'T'HH:mm:ss |
messageId | Optional | String | Message ID | |
requestStatusName | Optional | String | Request status | success, fail |
messageStatusName | Optional | String | Request status | success, processing, fail |
to | Optional | String | Message recipient number | Number excluding hyphens (-) |
pageIndex | Optional | Integer | Page number | default: 0 |
pageSize | Optional | Integer | Page size | Default: 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
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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
requestId | Optional | String | Delivery request ID | Displayed only when queried by requestId |
statusCode | Mandatory | String | Request status code | 202 - Success Others - Failure * Follows the HTTP status specification. |
statusName | Mandatory | String | Request status name | success - Success processing - Being delivered reserved - Being reserved fail - Failure |
messages.requestTime | Mandatory | DateTime | Delivery request time | yyyy-MM-dd'T'HH:mm:ss.SSS |
messages.messageId | Mandatory | String | Message ID | |
messages.countryCode | Optional | String | Recipient country code | default: 82 |
messages.to | Mandatory | String | Recipient number | |
messages.content | Mandatory | String | Friend Talk message content | |
messages.plusFriendId | Mandatory | String | Name of Kakao Talk Channel ((formerly) Plus Friend ID) | |
messages.completeTime | Optional | DateTime | Delivery reporting (processing completion) time | yyyy-MM-dd'T'HH:mm:ss |
messages.requestStatusCode | Mandatory | String | Delivery request status code | A000 - Success Other codes - Failure (reason for failure specified in the Desc category) |
messages.requestStatusName | Mandatory | String | Delivery request status name | success - Success fail - Failure |
messages.requestStatusDesc | Mandatory | String | Delivery request status content | |
messages.messageStatusCode | Mandatory | String | Delivery result status code | 0000 - Success Other codes - Failure (reason for failure specified in the Desc category) |
messages.messageStatusName | Mandatory | String | Delivery result status name | success - Success processing - Being processed * Undergoing processing in the message delivery server after successful sending request * messageCode and messageDesc are not searched. fail - Failure |
messages.messageStatusDesc | Mandatory | String | Delivery result status content | |
messages.isWide | Mandatory | Boolean | Wide status | |
messages.isAd | Mandatory | Boolean | Ad message status | |
messages.useSmsFailover | Mandatory | Boolean | SMS failover use status | |
messages.failover | Optional | Object | SMS Failover | |
messages.failover.smsServiceId | Optional | String | SMS failover service ID | |
messages.failover.requestId | Optional | String | SMS failover delivery request ID | |
messages.failover.messageId | Optional | String | SMS failover delivery message ID | |
messages.failover.requestStatusCode | Optional | String | SMS failover delivery request status code | See the Error code table. |
messages.failover.requestStatusName | Optional | String | SMS failover delivery request status name | success - Success fail - Failure |
messages.failover.requestStatusDesc | Optional | String | SMS failover delivery request status content | |
messages.failover.messageStatus | Optional | String | SMS failover delivery request status | READY: ready PROCESSING: being processed COMPLETED: processing completed |
messages.failover.messageStatusCode | Optional | String | SMS failover delivery device received status result code | See the Error code table. |
messages.failover.messageStatusName | Optional | String | SMS failover delivery device received result name | |
messages.failover.messageStatusDesc | Optional | String | SMS failover delivery device received content | |
pageSize | Mandatory | Integer | Page size | |
pageIndex | Mandatory | Integer | Page index (starts from 0) | |
itemCount | Mandatory | Integer | Number of messages in the pages retrieved | |
hasMore | Mandatory | Boolean | It indicates whether there is a next page |
Response status
HTTP Status | Desc |
---|---|
200 | OK (search completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
messageId | Mandatory | String | Message ID | Message identifier that is returned when the message is sent |
Headers
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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
messageId | Mandatory | String | Message ID | |
requestId | Mandatory | String | Delivery request ID | |
requestTime | Mandatory | DateTime | Delivery request time | yyyy-MM-dd'T'HH:mm:ss.SSS |
completeTime | Optional | DateTime | Delivery reporting (processing completion) time | yyyy-MM-dd'T'HH:mm:ss |
plusFriendId | Mandatory | String | Name of Kakao Talk Channel ((formerly) Plus Friend ID) | |
templateCode | Mandatory | String | Template code | |
countryCode | Optional | String | Recipient country code | default: 82 |
to | Mandatory | String | Recipient number | |
content | Mandatory | String | Friend Talk message content | |
requestStatusCode | Mandatory | String | Delivery request status code | A000 - Success Other codes - Failure (reason for failure specified in the Desc category) |
requestStatusName | Mandatory | String | Delivery request status name | success - Success fail - Failure |
requestStatusDesc | Mandatory | String | Delivery request status content | |
messageStatusCode | Mandatory | String | Delivery result status code | 0000 - Success Other codes - Failure (reason for failure specified in the Desc category) |
messageStatusName | Mandatory | String | Delivery result status name | success - Success processing - Being processed * Undergoing processing in the message delivery server after successful sending request * messageCode and messageDesc are not searched. fail - Failure |
messageStatusDesc | Mandatory | String | Delivery result status content | |
isWide | Mandatory | Boolean | Wide status | |
isAd | Mandatory | Boolean | Ad message status | |
imageId | Optional | String | Image ID | |
imageName | Optional | String | Image name | |
imageUrl | Optional | String | Image URL | |
imageLink | Optional | String | Image link | |
useSmsFailover | Mandatory | Boolean | SMS failover use status | |
failover | Optional | Object | SMS failover use status | |
failover.smsServiceId | Optional | String | SMS failover service ID | |
failover.requestId | Optional | String | SMS failover delivery request ID | |
failover.requestStatusCode | Optional | String | SMS failover delivery request status code | See the Error code table. |
failover.requestStatusName | Optional | String | SMS failover delivery request status name | success - Success fail - Failure |
failover.requestStatusDesc | Optional | String | SMS failover delivery request status content | |
failover.messageId | Optional | String | SMS failover delivery message ID | |
failover.messageStatus | Optional | String | SMS failover delivery request status | READY: ready PROCESSING: being processed COMPLETED: processing completed |
failover.messageStatusCode | Optional | String | SMS failover delivery device received status result code | See the Error code table. |
failover.messageStatusName | Optional | String | SMS failover delivery device received result name | |
failover.messageStatusDesc | Optional | String | SMS failover delivery device received content |
Failover request status code
requestStatusCode | Desc |
---|---|
0 | Succeeded |
E4000 | The failover settings are not valid |
E4001 | The failover settings information is omitted |
E4002 | The failover SMS service is not configured |
E4003 | The failover SMS type (SMS, LMS) is not configured |
E4004 | The failover SMS caller ID is not configured. |
E4005 | The failover SMS title is not configured |
E4006 | The failover SMS content is not configured |
E4007 | The failover SMS recipient number is not configured |
E4008 | The failover SMS service is not available |
E4009 | The failover SMS caller ID is not authenticated |
E4010 | The failover SMS free 080 unsubscribing service is not available |
E4999 | Failover settings parsing error (required to contact Support) |
E5000 | Internal error (required to contact Support) |
Response status
HTTP Status | Desc |
---|---|
200 | OK (search completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
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 the reserved delivery requests (requestId) |
Headers
Request body
None
JSON
Response body
{
"reserveId": "string",
"reserveTimeZone": "string",
"reserveTime": "string",
"reserveStatus": "string"
}
JSON
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
reserveId | Mandatory | String | Reserved message ID | Message identifier that is returned when searching 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 | Reservation status | READY - 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 Status | Desc |
---|---|
200 | OK (search completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
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 the reserved delivery requests (requestId) |
Headers
Request body
None
JSON
Response body
None
JSON
Response status
HTTP Status | Desc |
---|---|
204 | No Content (deletion completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Parameters
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
pageSize | Optional | Integer | Page size | default: 100 (Only numbers between 1 and 100 can be entered.) |
pageIndex | Optional | Integer | Page index | default: 0 |
Headers
Request body
None
JSON
Response body
[
{
"createTime": "string",
"updateTime": "string",
"serviceId": "string",
"channelId": "string",
"channelName": "string",
"channelStatus": "string",
"useSmsFailover": "boolean"
}
]
JSON
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
createTime | Mandatory | String | Creation time | format: LocalDateTime |
updateTime | Optional | String | Edited time | format: LocalDateTime |
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
channelId | Mandatory | String | Kakao Talk Channel ID | |
channelName | Mandatory | String | Kakao Talk Channel name | |
channelStatus | Mandatory | String | Kakao Talk Channel status | - Normal: ACTIVE - Deleted: DELETED - Being deleted permanently: DELETING_PERMANENTLY - Deleted permanently: PERMANENTLY_DELETED - Blocked: BLOCKED - Deletion pending: PENDING_DELETE |
useSmsFailover | Mandatory | Boolean | Use status of alternative SMS delivery |
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 |
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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Headers
Request parameter
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
plusFriendId | Mandatory | String | Name of Kakao Talk Channel ((formerly) Plus Friend ID) | |
imageFile | Mandatory | File | Image 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 |
isWide | Optional | Boolean | Wide image status | When 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
imageId | Mandatory | Strng | Image ID | |
imageName | Mandatory | String | Image file name | |
imageUrl | Mandatory | String | Image URL | |
isWide | Mandatory | Boolean | Wide status | |
createTime | Mandatory | DateTime | Image uploading time |
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully uploaded) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
Headers
Parameters
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
pageIndex | Optional | Integer | Page index | default: 0 |
pageSize | Optional | Integer | Page size | default: 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
items | Mandatory | Array of Object | Image data list | See image data |
pageIndex | Mandatory | Integer | Page index | |
pageSize | Mandatory | Integer | Page size | |
itemCount | Mandatory | Integer | Number of items retrieved | |
totalCount | Mandatory | Integer | Total count |
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully searched) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
imageId | Mandatory | String | Image ID | ID of uploaded image |
Headers
Request body
None
JSON
Response body
{
"imageId":"string",
"imageName":"string",
"imageUrl":"string",
"isWide":"boolean",
"createTime":"string"
}
JSON
Image data
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
imageId | Mandatory | Strng | Image ID | |
imageName | Mandatory | String | Image file name | |
imageUrl | Mandatory | String | Image URL | |
isWide | Mandatory | Boolean | Wide status | |
createTime | Mandatory | DateTime | Image uploading time |
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully searched) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Category | Mandatory | Type | Description | Note |
---|---|---|---|---|
serviceId | Mandatory | String | Service ID | Service ID issued when registering the project |
imageId | Mandatory | String | Image ID | ID of uploaded image |
Headers
Request body
None
JSON
Response body
None
JSON
Response status
HTTP Status | Desc |
---|---|
204 | No Content (deletion completed) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Errors
Biz Message reception result code
Status | Error text | Desc |
---|---|---|
0000 | - | Normal delivery |
1001 | NoJsonBody | Request body is not in JSON format. |
1002 | InvalidHubPartnerKey | Invalid partner key |
1003 | InvalidSenderKey | Invalid outgoing profile key |
1004 | NoValueJsonElement | Name not found in request body (JSON) |
1005 | SenderNotFound | Outgoing profile not found |
1006 | DeletedSender | Deleted outgoing profile |
1007 | StoppedSender | Blocked outgoing profile |
1011 | ContractNotFound | Contract information not found |
1012 | InvalidUserKeyException | Invalid format of user key request |
1013 | InvalidAppLink | Invalid app connection |
1014 | InvalidBizNum | Invalid business registration number |
1015 | TalkUserIdNotFonud | Invalid app user id request |
1016 | BizNumNotEqual | Mismatched business registration number |
1020 | InvalidReceiveUserException | No valid user identifier value |
1021 | BlockedProfile | Blocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool) |
1022 | DeactivatedProfile | Closed Kakao Talk Channel (check from the Kakao Talk Channel operation tool) |
1023 | DeletedProfile | Deleted Kakao Talk Channel (check from the Kakao Talk Channel operation tool) |
1024 | DeletingProfile | Deletion-pending Kakao Talk Channel (check from the Kakao Talk Channel operation tool) |
1025 | SpammedProfile | Message-blocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool) |
1026 | UnableUseMessageType | The 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 |
1030 | InvalidParameterException | Invalid parameter request |
1033 | - | Template type and message type mismatch |
2000 | FailedToCheckFriendshipException | Error when checking the friend relationship with the Talk Channel (system error) |
2003 | FailedToSendMessageByNoFriendshipException | Message delivery failure (if Kakao Talk Channel is not added in the test server) |
2004 | FailedToMatchTemplateException | Error when checking template match (internal Kakao error) |
2005 | FailedToReadImageException | Error reading image meta information from Kakao |
2006 | FailedToMatchSerialNumberPrefixPattern | Serial number format mismatch |
3000 | UnexceptedExcetpion | Occurrence of an unexpected error |
3005 | AckTimeoutException | A message was sent, but the read receipt was not confirmed (success uncertain) |
3006 | FailedToSendMessageException | Message delivery failed due to Kakao's internal system error. |
3008 | InvalidPhoneNumberException | Phone number error |
3010 | JsonParsseExcetpion | JSON parsing error |
3011 | MessageNotFoundException | Message does not exist. |
3012 | SerialNumberDuplicatedException | Message serial number is duplicated. (A unique value must be assigned for the message serial number.) |
3013 | MessageEmptyException | Blank message |
3014 | MessageLengthOverLimitException | Message length limit error (exceeding 1000 characters for text type, 400 characters for image type) |
3015 | TemplateNotFoundException | Template not found |
3016 | NoMatchedTemplateException | Message content does not match the template. |
3018 | NoSendAvailableException | Message could not be sent. |
3019 | MessageNoUserException | Not a Talk user |
3020 | MessageUserBlockedAlimTalkException | Alim Talk blocked |
3021 | MessageNotSupportedKakaotalkException | Minimum support version for Talk not met |
3022 | NoSendAvailableTimeException | Outside the time available for sending messages (Friend Talk/marketing messages can be sent from 08:00 to 20:00.) |
3023 | MessageInvalidVideoException | Unable 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) |
3024 | MessageInvaildImageException | The image contained in the message can't be sent. |
3025 | ExceedMaxVariableLengthException | Variable character limit exceeded |
3026 | Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})' | Inquiry/bot switching button extra, event character limit exceeded |
3027 | NoMatchedTemplateButtonException | Button content does not match the template. |
3028 | NoMatchedTemplateTitleException | Message highlighting title does not match the template. |
3029 | ExceedMaxTitleLengthException | Message highlighting title length limit exceeded (50 characters) |
- | ||
3030 | NoMatchedTemplateWithMessageTypeException | Message type does not match the template highlight type. |
3031 | NoMatchedTemplateHeaderException | Header does not match the template. |
3032 | ExceedMaxHeaderLengthException | Header length limit exceeded (16 characters) |
3033 | NoMatchedTemplateItemHighlightException | Item highlight does not match the template. |
3034 | ExceedMaxItemHighlightTitleLengthException | Item highlight title length limit exceeded (30 characters with no images, 21 characters with images) |
3035 | ExceedMaxItemHighlightDescriptionLengthException | Item highlight description length limit exceeded (19 characters with no images, 14 characters with images) |
3036 | NoMatchedTemplateItemListException | Item list does not match the template. |
3037 | ExceedMaxItemDescriptionLengthException | Item's description length limit exceeded in the item list (23 characters) |
3038 | NoMatchedTemplateItemSummaryException | Item summary information does not match the template |
3039 | ExceedMaxItemSummaryDescriptionLengthException | Item summary information's description length limit exceeded (14 characters) |
3040 | InvalidItemSummaryDescriptionException | Item summary information's description includes characters that are not allowed (inclusion of characters other than currency symbol/code, number, comma, period, and space) |
3041 | MessageInvalidWideItemListLengthException | Wide item list count minimum, maximum mismatch |
3042 | NoMatchedTemplateRepresentLinkException | Representative link does not match template |
3046 | ExceedMaxAdditionalContentLengthException | Additional information maximum length limit error |
3047 | ExceedMaxCommerceTitleLengthException | Commerce information, product name maximum length limit error |
3050 | MessageNotSupportedUnsubscribeException | Opt-out specifications (N type) not supported |
3051 | InvalidateCarouselItemMinException or InvalidateCarouselItemMaxException | Carousel item list count minimum, maximum mismatch |
3052 | CarouselMessageLengthOverLimitException | Carousel item message length exceeded |
3056 | WideItemListTitleLengthOverLimitException | Wide item list title length limit error |
3058 | CarouselHeaderLengthOverLimitException | Carousel header length limit error |
3059 | MessageNotSupportedCouponException | Coupon specifications not supported |
4000 | ResponseHistoryNotFoundException | Message delivery result not found |
4001 | UnKnownMessageStatusError | Unknown 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 |
9998 | The service is not currently provided. | The admin is checking a problem that occurred in the system |
9999 | The admin is checking an unknown problem that occurred in the system | The admin is checking a problem that occurred in the system |
B000 | Prepare to relay failed | Failure of preliminary work for forwarding to the relay company |
B001 | Request to relay failed | Relay company delivery failure |
B002 | Filtering for request to relay failed | Filtered due to invalid request |
B003 | Invalid phone number format | Invalid caller ID format |
B004 | Quota Exceed | Quota exceeded |
B005 | Message processing timeout exceed | The difference between the message request time and processing time is outside the allowable range |
B400 | Invalid Request | Message format error |
B999 | Unexpected server error | Unexpected error |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
How can we improve this article?
Your feedback
Comment
Comment (Optional)
Character limit : 500
Please enter your comment
Email (Optional)
Email
Please enter a valid email