환경

D omain URL

개발

https://dev-api.message.to-go.io

운영

https://api.message.to-go.io

IP

Port

52.223.1.165

80, 443

35.71.148.47

80, 443

환경

D omain URL

개발 ( 폐쇄망 )

https://agent.message.to-go.io/dev

운영 ( 폐쇄망 )

https://agent.message.to-go.io/ prod

파라미터명

타입

필수여부

설명

Authorization

String

필수

회원 가입 웹 홈페이지를 통해 발급받은 Key value

파라미터명

타입

필수여부

설명

tenant_id

String

필수

회원 가입 후 전달 받은 Tenant Id

user_id

String

필수

사용자 계정

공통파라미터명

타입

필수여부

설명

send_request_dtm

String

필수

예약발송 시 예약 시간 입력 ( 즉시발송은 ‘’ 입력 )

from_phone_number

String

필수

발신 번호

from_country_code

String

필수

발신 번호 국가 코드 번호

to_country_code

String

필수

수신 번호 국가 코드 번호

next_method_on_fail

String

선택

문자 전송 실패 시 전송 방법

primary_customer_reference_id

String

선택

고객 관리용 추가 항목 1

secondary_customer_reference_id

String

선택

고객 관리용 추가 항목 2

send_type

String

필수

단문 : sms

장문 : lms

장문 이미지 : mms

Kakao :

- 알림톡 : at

- 알림톡 이미지 : ai

- 친구톡 : ft

result_url

String

선택

결과 수신 URL

send_status

String

필수

발송 상태 ( 일반 전송 : request, 예약발송 : schedule-request )

{

….,

" result_url ": “ref_key:api.message.to-go.io/result”,

….

}

엘리먼트 명

Depth

배열

구분

설명

값 구분

statusCode

1

결과 상태 코드

200 : 성공 , 400 : 실패

resultCode

1

결과 코드

결과코드 아래 첨부

resultMessage

1

결과 메시지

결과코드에 따른 메시지

data

1

데이터 정보

엘리먼트 명

설명

1000

성공

6004

발신 번호 사전 등록제에 의한 미등록 차단

6005

첨부파일 없음

6006

발송시간 기준 30 분 이후만 예약 발송이 가능합니다 .

6007

필수값 ( key ) 이 누락되었습니다 .

{

"resultCode": 1000,

"resultMessage": " 성공 ",

"data": ""

}

{

"resultCode": 6004,

"resultMessage": " 발신 번호 사전 등록제에 의한 미등록 차단 ",

"data": ""

}

{

"resultCode": 6005,

"resultMessage": " 첨부 파일 없음 . ",

"data": ""

}

{

"resultCode": 6006,

"resultMessage": " 발송시간 기준 30 분 이후만 예약 발송이 가능합니다 .",

"data": ""

}

{

"resultCode": 6007,

"resultMessage": " 필수값 (to_country_code) 이 누락되었습니다 .",

"data": ""

}

파라미터명

타입

필수여부

설명

contents

String

필수

발송 내용 ( 최대 80 byte)

to_phone_numbers

List

필수

수신 전화번호 목록 ( 최대 1,000 명 )

phone

String

필수

수신전화번호

params

List

선택

- 추가 파라미터가 존재하는 경우

메시지 별 파라미터 설정 가능 .

List 내 순번에 따라 Contents 내 {0}, {1}, {2} 로 매핑 가능

Ex ) "params" : [

" 메시지 " ,

" 그대 "

]

이 경우

- contents : “ { 0} 를 {1} 에게 보낸다 ”

- 실제 발송 : “ 메시지를 그대에게 보낸다 ” 로 변환

- 추가 파라미터가 존재하지 않는 경우

Ex ) "params" : []

result_reference_key

String

선택

고객 시스템의 Key 값 ( 결과 업데이트 용 )

