메시지 폼

사전에 자주 전송하는 메시지 형태를 등록합니다. 통합메시지 전송 시 메시지폼 ID를 입력하여 전송할 수 있습니다.

서비스 준비 중 입니다.

  • 메시지 관련 상세 옵션필드를 모두 사용할 수 있는 전문가 방식 입니다.

  • 메시지 내용, 제목, 버튼 등에 치환문구를 활용하여 등록 할 수 있습니다.

  • 상세 Response 내용은 코드표를 참조해주시기 바랍니다.

  • 메시지 폼에 MMS FileKey, RCS Media 사용 시 유효기간에 유의해 주시기 바랍니다.

  • 메시지 폼 등록 후 최대 5분 뒤에 사용 가능합니다.

통합 메시지 발송 시 사용하기 위한 메시지 형식 입니다.

메시지 폼 ID 발송 시 등록된 메시지 순서대로 전송 및 Fallback 처리 됩니다.

메시지 폼 등록

curl -X POST https://omni.ibapi.kr/v1/form \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}'

Request

Header

NameTypeDescription

Authorization

String

schema + “ “ + token

Content-Type

String

application/json

Accept

String

application/json

Body

NameTypeRequiredDescription

Object Array

YES

메시지폼 정보

Response

Header

NameTypeDescription

Content-Type

String

application/json

Body

NameTypeDescription

code

String(4)

API호출 결과 코드

result

String

API호출 결과 설명

data

Object

API호출 결과 데이터

Schema

messageForm

Array 순서대로 전송, Fallback 처리 됩니다.

NameTypeRequiredDescription

sms

Object

NO

SMS 메시지 정보

mms

Object

NO

MMS 메시지 정보

rcs

Object

NO

RCS 메시지 정보

alimtalk

Object

NO

카카오 알림톡 메시지 정보

friendtalk

Object

NO

카카오 친구톡 메시지 정보

메시지 정보 세부 사양은 통합메시지 messageFlow Schema부분을 참고 해주시기 바랍니다.

메시지 폼 조회

curl -X GET https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰"

Request

Header

NameTypeDescription

Authorization

String

schema + “ “ + token

Accept

String

application/json

Path Parameter

NameTypeRequiredDescription

formId

String

YES

메시지 폼 ID

Response

Header

NameTypeDescription

Content-Type

String

application/json

Body

NameTypeDescription

code

String(4)

API호출 결과 코드

result

String

API호출 결과 설명

data

Object

API호출 결과 데이터

메시지 폼 수정

curl -X PUT https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"messageForm":[{"rcs":{"content":{"standalone":{"text":"RCS 메시지 내용"}},"from":"발신번호","formatId":"SS000000"}},{"sms":{"from":"발신번호","text":"SMS 메시지 내용"}}]}'

Request

Header

NameTypeDescription

Authorization

String

schema + “ “ + token

Content-Type

String

application/json

Accept

String

application/json

Path Parameter

NameTypeRequiredDescription

formId

String

YES

메시지폼 ID

Body

NameTypeRequiredDescription

Object Array

YES

메시지폼 정보

Response

Header

NameTypeDescription

Content-Type

String

application/json

Body

NameTypeDescription

code

String(4)

API호출 결과 코드

result

String

API호출 결과 설명

data

Object

API호출 결과 데이터

메시지 폼 삭제

curl -X DELETE https://omni.ibapi.kr/v1/form/메시지폼ID \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" 

Request

Header

NameTypeDescription

Authorization

String

schema + “ “ + token

Accept

String

application/json

Path Parameter

NameTypeRequiredDescription

formId

String

YES

메시지폼 ID

Response

Header

NameTypeDescription

Content-Type

String

application/json

Body

NameTypeDescription

code

String(4)

API호출 결과 코드

result

String

API호출 결과 설명

Last updated