템플릿 관리 - 목록 조회

등록된 RCS 템플릿 목록을 조회합니다. RCS BIZ Center 에서 템플릿을 수정하였을 경우
RCS 홈 탭 에서 정보 업데이트를 진행 하셔야지만 수정된 내용이 조회됩니다.

[ Request ]

              POST /rcs/template/list/ HTTP/1.1
                    Host: apis.aligo.in
                    Service Port: 443
            
            

https 프로토콜을 사용하여 POST로 요청합니다. RCS 전송시 요구되는 JSON 전문을 조회할 수 있습니다.

변수	설명	필수	타입
apikey	인증용 API Key	O	String
user_id	사용자id	O	String
rbc_id	RCS BIZ Center 계정 아이디	O	String
brand_id	브랜드 아이디	X	String

예를 들면,

            curl -X POST "https://apis.aligo.in/rcs/template/list/" \
                --data-urlencode "apikey=xxxxx" \
                --data-urlencode "user_id=xxxxx" \
                --data-urlencode "rbc_id=xxxxxx" \
                --data-urlencode "brand_id=xx.xxxxxxxxxx"
            
        

[Response]

응답 바디는 JSON 객체로 구성됩니다.

JSON

변수	설명	타입
result_code	결과코드	Integer
message	API 호출에 대한 결과 메시지	String
result	템플릿 목록 조회	LIST

list 배열

키	설명	타입
templateCode	템플릿 코드	String
tpl_type	템플릿 유형	String
messagebaseId	RCS비즈센터 템플릿 아이디	String
tmpltName	템플릿 이름	String
messagebaseformId	RCS비즈센터 레이아웃 코드	String
brandId	브랜드 아이디	String
status	템플릿 상태	String
approvalResult	승인상태	String
send_body	RCS 발송 메시지 원문 (치환변수는 수정해서 전송하세요)	String
registerDate	템플릿 등록일자	YYYY-MM-DD HH:ii:ss
approvalDate	템플릿 승인일자	YYYY-MM-DD HH:ii:ss
updateDate	템플릿 수정일자	YYYY-MM-DD HH:ii:ss

호출이 정상적으로 성공했을 경우

        HTTP/1.1 200 OK
            Content-Type: application/json;charset=UTF-8
            {
                "result_code": 1
                "message": "정상적으로 호출하였습니다."
                "result": {
                        templateCode: XXX-XXXXX,
                        tpl_type: TPL-TEXT,
                        messagebaseId: xxx.xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxx,
                        tmpltName: 테스트 템플릿,
                        messagebaseformId: XXXXXXXX,
                        brandId: xxx.xxxxxxxxxx,
                        status: ready,
                        approvalResult: 승인,
                        send_body: "{
                          \"description\": \"[테스트] [{{이름}}] 님께 드리는 메시지 입니다.\",
                          \"회신번호\": \"{{회신번호}}\"
                        }"
                        registerDate: 2025-07-01 23:47:20,
                        approvalDate: 2025-07-01 23:47:20,
                        updateDate: 2025-07-01 23:47:20
                }
            }
        

호출이 실패하였을 경우

        HTTP/1.1 200 OK
            Content-Type: application/json;charset=UTF-8
            {
                "code": -101
                "message": "API 인증오류입니다."
            }
        
        

 

RCS 전송

RCS 메시지 전송을 요청합니다. 템플릿 서식과 일치하지 않거나 스마트폰이 RCS 메시지를 지원하지 않으면 수신이 되지 않습니다.

[ Request ]

              POST /rcs/send/ HTTP/1.1
                    Host: apis.aligo.in
                    Service Port: 443
            
            

https 프로토콜을 사용하여 POST로 요청합니다.