{

"contents" : "test sms 발송 " ,

"send_request_dtm" : "" , // 예약 발송의 경우 “ yyyymmddhhmmss” 형태로 입력 (ex. “20171213134000” )

"from_phone_number" : "0212345678" ,

"from_country_code" : "82" ,

"to_phone_numbers" : [

{

"phone" : "01012345678" ,

"params" : [

" param1 " ,

" param2 " ,

" param3 "

],

“ result_reference_key” : “” // 고객 시스템의 Key 값

}

],

"to_country_code" : "82" ,

"next_method_on_fail" : " k akao " ,

"secondary_customer_reference_id" : "" ,

"primary_customer_reference_id" : "",

" send_type " : " sms ",

" send_status " : " request " ( 예약발송의 경우 “ schedule-reqeust”)

}

curl --location 'https://dev-api.message.to-go.io/message?tenant_id={ 해당테넌트 }&user_id= test ' \

--header 'Content-Type: application/json' \

--header 'Authorization: Key ' \

--data '{

"contents": " 테스트입니다 .",

"send_request_dtm": "",

"from_phone_number": "0212345678", -- 사전 등록 된 발신번호

"from_country_code": "82",

"to_phone_numbers": [

{

"phone": "01012345678", -- 수신자 번호

"params": [

" param1 ",

" param2 "

],

"result_reference_key" : 1

}

],

"to_country_code": "82",

"send_type": "sms",

"send_status" : "request"

}'

파라미터명

타입

필수여부

설명

contents

String

필수

발송 내용 ( 최대 1,000 byte)

subject

String

필수

LMS 제목

to_phone_numbers

List

필수

수신 전화번호 목록 ( 최대 1,000 명 )

phone

String

필수

수신전화번호

params

List

선택

- 추가 파라미터가 존재하는 경우

메시지 별 파라미터 설정 가능 .

List 내 순번에 따라 Contents 내 {0}, {1}, {2} 로 매핑 가능

Ex ) "params" : [

" 메시지 " ,

" 그대 "

]

이 경우

- contents : “ { 0} 를 {1} 에게 보낸다 ”

- 실제 발송 : “ 메시지를 그대에게 보낸다 ” 로 변환

- 추가 파라미터가 존재하지 않는 경우

Ex ) "params" : []

result_reference_key

String

선택

고객 시스템의 Key 값 ( 결과 업데이트 용 )

{

"contents" : "test l ms 발송 " , // 최대 1,000b yte 가능

"send_request_dtm" : "" , // 예약 발송의 경우 “ yyyymmddhhmmss” 형태로 입력 (ex. “20171213134000” )

"from_phone_number" : "0212345678" ,

"from_country_code" : "82" ,

"to_phone_numbers" : [

{

"phone" : "01012345678" ,

"params" : [

" param1 " ,

" param2 " ,

" param3 "

]

},

“ result_reference_key” : “” // 고객 시스템의 Key 값

],

"to_country_code" : "82" ,

"next_method_on_fail" : " k akao " ,

"secondary_customer_reference_id" : "" ,

"primary_customer_reference_id" : "",

"subject" : "subject",

"send_type" : " lms ",

" send_status " : " request " ( 예약발송의 경우 “ schedule-reqeust”)

}

curl --location 'https://dev-api.message.to-go.io/message?tenant_id={ 해당테넌트 }&user_id= test ' \

--header 'Content-Type: application/json' \

--header 'Authorization: Key ' \

--data '{

"contents": " 국제발송 테스트입니다 .",

"send_request_dtm": "",

"from_phone_number": "0264002613",

"from_country_code": "82",

"to_phone_numbers": [

{

"phone": "01012345678",

"params": [

" param1 ",

" param2 "

],

"result_reference_key" : 1

}

],

"to_country_code": "82",

"subject": " 국제 문자 발송 MMS 메시지 ",

"send_type": "lms",

"send_status" : "request"

}'

파라미터명

타입

필수여부

설명

contents

String

필수

발송 내용 ( 최대 1,000 byte)

to_phone_numbers

List

필수

수신 전화번호 목록 ( 최대 1,000 명 )

phone

String

필수

수신전화번호

params

List

선택

- 추가 파라미터가 존재하는 경우

메시지 별 파라미터 설정 가능 .

