채널 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

친구톡 채널의 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /friendtalk/v2/services/{serviceId}/channels

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
serviceId String Required Biz Message 서비스 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://sens.apigw.ntruss.com/friendtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/channels' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
createTime String - 채널 생성 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
updateTime String - 채널 수정 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
serviceId String - Biz Message 서비스 아이디
channelId String - 채널 아이디
channelName String - 채널 이름
channelStatus String - 채널 상태
  • ACTIVE | DELETED | DELETING_PERMANETLY | PERMANENTLY_DELETED | BLOCKED | PENDING_DELETE
    • ACTIVE: 정상
    • DELETED: 삭제
    • DELETING_PERMANETLY: 영구 삭제 중
    • PERMANENTLY_DELETED: 영구 삭제
    • BLOCKED: 차단
    • PENDING_DELETE: 삭제 지연 중
useSmsFailover Boolean - SMS 대체 발송 설정 여부
  • true | false
    • true: 설정
    • false: 설정 안 함
failoverServiceId String - 대체 발송에 사용된 SMS 서비스 아이디
failoverTelNo String - 발신 번호
isBlock Boolean - 채널 차단 여부
isDormant Boolean - 채널 휴면 여부

응답 상태 코드

Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

[
    {
        "createTime": "2025-11-25T09:53:21.365",
        "updateTime": "2025-11-25T09:58:23.200",
        "serviceId": "ncp:kkobizmsg:kr:27*********6:sens",
        "channelId": "@******",
        "channelName": "******",
        "channelStatus": "ACTIVE",
        "useSmsFailover": true,
        "failoverServiceId": "ncp:sms:kr:27*********6:sens",
        "failoverTelNo": "010********",
        "isBlock": false,
        "isDormant": false
    }
]