- HOME
- API 개요
- API 개요
- API 호출 및 인증
- API 데이터 타입
- 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
- CipherSuiteList
- HostHeaderCondition
- HostHeaderList
- IDResponse
- IpList
- LoadBalancerInstance
- LoadBalancerInstanceList
- LoadBalancerIpList
- LoadBalancerListener
- LoadBalancerListenerList
- LoadBalancerListenerNoList
- loadBalancerListenerCertificate
- loadBalancerListenerCertificateList
- LoadBalancerRule
- LoadBalancerRuleList
- LoadBalancerRuleNoList
- LoadBalancerRuleAction
- LoadBalancerRuleCondition
- LoadBalancerSubnet
- NatGatewayInstance
- NatGatewayInstanceList
- NetworkAcl
- NetworkAclList
- NetworkAclDenyAllowGroup
- NetworkAclDenyAllowGroupList
- NetworkAclRule
- NetworkAclRuleList
- PathPatternCondition
- PathPatternList
- PolicyDetailResponse
- PolicyListResponse
- PolicyRequest
- ProfileDetailResponse
- ProfileListResponse
- ProfileRequest
- RedirectionAction
- Route
- RouteList
- RouteTable
- RouteTableList
- Subnet
- SubnetList
- SubnetNoList
- Target
- TargetList
- TargetNoList
- TargetGroup
- TargetGroupList
- TargetGroupNoList
- TargetGroupAction
- TargetGroupWeight
- TargetSubnet
- TargetSubnetList
- TargetVpc
- TargetVpcList
- Vpc
- VpcList
- VpcPeeringInstance
- VpcPeeringInstanceList
- 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) 개요
- 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) 지표
- Server
- Server 개요
- 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 지표
- Auto Scaling (VPC)
- Auto Scaling (VPC) 개요
- Launch Configuration
- Auto Scaling Group
- getAutoScalingGroupList
- getAutoScalingGroupDetail
- createAutoScalingGroup
- updateAutoScalingGroup
- deleteAutoScalingGroup
- setDesiredCapacity
- getScheduledActionList
- putScheduledUpdateGroupAction
- deleteScheduledAction
- getScalingProcessTypeList
- suspendProcesses
- resumeProcesses
- getAutoScalingActivityLogList
- getAutoScalingPolicyList
- getAdjustmentTypeList
- putScalingPolicy
- deleteScalingPolicy
- executePolicy
- Auto Scaling (VPC) 지표
- Auto Scaling
- Auto Scaling 개요
- 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 지표
- Cloud Functions
- Cloud Functions 개요
- 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 개요
- Cluster 목록 조회
- Cluster 조회
- Cluster 생성
- Cluster 버전 업그레이드
- Cluster Audit Log 설정
- Cluster Subnet 추가
- Cluster OIDC 설정
- Cluster OIDC 조회
- Cluster IP ACL 설정
- Cluster IP ACL 조회
- Cluster LB Subnet 수정
- Cluster 반납 보호 설정
- Cluster 시크릿 암호화 설정
- Cluster 인증 모드 설정
- Cluster IAM 액세스 목록 조회
- Cluster IAM 액세스 조회
- Cluster IAM 액세스 생성
- Cluster IAM 액세스 수정
- Cluster IAM 액세스 삭제
- Cluster 삭제
- WorkerNode 조회
- WorkerNode 삭제
- NodePool 조회
- NodePool 생성
- NodePool 수정
- NodePool Subnet 수정
- NodePool Label 수정
- NodePool Taint 수정
- NodePool 업그레이드
- NodePool 삭제
- Kubeconfig 조회
- Kubeconfig 재설정
- k8s 지원 버전 조회
- 서버 이미지 조회
- 서버 스펙 조회
- Ncloud Kubernetes Service (VPC) 지표
- Storage
- Object Storage
- Object Storage 개요
- 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 지표
- Archive Storage
- NAS (VPC)
- NAS
- Object Storage
- Networking
- VPC
- VPC 개요
- 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 개요
- Load Balancer
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- setLoadBalancerDescription
- setLoadBalancerInstanceSubnet
- deleteLoadBalancerInstances
- getLoadBalancerInstanceDetail
- getLoadBalancerInstanceList
- createLoadBalancerListener
- changeLoadBalancerListenerConfiguration
- deleteLoadBalancerListeners
- getLoadBalancerListenerList
- getLoadBalancerRuleList
- addLoadBalancerListenerCertificate
- removeLoadBalancerListenerCertificate
- getLoadBalancerListenerCertificateList
- Target Group
- Load Balancer 지표
- Load Balancer
- Load Balancer 개요
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- changeLoadBalancedServerInstances
- deleteLoadBalancerInstances
- getLoadBalancerInstanceList
- getLoadBalancedServerInstanceList
- getLoadBalancerTargetServerInstanceList
- addLoadBalancerSslCertificate
- deleteLoadBalancerSslCertificate
- getLoadBalancerSslCertificateList
- Load Balancer 지표
- Global DNS
- Global Traffic Manager
- Traffic Profile
- Traffic Policy
- Traffic Policy 개요
- Traffic Policy 생성
- Traffic Policy 수정
- Traffic Policy 삭제
- Traffic Policy 조회
- Traffic Policy 상세 조회
- Traffic Policy Resource 상세 조회
- Traffic Policy Resource 수정
- Traffic Policy 특정 Resource 수정
- Traffic Policy Health Check 수정
- Traffic Policy Health Check 삭제
- Traffic Policy Resource 유형 조회
- Traffic Policy Health Check Region 조회
- Traffic Policy Load Balancer 유형 조회
- Geo and CIDR Map
- Monitoring
- VPC
- Database
- Cloud DB (Classic)
- CloudDB 개요
- createCloudDBInstance
- deleteCloudDBServerInstance
- getCloudDBInstanceList
- getCloudDBConfigGroupList
- getCloudDBImageProductList
- getCloudDBProductList
- rebootCloudDBServerInstance
- flushCloudDBInstance
- setObjectStorageInfo
- downloadDmsFile
- uploadDmsFile
- getObjectStorageBackupList
- getBackupList
- restoreDmsDatabase
- restoreDmsTransactionLog
- getDmsOperation
- getCloudDBBackupDetailList
- exportBackupToObjectStorage
- getDbServerLogList
- exportDbServerLogToObjectStorage
- Cloud DB for Redis 지표
- Cloud DB for PostgreSQL (VPC)
- Cloud DB for PostgreSQL (VPC) 개요
- 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) 지표
- Cloud DB for MySQL (VPC)
- Cloud DB for MySQL (VPC) 개요
- 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) 지표
- Cloud DB for Redis (VPC)
- Cloud DB for Redis (VPC) 개요
- 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) 지표
- Cloud DB for MSSQL (VPC)
- Cloud DB for MSSQL (VPC) 개요
- 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) 지표
- 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) 지표
- Cloud DB (Classic)
- Security
- Secure Zone
- Secure Zone 개요
- 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 개요
- Key Management Service API 1.0
- Key Management Service 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
- PrivateCA 개요
- 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 개요
- 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 Process Control
- Secure Zone
- AI Services
- AiTEMS
- CLOVA Chatbot
- CLOVA OCR
- NCLUE
- NCLUE 개요
- Feature 조회
- Feature 목록 조회
- Feature 생성
- Feature 삭제
- Task 조회
- Task 목록 조회
- Task 생성
- Task 삭제
- Task Run 조회
- Task Run 목록 조회
- Task Run 생성
- Task Run 삭제
- Shopping Intent 조회
- Shopping Intent 목록 조회
- Shopping Intent 생성
- Shopping Intent 삭제
- Shopping Intent 다운로드
- Custom Attributes 조회
- Custom Attributes 목록 조회
- Custom Attributes 생성
- 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 개요
- 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 릴리스 노트
- Cloud Outbound Mailer
- Cloud Outbound Mailer 개요
- 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) 개요
- 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) 지표
- Cloud Hadoop
- Cloud Search
- Cloud Search 개요
- Domain 목록 조회
- Domain 삭제
- Domain 생성
- Domain 수정
- Domain 조회
- Domain 중복 확인
- Ranking default 변경
- Ranking 목록 조회
- Ranking 삭제
- Ranking 생성
- Ranking 조회
- 자동 완성 설정 조회
- 임시 Domain 목록 조회
- 임시 Domain 삭제
- 임시 Domain 생성
- 임시 Domain 수정
- 임시 Domain 조회
- Schema 검증
- Schema 수정
- Schema 이력 조회
- Schema 조회
- Document 검색
- Document 관리
- Object Storage Document 관리
- Query Analysis Count
- Query Analysis Group By Count
- Query Analysis Time Series
- DB Connection 확인
- DB Connection 확인 (VPC)
- DB Table 매핑
- DB Table 매핑 (VPC)
- DB Table 조회
- DB Table 조회 (VPC)
- DB upload 실행
- DB upload 실행 (VPC)
- DB upload 조회
- 자동 완성 검색
- 자동 완성 설정 및 수정
- 자동 완성 설정 이력 조회
- Container 개수 변경
- Container 목록 조회
- Container 타입 변경
- Monitoring data 조회
- 불용어 정책 목록 조회
- 불용어 정책 삭제
- 불용어 정책 설정
- 불용어 정책 조회
- 형태소 분석 가능한 언어 조회
- 형태소 분석 옵션 조회 - 가능한 언어 목록
- 형태소 분석기 조회 - 특정 언어
- 동의어 사전 목록 조회
- 동의어 사전 버전 조회
- 동의어 사전 삭제
- 동의어 사전 설정
- 동의어 사전 수정
- 동의어 사전 이름 조회
- 동의어 사전 조회
- 동의어 사전 중복 확인
- 사용량 제한 변경
- 사용량 제한 조회
- Cloud Search 지표
- Search Engine Service (VPC)
- Search Engine Service 개요
- Cluster
- Search Engine Cluster 생성
- Search Engine Version 조회
- OS Product 조회
- Node Product 조회
- VPC 목록 조회
- Subnet 목록 조회
- Search Engine Cluster 삭제
- Search Engine Cluster 노드 추가
- Search Engine Cluster 재시작
- Search Engine User 패스워드 초기화
- Search Engine Cluster 목록 조회
- Search Engine Cluster 노드 조회
- Search Engine Cluster ACG 조회
- Search Engine Cluster 노드 그룹별 스펙 조회
- Search Engine Cluster 노드 그룹별 변경 가능 스펙 조회
- Search Engine Cluster 노드 스펙 변경
- Search Engine Cluster 노드 타입 변경
- 인증키 목록 조회
- Rolling Upgrade Pre Check
- Rolling Upgrade Cluster
- Rolling Upgrade 진행 상태 조회
- Dashboard
- Monitoring
- Snapshot
- Import
- Search Engine Service 지표
- Cloud Data Streaming Service (VPC)
- Cloud Data Streaming Service 개요
- Cluster
- Cluster Rolling 재시작 진행 상태 조회
- Cluster Rolling 재시작 요청
- Cluster Rolling 재시작 사전 체크
- Rolling UpGrade 진행 상태 조회
- Rolling UpGrade 요청
- Rolling UpGrade 사전 체크
- Cloud Data Streaming Service Cluster 생성
- Cloud Data Streaming Service Cluster 생성 (Return ID)
- Cloud Data Streaming Service Version 조회
- OS Product 조회
- Node Product 조회
- VPC 목록 조회
- Subnet 목록 조회
- Cloud Data Streaming Service Cluster 삭제
- Cloud Data Streaming Service Cluster 노드 추가
- 전체 서비스 재시작
- CMAK 재시작
- Kafka 재시작
- 노드별 Kafka 재시작
- CMAK 접속 패스워드 초기화
- Cloud Data Streaming Service Cluster 목록 조회
- Cloud Data Streaming Service Cluster 단건 조회
- Cloud Data Streaming Service Cluster 노드 조회
- Cloud Data Streaming Service Cluster ACG 조회
- 클러스터 상태 확인
- 브로커 노드 정보 확인
- 인증서 다운로드
- Public Domain 활성화
- Public Domain 비활성화
- 로드밸런서 목록 조회
- Broker 노드 Public Endpoint 활성화
- Broker 노드 Public Endpoint 비활성화
- 노드 그룹별 스펙 조회
- 노드 그룹별 변경 가능 스펙 조회
- 노드 스펙 변경
- Monitoring
- ConfigGroup
- Cloud Data Streaming Service 지표
- Data Forest
- Data Forest 개요
- 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 개요
- 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 개요
- Network 목록 조회
- Network 정보 조회
- Organization 목록 조회
- Organization 정보 조회
- Organization 연결 정보 다운로드
- Orderer 목록 조회
- Orderer 정보 조회
- Orderer 연결 정보 다운로드
- Orderer Pod 로그 조회
- Orderer Pod 사용량 조회
- Peer 목록 조회
- Peer 정보 조회
- Peer Pod 로그 조회
- Peer Pod 사용량 조회
- CA 목록 조회
- CA 정보 조회
- CA Identity 조회
- CA Identity 다운로드
- CA Pod 로그 조회
- CA Pod 사용량 조회
- Blockchain Service
- Business Applications
- Content Delivery
- Developer Tools
- SourceCommit
- SourceBuild
- SourceDeploy
- SourceDeploy 개요
- 프로젝트 목록
- 프로젝트 생성
- 프로젝트 삭제
- 스테이지 목록
- 스테이지 상세
- 스테이지 생성
- 스테이지 수정
- 스테이지 삭제
- 시나리오 목록
- 시나리오 상세
- 시나리오 생성
- 시나리오 수정
- 시나리오 삭제
- 배포 시작
- 배포 취소
- 배포 승인 요청
- 배포 승인
- 배포 거절
- Canary 배포 승인
- Canary 배포 거절
- 배포 이력 목록
- 배포 이력 상세
- Canary 분석 단계 목록 조회
- Canary 분석 리포트
- Server 목록
- AutoScalingGroup 목록 조회
- KubernetesService 클러스터 목록
- targetGroup 목록(VPC)
- SourceCommit 리파지토리 목록
- SourceCommit 브랜치 목록
- SourceBuild 목록
- ObjectStorage 버킷 목록
- ObjectStorage 오브젝트 목록
- SourcePipeline
- Digital Twin
- Gaming
- Hybrid & Private Cloud
- Management & Governance
- Cloud Log Analytics
- Sub Account
- SubAccount 개요
- 서브 계정
- 서브 계정 목록 조회
- 서브 계정 조회
- 서브 계정 생성
- 서브 계정 수정
- 서브 계정 삭제
- Access Key 조회
- Access Key 생성
- Access Key 삭제
- Access Key 상태 설정
- 로그인 접속키 조회
- 로그인 접속키 설정
- 로그인 아이디 체크
- 로그인 비밀번호 체크
- 유휴 세션 만료 시간 조회
- 유휴 세션 만료 시간 설정
- 로그인 비밀번호 만료일 조회
- 로그인 비밀번호 만료일 설정
- 로그인 비밀번호 재설정
- 정책 할당
- 정책 삭제
- 그룹 추가
- 그룹 삭제
- 콘솔 접근 규칙 조회
- 콘솔 접근 규칙 수정
- API 접근 규칙 조회
- API 접근 규칙 수정
- 2차 인증 정보 조회
- 태그 조회
- 태그 추가
- 태그 삭제
- 사용자 정보 조회
- 사용자 아이디 조회
- 그룹
- 정책
- 역할
- External Access
- Trust Anchor 목록 조회
- Trust Anchor 조회
- Trust Anchor 생성
- Trust Anchor 수정
- Trust Anchor 활성화
- Trust Anchor 비활성화
- Trust Anchor 삭제
- Profile 목록 조회
- Profile 조회
- Profile 생성
- Profile 수정
- Profile 활성화
- Profile 비활성화
- Proflie 삭제
- Subject 목록 조회
- Subject 조회
- Subject Activity 목록 조회
- CRL 목록 조회
- CRL 조회
- CRL 생성
- CRL 수정
- CRL 활성화
- CRL 비활성화
- CRL 삭제
- Secure Token Service
- Web service Monitoring System
- Effective Log Search & Analytics
- Network Traffic Monitoring
- Cloud Activity Tracer
- Resource Manager
- Cloud Insight
- Cloud Insight 개요
- 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 지표
- Ncloud Single Sign-On
- Ncloud Single Sign-On 개요
- Application
- Tenant
- External IdP
- SSO User
- SSO User 목록 조회
- SSO User 조회
- SSO User 생성
- SSO User 일괄 생성
- SSO User 수정
- SSO User 목록 삭제
- SSO User 삭제
- SSO User 로그인 아이디 체크
- SSO User 접근 규칙 조회
- SSO User 접근 규칙 수정
- SSO User Profile 조회
- SSO User 그룹 목록 조회
- SSO User 그룹 조회
- SSO User 그룹 추가
- SSO User 그룹 삭제
- SSO User 상태 설정
- SSO User 세션 조회
- SSO User 세션 만료
- SSO User Assignment 목록 조회
- SSO User Assignment 삭제
- SSO User MFA Device 조회
- SSO User MFA Device 추가
- SSO User MFA Device 삭제
- Group
- Permission Set
- Assignment
- IP ACL
- Cloud Advisor (VPC)
- Organization
- Media
- Live Station
- VOD Station
- Video Player Enhancement
- One Click Multi DRM
- B2B PRISM Live Studio
- Media Connect Center
- Migration
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
기본 정보
API URL
https://sens.apigw.ntruss.com/friendtalk/v2
HTTP
API Header
항목 | Mandatory | 설명 |
---|---|---|
Content-Type | Mandatory | 요청 Body Content Type을 application/json으로 지정 (POST) |
x-ncp-apigw-timestamp | Mandatory | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
x-ncp-iam-access-key | Mandatory | 포탈 또는 Sub Account에서 발급받은 Access Key ID |
x-ncp-apigw-signature-v2 | Mandatory | 위 예제의 Body를 Access Key Id와 맵핑되는 SecretKey로 암호화한 서명 HMAC 암호화 알고리즘은 HmacSHA256 사용 |
NAVER CLOUD PLATFORM 인증키 및 Signature 생성 가이드 바로가기
메시지
메시지 발송
메시지를 발송합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
Headers
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
plusFriendId | Mandatory | String | 카카오톡 채널명 ((구)플러스친구 아이디) | |
messages | Mandatory | Object | 메시지 정보 | 아래 항목들 참조 (messages.XXX) 최대 100개 |
messages.isAd | Optional | Boolean | 광고 메시지 여부 | default: true 광고 메시지로 발송하시는 경우(isAd: true), SMS Failover 동작 시 광고 메시지 전송 표기 의무를 준수해야합니다. |
messages.countryCode | Optional | String | 수신자 국가번호 | default: 82 |
messages.to | Mandatory | String | 수신자번호 | |
messages.content | Mandatory | String | 친구톡 메시지 내용 | |
messages.buttons | Optional | Array of Object | 친구톡 메시지 버튼 | 버튼 정보 참조 |
messages.buttons.type | Mandatory | String | 버튼 Type | 아래 템플릿 버튼 정보 참조 |
messages.buttons.name | Mandatory | String | 버튼명 | 아래 템플릿 버튼 정보 참조 |
messages.image | Optional | Object | 이미지 정보 | 이미지 업로드 참조 |
messages.image.imageId | Mandatory | String | 업로드된 이미지 아이디 | |
messages.image.imageLink | Mandatory | String | 이미지 링크 | |
messages.useSmsFailover | Optional | Boolean | SMS Failover 사용 여부 | Failover가 설정된 카카오톡 채널에서만 사용 가능 기본: 카카오톡 채널의 Failover 설정 여부를 따름 |
messages.failoverConfig | Optional | Object | Failover 설정 | 아래 항목들 참조 |
messages.failoverConfig.type | Optional | String | Failover SMS 메시지 Type | SMS or LMS 기본: content 길이에 따라 자동 적용 (90 bytes 이하 SMS, 초과 LMS) |
messages.failoverConfig.from | Optional | String | Failover SMS 발신번호 | 기본: Failover 설정 시 선택한 발신번호 승인되지 않은 발신번호 사용시, Failover 동작 안함 |
messages.failoverConfig.subject | Optional | String | Failover SMS 제목 | LMS type으로 동작할 때 사용 기본: 카카오톡 채널명 |
messages.failoverConfig.content | Optional | String | Failover SMS 내용 | 기본: 친구톡 메시지 내용 (버튼 제외) |
reserveTime | Optional | String | 예약 일시 | 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm) |
reserveTimeZone | Optional | String | 예약 일시 타임존 | 예약 일시 타임존 (기본: Asia/Seoul) * 지원 타임존 목록 * TZ database name 값 사용 |
- 요청 Body의 Mandatory 필드를 사용하시는 경우, 공백은 허용되지않습니다. (추가하는 경우에만 해당)
- SMS Failover는 비즈메시지 수신 결과 코드 기준, 성공이 아닌 경우 동작하며, prefix로 B가 붙은 코드들에 대해서는 failover 기능을 통한 SMS 대체 발송이 이루어지지 않습니다.
Status | Error text | Desc |
---|---|---|
0000 | - | 정상 발송 |
3022 | NoSendAvailableTimeException | 메시지 발송 가능한 시간이 아님 (친구 톡/마케팅 메시지는 08시~ 20시 50분까지 발송 가능) |
Bxxx | 하단 비즈메시지 수신 결과 코드 참고 | 하단 비즈메시지 수신 결과 코드 참고 |
- 광고 메시지 발송 시 SMS Failover에 설정된 SMS 서비스의 080수신거부 서비스를 사용합니다.
- 설정된 SMS 서비스에 080수신거부 서비스가 사용 가능한 상태가 아니라면, SMS Failover는 실패합니다.
failoverConfig.content
를 별도로 지정하지 않고 사용하시는 경우, SMS Failover시 자동으로 광고 표기 문구를 삽입합니다.[광고]{메시지내용} 무료수신거부번호08012345678
Plain textfailoverConfig.content
를 별도로 직접 지정하시는 경우, 광고 표기 문구를 삽입하지 않습니다. 광고 메시지 발송 시 직접 추가해 주십시오.- 광고 표기 의무를 준수하지 않은 SMS 메시지 발송 시, 추후 소명이 필요할 수 있습니다.
- 와이드 이미지 발송 시, 텍스트 + 링크 버튼(1개) + 이미지 발송이 가능합니다.
- 2개 이상의 버튼 추가시, 메시지 발송에 실패합니다. (잘못된 파라미터 요청)
- 텍스트 문구는 76자로 제한됩니다.
버튼 정보
Type | Name | Mandatory 항목 |
---|---|---|
WL | 웹 링크 | linkMobile, linkPc (http:// 또는 https://로 시작하는 URL) |
AL | 앱 링크 | schemeIos, schemeAndroid |
BK | 봇 키워드 | |
MD | 메시지 전달 | |
AC | 채널 추가 |
응답 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
requestId | Mandatory | String | 발송 요청 아이디 | |
requestTime | Mandatory | DateTime | 발송 요청 시간 | yyyy-MM-dd'T'HH:mm:ss.SSS |
statusCode | Mandatory | String | 요청 상태 코드 | 202 - 성공 그외 - 실패 * HTTP Status 규격을 따름 |
statusName | Mandatory | String | 요청 상태명 | success - 성공 processing - 처리중 reserved - 예약중 fail - 실패 |
messages.messageId | Mandatory | String | 메시지 아이디 | |
messages.countryCode | Optional | String | 수신자 국가번호 | default: 82 |
messages.to | Mandatory | String | 수신자번호 | |
messages.content | Mandatory | String | 친구톡 메시지 내용 | |
messages.requestStatusCode | Mandatory | String | 발송요청 상태 코드 | A000 - 성공 그외 코드 - 실패(Desc 항목에 실패 사유가 명시) |
messages.requestStatusName | Mandatory | String | 발송요청 상태명 | success - 성공 fail - 실패 |
messages.requestStatusDesc | Mandatory | String | 발송요청 상태 내용 | |
messages.useSmsFailover | Mandatory | Boolean | SMS Failover 사용 여부 |
응답 Status
HTTP Status | Desc |
---|---|
202 | Accepted (발송 요청 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
메시지 발송 요청 조회
메시지 발송 요청을 조회합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
Parameters
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
requestId | Mandatory | String | 요청 아이디 | 발송 요청 아이디 |
plusFriendId | Mandatory | String | 카카오 채널 | 등록된 채널 명 |
requestStartTime | Mandatory | String | 조회 시간 시작 시각 | yyyy-MM-dd'T'HH:mm:ss |
requestEndTime | Mandatory | String | 조회 시간 종료 시각 | yyyy-MM-dd'T'HH:mm:ss |
completeStartTime | Mandatory | String | 발송 완료 시작 시간 | yyyy-MM-dd'T'HH:mm:ss |
completeEndTime | Mandatory | String | 발송 완료 종료 시간 | yyyy-MM-dd'T'HH:mm:ss |
messageId | Optional | String | 메시지 아이디 | |
requestStatusName | Optional | String | 요청 상태 | success, fail |
messageStatusName | Optional | String | 요청 상태 | success, processing, fail |
to | Optional | String | 메세지 수신 번호 | 붙임표 (-)를 제외한 번호 |
pageIndex | Optional | Integer | 페이지 번호 | default: 0 |
pageSize | Optional | Integer | 페이지 크기 | default: 20, max: 100 requestId를 포함한 조회시, default: 100 |
참고
- 메시지 발송 이력은 최근 30일 이내의 이력만 조회할 수 있습니다.
- requestId 또는 requestStartTime + requestEndTime 또는 completeStartTime + completeEndTime 중에 하나는 필수입니다.
- requestStartTime + requestEndTime과 completeStartTime + completeEndTime은 동시에 사용할 수 없습니다.
- requestStartTime ~ requestEndTime의 조회 범위는 최대 31일로 제한됩니다.
- completeStartTime ~ completeEndTime의 조회 범위는 최대 24시간으로 제한됩니다.
- 조회 조건에 requestId가 포함되어있지않은 경우, plusFriendId는 필수입니다.
Headers
요청 Body
없음
JSON
응답 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
requestId | Optional | String | 발송 요청 아이디 | requestId로 조회하는 경우에만 노출됨 |
statusCode | Mandatory | String | 요청 상태 코드 | 202 - 성공 그외 - 실패 * HTTP Status 규격을 따름 |
statusName | Mandatory | String | 요청 상태명 | success - 성공 processing - 발송중 reserved - 예약중 fail - 실패 |
messages.requestTime | Mandatory | DateTime | 발송 요청 시간 | yyyy-MM-dd'T'HH:mm:ss.SSS |
messages.messageId | Mandatory | String | 메시지 아이디 | |
messages.countryCode | Optional | String | 수신자 국가번호 | default: 82 |
messages.to | Mandatory | String | 수신자번호 | |
messages.content | Mandatory | String | 친구톡 메시지 내용 | |
messages.plusFriendId | Mandatory | String | 카카오톡 채널명 ((구)플러스친구 아이디) | |
messages.completeTime | Optional | DateTime | 발송 리포트(처리 완료) 시간 | yyyy-MM-dd'T'HH:mm:ss |
messages.requestStatusCode | Mandatory | String | 발송요청 상태 코드 | A000 - 성공 그외 코드 - 실패(Desc 항목에 실패 사유가 명시) |
messages.requestStatusName | Mandatory | String | 발송요청 상태명 | success - 성공 fail - 실패 |
messages.requestStatusDesc | Mandatory | String | 발송요청 상태 내용 | |
messages.messageStatusCode | Mandatory | String | 발송결과 상태 코드 | 0000 - 성공 그외 코드 - 실패(Desc 항목에 실패 사유가 명시) |
messages.messageStatusName | Mandatory | String | 발송결과 상태명 | success - 성공 processing - 처리중 * 발송요청 성공 후, 메시지 발송서버에서 처리중인 상태 * messageCode, messageDesc가 조회되지 않음 fail - 실패 |
messages.messageStatusDesc | Mandatory | String | 발송결과 상태 내용 | |
messages.isWide | Mandatory | Boolean | 와이드 여부 | |
messages.isAd | Mandatory | Boolean | 광고메시지 여부 | |
messages.useSmsFailover | Mandatory | Boolean | SMS Failover 사용 여부 | |
messages.failover | Optional | Object | SMS Failover | |
messages.failover.smsServiceId | Optional | String | SMS Failover 서비스 아이디 | |
messages.failover.requestId | Optional | String | SMS Failover 발송 요청 아이디 | |
messages.failover.messageId | Optional | String | SMS Failover 발송 메시지 아이디 | |
messages.failover.requestStatusCode | Optional | String | SMS Failover 발송 요청 상태 코드 | 오류 코드 표 참고 |
messages.failover.requestStatusName | Optional | String | SMS Failover 발송 요청 상태명 | success - 성공 fail - 실패 |
messages.failover.requestStatusDesc | Optional | String | SMS Failover 발송 요청 상태 내용 | |
messages.failover.messageStatus | Optional | String | SMS Failover 발송 처리 상태 | READY: 대기 PROCESSING: 처리 중 COMPLETED: 처리 완료 |
messages.failover.messageStatusCode | Optional | String | SMS Failover 발송 단말 수신 상태 결과 코드 | 오류 코드 표 참고 |
messages.failover.messageStatusName | Optional | String | SMS Failover 발송 단말 수신 결과명 | |
messages.failover.messageStatusDesc | Optional | String | SMS Failover 발송 단말 수신 내용 | |
pageSize | Mandatory | Integer | 페이지 사이즈 | |
pageIndex | Mandatory | Integer | 페이지 인덱스 (0부터 시작) | |
itemCount | Mandatory | Integer | 조회한 페이지 내의 메시지 수 | |
hasMore | Mandatory | Boolean | 다음 페이지 존재 여부 |
응답 Status
HTTP Status | Desc |
---|---|
200 | OK (조회 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
메시지 발송 결과 조회
메시지 발송 결과를 조회합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
messageId | Mandatory | String | 메시지 아이디 | 메시지 발송시 반환되는 메시지 식별자 |
Headers
요청 Body
없음
JSON
응답 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
messageId | Mandatory | String | 메시지 아이디 | |
requestId | Mandatory | String | 발송 요청 아이디 | |
requestTime | Mandatory | DateTime | 발송 요청 시간 | yyyy-MM-dd'T'HH:mm:ss.SSS |
completeTime | Optional | DateTime | 발송 리포트(처리 완료) 시간 | yyyy-MM-dd'T'HH:mm:ss |
plusFriendId | Mandatory | String | 카카오톡 채널명 ((구)플러스친구 아이디) | |
templateCode | Mandatory | String | 템플릿 코드 | |
countryCode | Optional | String | 수신자 국가번호 | default: 82 |
to | Mandatory | String | 수신자번호 | |
content | Mandatory | String | 친구톡 메시지 내용 | |
requestStatusCode | Mandatory | String | 발송요청 상태 코드 | A000 - 성공 그외 코드 - 실패(Desc 항목에 실패 사유가 명시) |
requestStatusName | Mandatory | String | 발송요청 상태명 | success - 성공 fail - 실패 |
requestStatusDesc | Mandatory | String | 발송요청 상태 내용 | |
messageStatusCode | Mandatory | String | 발송결과 상태 코드 | 0000 - 성공 그외 코드 - 실패(Desc 항목에 실패 사유가 명시) |
messageStatusName | Mandatory | String | 발송결과 상태명 | success - 성공 processing - 처리중 * 발송요청 성공 후, 메시지 발송서버에서 처리중인 상태 * messageCode, messageDesc가 조회되지 않음 fail - 실패 |
messageStatusDesc | Mandatory | String | 발송결과 상태 내용 | |
isWide | Mandatory | Boolean | 와이드 여부 | |
isAd | Mandatory | Boolean | 광고메시지 여부 | |
imageId | Optional | String | 이미지 아이디 | |
imageName | Optional | String | 이미지 이름 | |
imageUrl | Optional | String | 이미지 URL | |
imageLink | Optional | String | 이미지 링크 | |
useSmsFailover | Mandatory | Boolean | SMS Failover 사용 여부 | |
failover | Optional | Object | SMS Failover 사용 여부 | |
failover.smsServiceId | Optional | String | SMS Failover 서비스 아이디 | |
failover.requestId | Optional | String | SMS Failover 발송 요청 아이디 | |
failover.requestStatusCode | Optional | String | SMS Failover 발송 요청 상태 코드 | 오류 코드 표 참고 |
failover.requestStatusName | Optional | String | SMS Failover 발송 요청 상태명 | success - 성공 fail - 실패 |
failover.requestStatusDesc | Optional | String | SMS Failover 발송 요청 상태 내용 | |
failover.messageId | Optional | String | SMS Failover 발송 메시지 아이디 | |
failover.messageStatus | Optional | String | SMS Failover 발송 처리 상태 | READY: 대기 PROCESSING: 처리 중 COMPLETED: 처리 완료 |
failover.messageStatusCode | Optional | String | SMS Failover 발송 단말 수신 상태 결과 코드 | 오류 코드 표 참고 |
failover.messageStatusName | Optional | String | SMS Failover 발송 단말 수신 결과명 | |
failover.messageStatusDesc | Optional | String | SMS Failover 발송 단말 수신 내용 |
Failover 요청 상태 코드
requestStatusCode | Desc |
---|---|
0 | 성공 |
E4000 | failover 설정이 유효하지 않음 |
E4001 | failover 설정 정보가 누락됨 |
E4002 | failover SMS 서비스가 설정되지 않음 |
E4003 | failover SMS type(SMS, LMS)이 설정되지 않음 |
E4004 | failover SMS 발신번호가 설정되지 않음 |
E4005 | failover SMS 제목이 설정되지 않음 |
E4006 | failover SMS 내용이 설정되지 않음 |
E4007 | failover SMS 수신번호가 설정되지 않음 |
E4008 | failover SMS 서비스가 사용 가능한 상태가 아님 |
E4009 | failover SMS 발신번호가 인증되지 않음 |
E4010 | failover SMS 080무료수신거부 서비스가 사용 가능한 상태가 아님 |
E4999 | failover 설정 파싱 오류 (고객 지원으로 문의 필요) |
E5000 | 내부 오류 (고객 지원으로 문의 필요) |
응답 Status
HTTP Status | Desc |
---|---|
200 | OK (조회 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
예약 메시지
예약 메시지 상태 조회
메시지 발송 예약 상태를 조회합니다.
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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
reserveId | Mandatory | String | 예약 메시지 아이디 | 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId) |
Headers
요청 Body
없음
JSON
응답 Body
{
"reserveId": "string",
"reserveTimeZone": "string",
"reserveTime": "string",
"reserveStatus": "string"
}
JSON
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
reserveId | Mandatory | String | 예약 메시지 아이디 | 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId) |
reserveTime | Mandatory | String | 예약 일시 | 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm) |
reserveTimeZone | Mandatory | String | 예약 일시 타임존 | 예약 일시 타임존 (기본: Asia/Seoul) * 지원 타임존 목록 * TZ database name 값 사용 |
reserveStatus | Mandatory | String | 예약 상태 | READY - 발송 대기 PROCESSING - 발송 요청중 CANCELED - 발송 취소 FAIL - 발송 요청 실패 DONE - 발송 요청 성공 STALE - 발송 요청 실패 (시간 초과) |
응답 Status
HTTP Status | Desc |
---|---|
200 | OK (조회 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
예약 메시지 취소
메시지 발송 예약을 취소합니다.
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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
reserveId | Mandatory | String | 예약 메시지 아이디 | 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId) |
Headers
요청 Body
없음
JSON
응답 Body
없음
JSON
응답 Status
HTTP Status | Desc |
---|---|
204 | No Content (삭제 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
카카오톡 채널
채널 조회
카카오톡 채널을 조회합니다.
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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
Parameters
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
pageSize | Optional | Integer | 페이지 사이즈 | default: 100 (1 ~ 100 사이의 숫자만 입력 가능) |
pageIndex | Optional | Integer | 페이지 인덱스 | default: 0 |
Headers
요청 Body
없음
JSON
응답 Body
[
{
"createTime": "string",
"updateTime": "string",
"serviceId": "string",
"channelId": "string",
"channelName": "string",
"channelStatus": "string",
"useSmsFailover": "boolean"
}
]
JSON
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
createTime | Mandatory | String | 생성 시간 | format: LocalDateTime |
updateTime | Optional | String | 수정 시간 | format: LocalDateTime |
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
channelId | Mandatory | String | 카카오톡 채널 아이디 | |
channelName | Mandatory | String | 카카오톡 채널 이름 | |
channelStatus | Mandatory | String | 카카오톡 채널 상태 | - 정상: ACTIVE - 삭제: DELETED - 영구 삭제 중: DELETING_PERMANENTLY - 영구 삭제: PERMANENTLY_DELETED - 차단: BLOCKED - 삭제 지연 중: PENDING_DELETE |
useSmsFailover | Mandatory | Boolean | SMS 대체 발송 사용 여부 |
응답 Status
HTTP Status | Desc |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
500 | Internal Server Error |
이미지
이미지 업로드
친구톡 발송에 사용할 이미지를 업로드합니다.
이미지는 1년간 보관하며, 그 이후에는 자동 삭제되어 사용하실 수 없습니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
Headers
요청 Parameter
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
plusFriendId | Mandatory | String | 카카오톡 채널명 ((구)플러스친구 아이디) | |
imageFile | Mandatory | File | 이미지 파일 | - 공통 * jpg, png 만 가능 * 500KB 이하 - 일반 * 권장 사이즈 : 720px x 720px * 가로 500px 이상, 가로 * 세로 비율 2:1 이상 3:4 이하 만 업로드 가능 - 와이드 * 제한 사이즈 : 800px x 600px * 가로 * 세로 비율 4:3 만 업로드 가능 |
isWide | Optional | Boolean | 와이드 이미지 여부 | 와이드 이미지 업로드시, 와이드 친구톡 메시지로 발송됨 * defealt: false |
응답 Body
{
"imageId":"string",
"imageName":"string",
"imageUrl":"string",
"isWide":"boolean",
"createTime":"string"
}
JSON
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
imageId | Mandatory | Strng | 이미지 아이디 | |
imageName | Mandatory | String | 이미지 파일 이름 | |
imageUrl | Mandatory | String | 이미지 URL | |
isWide | Mandatory | Boolean | 와이드 여부 | |
createTime | Mandatory | DateTime | 이미지 업로드 시간 |
응답 Status
HTTP Status | Desc |
---|---|
200 | Ok (업로드 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
이미지 목록 조회
업로드된 이미지 목록을 조회합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
Headers
Parameters
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
pageIndex | Optional | Integer | 페이지 인덱스 | default: 0 |
pageSize | Optional | Integer | 페이지 사이즈 | default: 20 (1 ~ 100 사이의 숫자만 입력 가능) |
요청 Body
없음
JSON
응답 Body
{
"items": [
{
"imageId": "string",
"imageName": "string",
"imageUrl": "string",
"isWide": "boolean",
"createTime": "string"
}
],
"pageIndex": "integer",
"pageSize": "integer",
"itemCount": "integer",
"totalCount": "integer"
}
JSON
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
items | Mandatory | Array of Object | 이미지 데이터 목록 | 이미지 데이터 참조 |
pageIndex | Mandatory | Integer | 페이지 인덱스 | |
pageSize | Mandatory | Integer | 페이지 사이즈 | |
itemCount | Mandatory | Integer | 조회된 아이템 개수 | |
totalCount | Mandatory | Integer | 전체 개수 |
응답 Status
HTTP Status | Desc |
---|---|
200 | Ok (조회 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
이미지 단건 조회
업로드된 이미지를 단건 조회합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
imageId | Mandatory | String | 이미지 아이디 | 업로드된 이미지 아이디 |
Headers
요청 Body
없음
JSON
응답 Body
{
"imageId":"string",
"imageName":"string",
"imageUrl":"string",
"isWide":"boolean",
"createTime":"string"
}
JSON
이미지 데이터
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
imageId | Mandatory | Strng | 이미지 아이디 | |
imageName | Mandatory | String | 이미지 파일 이름 | |
imageUrl | Mandatory | String | 이미지 URL | |
isWide | Mandatory | Boolean | 와이드 여부 | |
createTime | Mandatory | DateTime | 이미지 업로드 시간 |
응답 Status
HTTP Status | Desc |
---|---|
200 | Ok (조회 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
이미지 삭제
업로드된 이미지를 삭제합니다.
요청 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
항목 | Mandatory | Type | 설명 | 비고 |
---|---|---|---|---|
serviceId | Mandatory | String | 서비스 아이디 | 프로젝트 등록 시 발급받은 서비스 아이디 |
imageId | Mandatory | String | 이미지 아이디 | 업로드된 이미지 아이디 |
Headers
요청 Body
없음
JSON
응답 Body
없음
JSON
응답 Status
HTTP Status | Desc |
---|---|
204 | No Content (삭제 완료) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
오류 코드
비즈메시지 수신 결과 코드
Status | Error text | Desc |
---|---|---|
0000 | - | 정상 발송 |
1001 | NoJsonBody | Request Body가 Json형식이 아님 |
1002 | InvalidHubPartnerKey | 파트너 키가 유효하지 않음 |
1003 | InvalidSenderKey | 발신 프로필 키가 유효하지 않음 |
1004 | NoValueJsonElement | Request BODY(Json)에서 name을 찾을 수 없음 |
1005 | SenderNotFound | 발신 프로필을 찾을 수 없음 |
1006 | DeletedSender | 삭제된 발신 프로필 |
1007 | StoppedSender | 차단 상태의 발신 프로필 |
1011 | ContractNotFound | 계약 정보를 찾을 수 없음 |
1012 | InvalidUserKeyException | 잘못된 형식의 유저 키 요청 |
1013 | InvalidAppLink | 유효하지 않은 app연결 |
1014 | InvalidBizNum | 유효하지 않은 사업자번호 |
1015 | TalkUserIdNotFonud | 유효하지 않은 app user id 요청 |
1016 | BizNumNotEqual | 사업자등록번호 불일치 |
1020 | InvalidReceiveUserException | 올바른 유저 식별자 값이 하나도 없는 경우 |
1021 | BlockedProfile | 차단 상태의 카카오톡 채널 (카카오톡 채널 운영툴에서 확인) |
1022 | DeactivatedProfile | 닫힘 상태의 카카오톡 채널 (카카오톡 채널 운영툴에서 확인) |
1023 | DeletedProfile | 삭제된 카카오톡 채널 (카카오톡 채널 운영툴에서 확인) |
1024 | DeletingProfile | 삭제 대기 상태의 카카오톡 채널 (카카오톡 채널 운영툴에서 확인) |
1025 | SpammedProfile | 메시지 차단 상태의 카카오톡 채널 (카카오톡 채널 운영툴에서 확인) |
1026 | UnableUseMessageType | 해당 msg_type에서 사용할 수 없는 response_method 로 요청 (이미지 알림톡(AI)은 실시간으로 발송 불가) |
1027 | - | 채널 메시지 제재 상태로 인한 메시지 전송 실패 |
1030 | InvalidParameterException | 잘못된 파라메터 요청 |
1033 | - | 템플릿 타입과 메시지 타입 불일치 |
2000 | FailedToCheckFriendshipException | 톡채널과 친구 관계 확인 시 에러 (시스템 에러) |
2003 | FailedToSendMessageByNoFriendshipException | 메시지 전송 실패 (테스트 서버에서 카카오톡 채널을 추가하지 않은 경우) |
2004 | FailedToMatchTemplateException | 템플릿 일치 확인 시 오류 발생 (카카오 내부 오류) |
2005 | FailedToReadImageException | 카카오에서 이미지 메타 정보 읽어오는 중 에러 |
2006 | FailedToMatchSerialNumberPrefixPattern | 시리얼넘버 형식 불일치 |
3000 | UnexceptedExcetpion | 예기치 않은 오류 발생 |
3005 | AckTimeoutException | 메시지를 발송 했으나 수신확인 안 됨 (성공 불확실) |
3006 | FailedToSendMessageException | 카카오 내부 시스템 오류로 메시지 전송 실패 |
3008 | InvalidPhoneNumberException | 전화번호 오류 |
3010 | JsonParsseExcetpion | Json 파싱 오류 |
3011 | MessageNotFoundException | 메시지가 존재하지 않음 |
3012 | SerialNumberDuplicatedException | 메시지 일련번호가 중복됨 (메시지 일련 번호는 고유의 값이 부여되어야 함) |
3013 | MessageEmptyException | 빈 메시지 |
3014 | MessageLengthOverLimitException | 메시지 길이 제한 오류 (텍스트 타입 1000자 초과, 이미지 타입 400자 초과) |
3015 | TemplateNotFoundException | 템플릿을 찾을 수 없음 |
3016 | NoMatchedTemplateException | 메시지 내용이 템플릿과 일치하지 않음 |
3018 | NoSendAvailableException | 메시지를 전송할 수 없음 |
3019 | MessageNoUserException | 톡유저가 아님 |
3020 | MessageUserBlockedAlimTalkException | 알림톡 차단 |
3021 | MessageNotSupportedKakaotalkException | 톡 최소 버전 미지원 |
3022 | NoSendAvailableTimeException | 메시지 발송 가능한 시간이 아님 (친구 톡/마케팅 메시지는 08시~ 20시까지 발송 가능) |
3023 | MessageInvalidVideoException | 메시지에 포함된 비디오를 전송할 수 없음 (비디오 주소 또는 썸네일 이미지 주소가 올바르지 않거나 썸네일 이미지가 규격에 맞지 않음) |
3024 | MessageInvaildImageException | 메시지에 포함된 이미지를 전송할 수 없음 |
3025 | ExceedMaxVariableLengthException | 변수 글자 수 제한 초과 |
3026 | Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})' | 상담/봇 전환 버튼 extra, event 글자수 제한 초과 |
3027 | NoMatchedTemplateButtonException | 버튼 내용이 템플릿과 일치 하지 않음 |
3028 | NoMatchedTemplateTitleException | 메시지 강조 표기 타이틀이 템플릿과 일치하지 않음 |
3029 | ExceedMaxTitleLengthException | 메시지 강조 표기 타이틀 길이 제한 초과 (50자) |
- | ||
3030 | NoMatchedTemplateWithMessageTypeException | 메시지 타입과 템플릿 강조유형이 일치하지 않음 |
3031 | NoMatchedTemplateHeaderException | 헤더가 템플릿과 일치하지 않음 |
3032 | ExceedMaxHeaderLengthException | 헤더 길이 제한 초과(16 자) |
3033 | NoMatchedTemplateItemHighlightException | 아이템 하이라이트가 템플릿과 일치하지 않음 |
3034 | ExceedMaxItemHighlightTitleLengthException | 아이템 하이라이트 타이틀 길이 제한 초과 (이미지 없는 경우 30 자, 이미지 있는 경우 21 자) |
3035 | ExceedMaxItemHighlightDescriptionLengthException | 아이템 하이라이트 디스크립션 길이 제한 초과 (이미지 없는 경우 19 자, 이미지 있는 경우 14 자) |
3036 | NoMatchedTemplateItemListException | 아이템 리스트가 템플릿과 일치하지 않음 |
3037 | ExceedMaxItemDescriptionLengthException | 아이템 리스트의 아이템의 디스크립션 길이 제한 초과(23 자) |
3038 | NoMatchedTemplateItemSummaryException | 아이템 요약 정보가 템플릿과 일치하지 않음 |
3039 | ExceedMaxItemSummaryDescriptionLengthException | 아이템 요약정보의 디스크립션 길이 제한 초과(14 자) |
3040 | InvalidItemSummaryDescriptionException | 아이템 요약 정보의 디스크립션에 허용되지 않은 문자 포함(통화기호/코드, 숫자, 콤마, 소수점, 공백을 제외한 문자 포함) |
3041 | MessageInvalidWideItemListLengthException | 와이드 아이템 리스트 개수 최소, 최대 개수 불일치 |
3042 | NoMatchedTemplateRepresentLinkException | 대표 링크가 템플릿과 일치하지 않음 |
3046 | ExceedMaxAdditionalContentLengthException | 부가 정보 최대 길이 제한 오류 |
3047 | ExceedMaxCommerceTitleLengthException | 커머스 정보 상품명 최대 길이 제한 오류 |
3050 | MessageNotSupportedUnsubscribeException | 수신 동의 거부 스펙 (N 타입) 미지원 |
3051 | InvalidateCarouselItemMinException or InvalidateCarouselItemMaxException | 캐러셀 아이템 리스트 개수 최소, 최대 개수 불일치 |
3052 | CarouselMessageLengthOverLimitException | 캐러셀 아이템 메시지 길이 초과 |
3056 | WideItemListTitleLengthOverLimitException | 와이드 아이템 리스트 타이틀 길이 제한 오류 |
3058 | CarouselHeaderLengthOverLimitException | 캐러셀 헤더 길이 제한 오류 |
3059 | MessageNotSupportedCouponException | 쿠폰 스펙 미지원 |
4000 | ResponseHistoryNotFoundException | 메시지 전송 결과를 찾을 수 없음 |
4001 | UnKnownMessageStatusError | 알수 없는 메시지 상태 |
7011 | - | 시리얼 넘버 패턴 에러 |
7014 | - | 메시지 유효 시간 초과 에러 |
8512 | - | 수신자 타입 찾을 수 없음 |
8514 | - | request_id 찾을 수 없음 |
8520 | - | 지원하지 않는 상품 타입 오류 |
8521 | - | 지원하지 않는 메시지 타입 오류 |
8522 | - | 지원하지 않는 텍스트 유형 오류 |
8523 | - | 지원하지 않는 response method 오류 |
8530 | - | 수신자 목록 사이즈 오류 |
8999 | - | 내부 서버 오류 |
9998 | 현재 서비스를 제공하고 있지 않습니다. | 시스템에 문제가 발생하여 담당자 확인 중 |
9999 | 시스템에 알 수 없는 문제 발생, 담당자 확인 중 | 시스템에 문제가 발생하여 담당자 확인 중 |
B000 | Prepare to relay failed | 중계사 발송을 위한 사전 작업 실패 |
B001 | Request to relay failed | 중계사 발송 실패 |
B002 | Filtering for request to relay failed | 잘못된 요청으로 인해 필터링됨 |
B003 | Invalid phone number format | 올바르지 않은 발신번호 포멧 |
B004 | Quota Exceed | 쿼터 초과 |
B005 | Message processing timeout exceed | 메시지 요청 시간과 처리 시간의 차이가 허용 범위를 벗어남 |
B400 | Invalid Request | 메시지 형식 오류 |
B999 | Unexpected server error | 예기치 못한 에러 |
이 문서가 도움이 되었습니까?
의견을 보내 주셔서 감사합니다! 우리 팀이 당신에게 돌아갈 것입니다.
이 기사를 어떻게 개선 할 수 있습니까?
귀하의 의견
주석
주석 (선택적)
문자 제한 : 500
의견을 입력하십시오.
이메일 (선택적)
이메일
유효한 이메일을 입력하십시오.