List 내 순번에 따라 Contents 내 {0}, {1}, {2} 로 매핑 가능

Ex ) "params" : [

" 메시지 " ,

" 그대 "

]

이 경우

- contents : “ { 0} 를 {1} 에게 보낸다 ”

- 실제 발송 : “ 메시지를 그대에게 보낸다 ” 로 변환

- 추가 파라미터가 존재하지 않는 경우

Ex ) "params" : []

result_reference_key

String

선택

고객 시스템의 Key 값 ( 결과 업데이트 용 )

subject

String

필수

MMS 제목

image_url1

String

필수

첨부이미지 1 (3.11 업로드 이미지의 refKey 추가 )

image_url2

String

선택

첨부이미지 2

image_url3

String

선택

첨부이미지 3

{

"contents" : "1st db insert test message for message to-go! {0} 님 {1} 살 {2} 가 되신 것을 축하합니다 ! 당신은 {2} 입니다 ." ,

"send_request_dtm" : "" , // 예약 발송의 경우 “ yyyymmddhhmmss” 형태로 입력 (ex. “20171213134000” )

"from_phone_number" : "0212345678" ,

"from_country_code" : "82" ,

"to_phone_numbers" : [

{

"phone" : "01012345678" ,

"params" : [

" param1 " ,

" param2 " ,

" param3 "

]

},

“ result_reference_key” : “” // 고객 시스템의 Key 값

],

"to_country_code" : "82" ,

"next_method_on_fail" : "kakao" ,

"tenant_id" : "0" ,

"secondary_customer_reference_id" : "secondary_ref_0003" ,

"primary_customer_reference_id" : "primary_ref_0003" ,

"subject" : "subject" ,

"image_url1" : "test_img_1" ,

"image_url2" : "test_img_2", // 두 번째 첨부 이미지 . 없으면 삭제 가능 .

"image_url3" : "test_img_3", // 세 번째 첨부 이미지 . 없으면 삭제 가능 .

" send_type " : " mms " ,

" send_status " : " request " ( 예약발송의 경우 “ schedule-reqeust”)

}

curl --location 'https://dev-api.message.to-go.io/message?tenant_id={ 해당테넌트 }&user_id= test’ \

--header 'Content-Type: application/json' \

--header 'Authorization: Key ' \

--data '{

"contents": " 국제발송 테스트입니다 .",

"send_request_dtm": "",

"from_phone_number": "0264002613",

"from_country_code": "82",

"to_phone_numbers": [

{

"phone": "01012345678",

"params": [

" param1 ",

" param2 "

],

"result_reference_key" : 1

}

],

"to_country_code": "82",

"subject": " 국제 문자 발송 MMS 메시지 ",

"send_type": "mms",

"send_status" : "request",

"image_url1": "1698629546_GD0596242954600009907.jpg" -- 이미지 업로드를 통해서 업로드 후 회신받은 결과값 .

}'

파라미터명

타입

필수여부

설명

contents

String

필수

발송 내용 ( 사전 등록 된 템플릿에 맞게 작성 )

from_kakao_channel

String

필수

Kakao 채널 ID

to_phone_numbers

List

필수

수신 전화번호 목록

phone

String

필수

수신전화번호

params

List

선택

- 추가 파라미터가 존재하는 경우

메시지 별 파라미터 설정 가능 .

List 내 순번에 따라 Contents 내 {0}, {1}, {2} 로 매핑 가능

Ex ) "params" : [

" 메시지 " ,

" 그대 "

]

이 경우

- contents : “ { 0} 를 {1} 에게 보낸다 ”

- 실제 발송 : “ 메시지를 그대에게 보낸다 ” 로 변환

- 추가 파라미터가 존재하지 않는 경우

Ex ) "params" : []

result_reference_key

String

선택

고객 시스템의 Key 값 ( 결과 업데이트 용 )

template_id

String

필수

템플릿 ID