변수	설명	필수	타입
apikey	인증용 API Key	O	String
user_id	사용자id	O	String
agency_id	대행사 아이디	X	String
agency_key	대행사 키	X	String
brand_id	브랜드 아이디	O	String
sender_number	대화방 번호	O	String
message_base_id	RCS 비즈센터 템플릿 아이디	O	String
reserve_date	예약발송 일자 (예 : 20250702234700)	X	YYYYMMDDHHiiss
advert	정보성 또는 광고성	X	X (기본) 또는 Y
ars_number	수신거부 번호	광고성일때 필수	String
copy_allowed	복제허용 여부	X	X (기본) 또는 Y
receiver_1 ~ 500	수신자	O	String
contents_1 ~ 500	RCS 발송 메시지 전문	O	String
failover	대체문자 발송	X	N (기본) 또는 Y
smstype	대체문자 유형	O	String
fsubject_1 ~ 500	대체문자 제목	X	String
fcontent_1 ~ 500	대체문자 내용	X	String

예를 들면,

        curl -X POST "https://apis.aligo.in/rcs/send/" \
                --data-urlencode "apikey=xxxxx" \
                --data-urlencode "user_id=xxxxx" \
                --data-urlencode "brand_id=xx.xxxxxxxxxx" \
                --data-urlencode "sender_number=xxxxxxxxx" \
                --data-urlencode "message_base_id=xxx.xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxx" \
                --data-urlencode "receiver_1=010xxxxxxxx" \
                --data-urlencode "contents_1={
                          \"description\": \"[테스트] [홍길동] 님께 드리는 메시지 입니다.\",
                          \"회신번호\": \"010-XXXX-XXXX\"
                        }"
        
        

[Response]

응답 바디는 JSON 객체로 구성됩니다.

JSON

변수	설명	타입
code	결과코드(API 수신유무)	Integer
message	API 호출에 대한 결과 메시지	String
mid	전송된 메시지 시퀀스	Integer

전송요청이 성공했을 경우

        HTTP/1.1 200 OK
            Content-Type: application/json;charset=UTF-8
            {
                "result_code": 1
                "message": "성공적으로 메시지를 전송요청 하였습니다."
                "mid": XXXXXXXX
            }
        

전송요청이 실패했을 경우

        HTTP/1.1 200 OK
            Content-Type: application/json;charset=UTF-8
            {
                "result_code": -101
                "message": "아이디가 입력되지 않았습니다."
            }
        
        

 

RCS 예약 메시지 취소

API를 통해 예약한 내역을 전송취소할 수 있습니다. 예약취소는 발송전 5분이전의 메시지만 가능합니다.

[ Request ]

        POST /rcs/cancel/ HTTP/1.1
            Host: apis.aligo.in
            Service Port: 443
        
        

https 프로토콜을 사용하여 POST로 요청합니다.

변수	설명	필수	타입
apikey	인증용 API Key	O	String
user_id	사용자id	O	String
mid	메시지ID	O	Integer

예를 들면,

        curl -X POST "https://apis.aligo.in/rcs/cancel/" \
            --data-urlencode "userid=xxxxx" \
            --data-urlencode "apikey=xxxxx" \
            --data-urlencode "mid=123456789"
        

[Response]

응답 바디는 JSON 객체로 구성됩니다.

JSON

변수	설명	타입
result	결과코드(API 수신유무)	Integer
message	결과 메시지( result_code 가 0 이 아닌 경우 실패사유 표기)	String

정상취소가 완료된 경우를 예로들면,

        HTTP/1.1 200 OK
            Content-Type: application/json;charset=UTF-8
            {
                    "result_code": 1
                    "message": "정상적으로 취소 처리 하였습니다."
            }
        

취소요청이 실패한 경우를 예로들면,

                HTTP/1.1 200 OK
                    Content-Type: application/json;charset=UTF-8
                    {
                        "result_code": -210
                        "message": "발송 5분전까지만 취소가 가능합니다."
                    }
                

연동형 API로 처리 실패시 message 항목의 안내문구를 참고하여 주시기 바랍니다.