Viber

글로벌 메신저 Viber기반 API입니다.

API PLEX 고객센터로 연락하여 브랜드 별sender 등록이 되어 있어야 합니다.

수신 받는 유저의 기기에 Viber 앱을 설치해야 메세지 수신이 가능합니다.

아래 모든 API의 캐릭터 인코딩은 UTF-8을 기본으로 합니다.

Viber 텍스트 발송 API

Viber 텍스트 발송 API

POST https://4vh6qtie3c.apigw.ntruss.com/viber-text/v1/send

Headers

Name	Type	Description
Content-Type*	string	application/json;charset=utf-8
Authorization*	string	사용자ID;secret_key

Request Body

Name	Type	Description
messages*	object array	메시지 본문 내용
content*	object	보낼 메시지를 작성하기 위한 콘텐츠
messageId*	string	보낸 메시지를 고유하게 식별하는 ID
to*	string	메시지 수신자 번호 (국제 형식이어야 합니다)
from*	string	viber에 등록한 발신자 번호 (국제 형식이어야 하며, viber의 요구 사항 을 준수해야 합니다)
text*	string	메시지 본문

Request Body 예시

{
    "from": "447860099299",
    "to": "821012341234",
    "messageId": "a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
    "content": {
        "text": "Some text"
    }
}

Response Body 예시

성공

{
    "messages": [
        {
            "to": "821012341234",
            "messageId": "7c1ef5d2-54be-4116-b6cf-5d96b0b5fb19",
            "status": {
                "groupId": 1,
                "groupName": "PENDING",
                "id": 7,
                "name": "PENDING_ENROUTE",
                "description": "Message sent to next instance",
                "action": null
            }
        }
    ],
} 

잘못된 요청 또는 에러

{
    "code": "G210",
    "desc": "요청 JSON 변환중 오류가 발생했습니다."
}

Viber 이미지 발송 API

Viber 이미지 발송 API

POST https://4vh6qtie3c.apigw.ntruss.com/viber-image/v1/send

Headers

Name	Type	Description
Content-Type*	string	application/json;charset=utf-8
Authorization*	string	사용자ID;secret_key

Request Body

Name	Type	Description
messages*	object array	메시지 본문 내용
content*	object	보낼 메시지를 작성하기 위한 콘텐츠
messageId*	string	보낸 메시지를 고유하게 식별하는 ID
to*	string	메시지 수신자 번호 (국제 형식이어야 합니다)
from*	string	viber에 등록한 발신자 번호 (국제 형식이어야 하며, viber의 요구 사항 을 준수해야 합니다)
mediaUrl*	string	사용자가 별도로 업로드 한 이미지 URL

200: OK 응답 반환 완료

Request Body 예시

{
    "from": "447860099299",
    "to": "821094006224",
    "messageId": "a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
    "content": {
        "mediaUrl": "http://testurl.com/download/imgtest.png"
    }
}

Response Body 예시

성공

{
    "messages": [
        {
            "to": "821012341234",
            "messageId": "7c1ef5d2-54be-4116-b6cf-5d96b0b5fb19",
            "status": {
                "groupId": 1,
                "groupName": "PENDING",
                "id": 7,
                "name": "PENDING_ENROUTE",
                "description": "Message sent to next instance",
                "action": null
            }
        }
    ],
 } 

잘못된 요청 또는 에러

{
    "code": "G210",
    "desc": "요청 JSON 변환중 오류가 발생했습니다."
}

메시지 발송 결과(WebHook)

고객사 callback URL 정보는 서비스 신청 시 입력 합니다.

고객사 callback URL에 대한 CJ API GATEWAY의 접근을 허용해야 합니다. (IP, PORT)

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX Gateway -> 고객사 URL)

Webhook body (API PLEX ➡ 고객사)

{
    "results": [
        {
            "messageId": "string",
            "to": "string",
            "sentAt": "string",
            "doneAt": "string",
            "status": {
                "groupId": "number",
                "groupName": "string",
                "id": "number",
                "name": "string",
                "description": "string"
            },
            "error": {
                "groupId": "number",
                "groupName": "string",
                "id": "number",
                "name": "string",
                "description": "string",
                "permanent": "true/false"
            }
        }
    ]
}

전송되는 webhook body 형식

키	타입	설명
results	object array	발송결과에 대한 배열 (배열 형식이지만 1건씩 전송됨)
to	string	수신번호
messageCount	number	SMS 메시지 수 (한 목적지에 보낸 SMS 메시지 count)
messageId	string	메시지고유 키 (발송 시 unique 하게 설정 하여 발송)
sentAt	string	발송일자
doneAt	string	완료일자
status	object	메시지 상태(status 상세)
error	object	에러(error 상세)