{

"contents" : " 사전 등록 된 메시지 포맷에 맞게 작성 " ,

"send_request_dtm" : "" , // 예약 발송의 경우 “ yyyymmddhhmmss” 형태로 입력 (ex. “20171213134000” )

"from_phone_number" : "0212345678" ,

"from_country_code" : "82" ,

"from_kakao_channel" : "kakao_channel_id" ,

"to_phone_numbers" : [

{

"phone" : "01012345678" ,

"params" : [

" p aram1" ,

"param2" ,

" p aram3"

]

},

“ result_reference_key” : “” // 고객 시스템의 Key 값

],

"to_country_code" : "82" ,

"next_method_on_fail" : "sms" ,

"secondary_customer_reference_id" : "" ,

"primary_customer_reference_id" : "" ,

"template_id" : "bizp_template_id" ,

"send_type" : "at",

" send_status " : " request " ( 예약발송의 경우 “ schedule-reqeust”)

}

curl --location 'https://dev-api.message.to-go.io/message?tenant_id={ 해당테넌트 }&user_id=test' \

--header 'Content-Type: application/json' \

--header 'Authorization: Key ' \

--data '{

"contents": " test ", // 사전 등록 된 템플릿 내용에 맞춰 contents 작성

"send_request_dtm": "",

"from_phone_number": "0264002613",

"from_country_code": "82",

"from_kakao_channel": "e3b1e7469ee00b605871235ef5124abb622a8be1", // 카카오 채널 아이디

"to_phone_numbers": [

{

"phone": "01012345678",

"params": [

" param1 ",

" param2 "

],

"result_reference_key" : 1

}

],

"to_country_code": "82",

"next_method_on_fail": "lms",

"template_id": "bizp_2023050312150212797709152", // 카카오 템플릿 아이디

"send_type": "ai",

"send_status" : "request"

}'

파라미터명

타입

필수여부

설명

tenant_id

String

Y

회원 가입 후 전달 받은 Tenant Id

user_id

String

Y

사용자 계정

파라미터명

타입

필수여부

설명

file1

Multi-part

필수

등록 이미지 파일 1

file2

Multi-part

선택

등록 이미지 파일 2

file3

Multi-part

선택

등록 이미지 파일 3

tenant_id

String

필수

회원 가입 후 전달 받은 Tenant Id

엘리먼트 명

Depth

배열

구분

설명

값 구분

statusCode

1

결과 상태 코드

200 : 성공 , 400 : 실패

resultCode

1

결과 코드

결과코드 아래 첨부

resultMessage

1

결과 메시지

결과코드에 따른 메시지

data

1

데이터 정보

file_key

2

Y

업로드 된 파일 키 ( 최대 3 개 )

- 파일 1 개 업로드인 경우

{

"file_key": [

"1688950767_DD011770507680002159.jpg"]

}

- 파일 2 개 업로드된 경우

{

"file_key": [

"1688950767_DD011770507680002159.jpg",

"1688950768_FD137679507680002159.jpg"

]

}

- 파일 3 개 업로드된 경우

{

"file_key": [

"1688950767_DD011770507680002159.jpg",

"1688950768_FD137679507680002159.jpg",

"1688950768_FD137679507680002159.jpg",

]

}

curl --location '{Domain URL}/upload/image?tenant_id=25&user_id=userTest1&tenant_name=test' \

--header 'Authorization: Key ' \

--form 'file=@" t est1 .jpg"' \

--form 'file=@"test2.jpg"'

파라미터명

타입

필수여부

설명

tenant_id

String

Y

회원 가입 후 전달 받은 Tenant Id

user_id

S tring

Y

사용자 계정

파라미터명

타입

필수여부

설명

contents

String

필수

발송 내용

send_request_dtm

String

필수

전송요청시간 ( 예약 전송 시 데이터 입력 )

from_phone_number

String

필수

발신번호

to_phone_numbers

List

필수

수신 webhook url 목록

phone

String

필수

수신 webhook url

params

List

선택

- 추가 파라미터가 존재하는 경우

메시지 별 파라미터 설정 가능 .

List 내 순번에 따라 Contents 내 {0}, {1}, {2} 로 매핑 가능

Ex ) "params" : [

" 메시지 " ,

" 그대 "

]

이 경우