status 상세

키	타입	설명
id	number	status id (Viber 메시지 상태 코드 상세 참조)
groupId	number	status group id (Viber 메시지 상태 코드 상세 참조)
groupName	string	status group name
description	string	상태 메시지

error 상세

키	타입	설명
id	number	error id (Viber 서비스 오류 코드 상세 참조)
groupId	number	error group id (Viber 서비스 오류 코드 상세 참조)
groupName	string	error group name
description	string	상태 메시지
permanent	boolean	영구성

Response body (고객사 ➡ API PLEX)

{
    "code": "string",
    "desc": "string"
}

키	타입	필수	설명
code	string	Y	접수 결과 코드 (정상 수신시 "100")
desc	string	Y	접수 결과 코드 상세 (ex: "desc":"Success")

결과 코드

GATEWAY 오류코드

CODE	설명
G110	서비스 ID가 잘못되었습니다.
G120	유효한 사용자가 존재하지 않습니다.
G130	서비스 KEY가 잘못되었습니다.
G140	유효한 발신번호가 아닙니다.
G150	여신이 부족합니다.
G160	1회 발송 최대 수를 초과했습니다.
G180	필수항목이 누락되었습니다. 항목명: %s
G200	project-key 정보가 잘못되었습니다.
G210	요청 JSON 변환중 오류가 발생했습니다.
G410	원천서비스 서비스 오류 발생
G420	사용자 callback api 호출 오류입니다.
G900	Gateway 시스템 오류가 발생했습니다.
G910	사용자 인증에 실패했습니다.

Viber 메시지 상태 코드 상세

ID	GroupId	이름	설명
1	1	PENDING_TIME_VIOLATION	시간대 위반
2	3	DELIVERED_TO_OPERATOR	통신사에게 전달됨
3	1	PENDING_WAITING_DELIVERY	메시지를 보냈으며 Delivery reports를 기다리는 중
3	1	PENDING_WAITING_DELIVERY	메시지를 보냈으며 Delivery reports를 기다리는 중
4	2	UNDELIVERABLE_REJECTED_OPERATOR	통신사가 메시지를 거부함
5	3	DELIVERED_TO_HANDSET	메시지가 핸드셋에 전달됨
6	5	REJECTED_NETWORK	네트워크가 금지됨
7	1	PENDING_ENROUTE	메시지를 다음 인스턴스로 전송
8	5	REJECTED_PREFIX_MISSING	번호 접두사 누락
9	2	UNDELIVERABLE_NOT_DELIVERED	보낸 메시지가 전달되지 않음
10	5	REJECTED_DND	대상이 DND 목록에 있음
11	5	REJECTED_SOURCE	잘못된 소스 주소
12	5	REJECTED_NOT_ENOUGH_CREDITS	크레딧 부족
13	5	REJECTED_SENDER	발신자가 거부함
14	5	REJECTED_DESTINATION	대상이 거부함
15	4	EXPIRED_EXPIRED	메시지가 만료됨
16	5	REJECTED_NOT_REACHABLE	네트워크 연결 불가
17	5	REJECTED_PREPAID_PACKAGE_EXPIRED	선불 패키지가 만료됨
18	5	REJECTED_DESTINATION_NOT_REGISTERED	목적지가 등록되지 않음
19	5	REJECTED_ROUTE_NOT_AVAILABLE	라우팅 사용 불가
20	5	REJECTED_FLOODING_FILTER	플러딩이 거부됨
21	5	REJECTED_SYSTEM_ERROR	시스템 오류
22	4	EXPIRED_UNKNOWN	알 수 없는 이유
23	5	REJECTED_DUPLICATE_MESSAGE_ID	중복 Message ID 거부됨
24	5	REJECTED_INVALID_UDH	잘못된 UDH 거부됨
25	5	REJECTED_MESSAGE_TOO_LONG	너무 긴 메시지 거부됨
26	1	PENDING_ACCEPTED	대기 수락
27	1	PENDING_APPROVAL	대기 승인
28	5	REJECTED_NOT_SENT	거부되고 보내지 않음
29	4	EXPIRED_DLR_UNKNOWN	만료된 DLR 알 수 없음
30	3	DELIVERED	MO 전달 조치 완료됨
31	2	UNDELIVERABLE_NOT_SENT	메시지 보내지 않음
51	5	MISSING_TO	목적지 누락
52	5	REJECTED_DESTINATION	잘못된 목적지 주소

Viber 서비스 오류 코드 상세