- contents : “ { 0} 를 {1} 에게 보낸다 ”

- 실제 발송 : “ 메시지를 그대에게 보낸다 ” 로 변환

- 추가 파라미터가 존재하지 않는 경우

Ex ) "params" : []

result_reference_key

String

선택

고객 시스템의 Key 값 ( 결과 업데이트 용 )

send_type

String

필수

발송 유형 (“slack”)

send_status

String

필수

전송상태 (“request”)

{

"contents" : "Slack Test" ,

"send_request_dtm" : "" ,

" f rom_phone_number” : “0264002163”, // 화면을 통해 기 등록한 발신번호 .

"to_phone_numbers" : [

{

"phone" : " https://hooks.slack.com/services/********" ,

"params" : [

" M2G " ,

"TEST"

]

},

{

"to_phone_number" : "https://hooks.slack.com/services/########" ,

"params" : [

" M2G " ,

"TEST"

]

},

],

"secondary_customer_reference_id" : "" ,

"primary_customer_reference_id" : "" ,

"send_type" : "slack" ,

"send_status" : "request"

}

curl --location 'https://dev-api.message.to-go.io/message/slack?tenant_id={tenant_id}&user_id=test \

--header 'Content-Type: application/json' \

--header 'Authorization: Key ' \

-- data '{

"contents" : " Slack Test " ,

"send_request_dtm" : "" ,

"to_phone_numbers" : “0264002613”

"to_phone_numbers" : [

{

"phone" : "https://hooks.slack.com/services/******" ,

"params" : [

" M 2G" ,

“TEST”

]

},

{

"to_phone_number" : "https://hooks.slack.com/services/###### " ,

"params" : [

" M 2G" ,

“TEST”

]

}

],

"secondary_customer_reference_id" : "" ,

"primary_customer_reference_id" : "" ,

"send_type" : "slack" ,

"send_status" : "request"

} '

파라미터명

타입

필수여부

설명

ref_key

String

필수

고객사에서 부여한 키

result_code

String

필수

결과코드

result_name

String

필수

결과설명

send_type

String

필수

발송 유형

phone

String

필수

수신 번호

param_list

String

필수

발송 당시 추가 파람 목록

primary_customer_reference_id

String

필수

고객 식별 ID

secondary_customer_reference_id

String

필수

캠페인 ID

send_result_dtm

String

필수

결과 전송 시간

에러코드

코드 설명

4100

전달

4400

음영 지역

4401

단말기 전원 꺼짐

4402

단말기 메시지 저장 초과

4403

메시지 삭제 됨

4404

가입자 위치 정보 없음

4405

단말기 BUSY

4410

잘못된 번호

4411

NPDB 에러 \n( 모든 통신사에 해당 수신번호 가입자가 존재하지 않을 경우 발생합니다 .)

4412

착신 거절

4413

SMSC 형식오류

4414

" 비 가입자 , 결번 , 서비스 정지 "

4420

기타 에러

4421

타임아웃

4422

단말기 일시정지

4423

단말기 착신거부

4424

URL SMS 미 지원 휴대폰

4425

단말기 호 처리 중

4426

재시도 한도초과

4427

기타 단말기 문제

4428

시스템 에러

4430

스팸

4431

발송 제한 수신거부 ( 스팸 )

4432

발신 번호 차단 ( 개인 )

4433

발신 번호 차단 ( 기업 )

4434

발신 번호 사전 등록제에 의한 미등록 차단

4435

KISA 신고 스팸 발신 번호 차단

4436

발신 번호 사전 등록제 번호 규칙 위반

9000

알 수 없는 오류 발생

에러코드

코드 설명

6600

전달

6601

타임 아웃

6602

핸드폰 호 처리 중

6603

음영 지역

6604

전원이 꺼져 있음

6605

메시지 저장 개수 초과

6606

잘못된 번호

6607

서비스 일시 정지 \n( 통신사로 정지 요청을 하거나 통신사측에서 요금 미납 등으로 인해 정지처리가 되었을 수 있습니다 .)

6608

기타 단말기 문제

6609

착신 거절

6610