ID	GroupId	이름	설명	영구성
0	0	NO_ERROR	오류 없음	false
1	1	EC_UNKNOWN_SUBSCRIBER	알 수 없는 가입자	true
5	1	EC_UNIDENTIFIED_SUBSCRIBER	식별되지 않은 가입자	false
6	1	EC_ABSENT_SUBSCRIBER_SM	부재 중인 가입자	false
9	1	EC_ILLEGAL_SUBSCRIBER	불법 가입자	true
10	3	EC_BEARER_SERVICE_NOT_PROVISIONED	전달자 서비스가 프로비저닝되지 않음	true
11	1	EC_TELESERVICE_NOT_PROVISIONED	텔레서비스가 프로비저닝되지 않음	true
12	1	EC_ILLEGAL_EQUIPMENT	불법 장비	true
13	1	EC_CALL_BARRED	통화 차단	false
20	3	EC_SS_INCOMPATIBILITY	SS 비호환성	false
21	1	EC_FACILITY_NOT_SUPPORTED	지원되지 않는 설비	false
27	1	EC_ABSENT_SUBSCRIBER	부재 중인 가입자	false
31	1	EC_SUBSCRIBER_BUSY_FOR_MT_SMS	Mt SMS에 대해 가입자 통화 중	false
32	1	EC_SM_DELIVERY_FAILURE	SM 전달 실패	false
33	1	EC_MESSAGE_WAITING_LIST_FULL	메시지 대기 목록 꽉 참	false
34	1	EC_SYSTEM_FAILURE	시스템 장애	false
35	1	EC_DATA_MISSING	데이터 누락	false
36	1	EC_UNEXPECTED_DATA_VALUE	예상치 못한 데이터 값	false
51	3	EC_RESOURCE_LIMITATION	리소스 제한	true
71	3	EC_UNKNOWN_ALPHABET	알 수 없는 알파벳	false
72	1	EC_USSD_BUSY	Ussd 통화 중	true
255	1	EC_UNKNOWN_ERROR	알 수 없는 오류	false
256	1	EC_SM_DF_MEMORYCAPACITYEXCEEDED	SM DF 메모리 용량 초과	false
257	1	EC_SM_DF_EQUIPMENTPROTOCOLERROR	SM DF 장비 프로토콜 오류	false
258	1	EC_SM_DF_EQUIPMENTNOTSM_EQUIPPED	SM DF 장비에 SM 장착 안 됨	false
259	1	EC_SM_DF_UNKNOWNSERVICECENTRE	SM DF 알 수 없는 서비스 센터	false
260	1	EC_SM_DF_SC_CONGESTION	SM DF Sc 정체	false
261	1	EC_SM_DF_INVALIDSME_ADDRESS	SM DF InvalidSME 주소	false
262	1	EC_SM_DF_SUBSCRIBERNOTSC_SUBSCRIBER	SM DF Subscribernotsc 가입자	false
500	1	EC_PROVIDER_GENERAL_ERROR	공급업체 일반 오류	false
501	3	EC_INVALID_RESPONSE_RECEIVED	잘못된 응답 수신	false
502	1	EC_NO_RESPONSE	응답 없음	false
503	1	EC_SERVICE_COMPLETION_FAILURE	서비스 완료 실패	false
504	1	EC_UNEXPECTED_RESPONSE_FROM_PEER	피어로부터 예상치 못한 응답	false
507	1	EC_MISTYPED_PARAMETER	잘못 입력된 매개 변수	false
508	1	EC_NOT_SUPPORTED_SERVICE	지원되는 서비스	false
509	1	EC_DUPLICATED_INVOKE_ID	중복된 ID 호출	false
511	1	EC_INITIATING_RELEASE	릴리즈 시작 중	true
1024	1	EC_OR_APPCONTEXTNOTSUPPORTED	앱 컨텍스트 지원 안 됨	false
1025	1	EC_OR_INVALIDDESTINATIONREFERENCE	잘못된 목적지 참조	false
1026	1	EC_OR_INVALIDORIGINATINGREFERENCE	잘못된 원본 참조	false
1027	1	EC_OR_ENCAPSULATEDAC_NOTSUPPORTED	캡슐화된 AC 지원 안 됨	false
1028	1	EC_OR_TRANSPORTPROTECTIONNOTADEQUATE	전송 보호 부적절함	false
1029	1	EC_OR_NOREASONGIVEN	제공된 사유 없음	false
1030	1	EC_OR_POTENTIALVERSIONINCOMPATIBILITY	잠재적 버전 비호환성	false
1031	1	EC_OR_REMOTENODENOTREACHABLE	원격 노드 연결 불가	false
1152	1	EC_NNR_NOTRANSLATIONFORANADDRESSOFSUCHNATURE	이러한 특성의 주소에 대한 변환 없음	false
1153	1	EC_NNR_NOTRANSLATIONFORTHISSPECIFICADDRESS	이 특정 주소에 대한 변환 없음	false
1154	1	EC_NNR_SUBSYSTEMCONGESTION	하위 시스템 정체	false
1155	1	EC_NNR_SUBSYSTEMFAILURE	하위 시스템 장애	false
1156	1	EC_NNR_UNEQUIPPEDUSER	장비를 갖추지 않은 사용자	false
1157	1	EC_NNR_MTPFAILURE	MTP 실패	false
1158	1	EC_NNR_NETWORKCONGESTION	네트워크 정체	false
1159	1	EC_NNR_UNQUALIFIED	자격 없음	false
1160	1	EC_NNR_ERRORINMESSAGETRANSPORTXUDT	메시지 전송 XUDT에 오류 있음	false
1161	1	EC_NNR_ERRORINLOCALPROCESSINGXUDT	로컬 처리 XUDT에 오류 있음	false
1162	1	EC_NNR_DESTINATIONCANNOTPERFORMREASSEMBLYXUDT	목적지에서 리어셈블리 XUDT를 수행할 수 없음	false
1163	1	EC_NNR_SCCPFAILURE	SCCP 실패	false
1164	1	EC_NNR_HOPCOUNTERVIOLATION	홉 카운터 위반	false
1165	1	EC_NNR_SEGMENTATIONNOTSUPPORTED	세그먼트화 지원 안 됨	false
1166	1	EC_NNR_SEGMENTATIONFAILURE	세그먼트화 실패	false
1281	1	EC_UA_USERSPECIFICREASON	사용자별 사유	false
1282	1	EC_UA_USERRESOURCELIMITATION	사용자 리소스 제한	false
1283	1	EC_UA_RESOURCEUNAVAILABLE	리소스 사용 불가	false
1284	1	EC_UA_APPLICATIONPROCEDURECANCELLATION	애플리케이션 프로시저 취소	false
1536	1	EC_PA_PROVIDERMALFUNCTION	공급업체 오작동	false
1537	1	EC_PA_SUPPORTINGDIALOGORTRANSACTIONREALEASED	지원 대화 상자 또는 트랜잭션 릴리즈됨	false
1538	1	EC_PA_RESSOURCELIMITATION	리소스 제한	false
1539	1	EC_PA_MAINTENANCEACTIVITY	유지 보수 활동	false
1540	1	EC_PA_VERSIONINCOMPATIBILITY	버전 비호환성	false
1541	1	EC_PA_ABNORMALMAPDIALOG	비정상적 맵 대화 상자	false
1792	1	EC_NC_ABNORMALEVENTDETECTEDBYPEER	피어에서 비정상적 이벤트 감지됨	false
1793	1	EC_NC_RESPONSEREJECTEDBYPEER	피어에서 응답 거부	false
1794	1	EC_NC_ABNORMALEVENTRECEIVEDFROMPEER	피어로부터 비정상적 이벤트 수신됨	false
1795	1	EC_NC_MESSAGECANNOTBEDELIVEREDTOPEER	메시지를 피어에 전달할 수 없음	false
1796	1	EC_NC_PROVIDEROUTOFINVOKE	공급업체 호출 불가	false
2048	3	EC_TIME_OUT	시간 초과	false
2049	2	EC_IMSI_BLACKLISTED	IMSI 차단됨	true
2050	3	EC_DEST_ADDRESS_BLACKLISTED	DND 차단됨	true
2051	3	EC_INVALIDMSCADDRESS	텍스트 차단됨	false
4096	2	EC_INVALID_PDU_FORMAT	잘못된 PDU 형식	true
4097	3	EC_NOTSUBMITTEDTOGMSC	GMSC에 제출되지 않음	false
4100	2	EC_MESSAGE_CANCELED	메시지 취소됨	true
4101	2	EC_VALIDITYEXPIRED	Validity period 만료됨	true
4102	3	EC_NOTSUBMITTEDTOSMPPCHANNEL	Smpp 채널에 제출 안 됨	true
5000	0	VOICE_ANSWERED	사람이 통화에 응답함	true
5001	0	VOICE_ANSWERED_MACHINE	기계가 통화에 응답함	true
5002	2	EC_VOICE_USER_BUSY	통화 시도 중에 사용자가 통화 중이었음	true
5003	2	EC_VOICE_NO_ANSWER	사용자에게 알렸지만 전화를 받지 않음	true
5004	2	EC_VOICE_ERROR_DOWNLOADING_FILE	통화를 위해 제공된 파일을 다운로드할 수 없었음	true
5005	2	EC_VOICE_ERROR_UNSUPPORTED_AUDIO_FORMAT	통화를 위해 제공된 파일의 형식이 지원되지 않음	true