메시지 수신

Endpoint

해당 API는 해피톡에서 고객사 수신도메인으로 발송되는 API 입니다.

[POST] API URL 정보

개발 및 테스트용 API운영 API

설정된 수신도메인/message/{UUID}

설정된 수신도메인/message/{UUID}

Description

해당 API는 해피톡에서 발신된 API이며, Biz-API 기능 중 메시지에 대한 정보를 고객사 수신도메인으로 수신되는 API입니다.

Request (Json)

None

Body

None

Example

REST API Sample

None

Response (Json)

Parameter

Data by Message Type

text 발송image 발송normal (파일) 발송normal (텍스트) 발송normal (텍스트 + 이미지) 발송normal (텍스트 + 단독 링크 버튼) 발송normal (텍스트 + 다중 링크 버튼) 발송normal (텍스트 + 이미지 + 단독 링크 버튼) 발송normal (텍스트 + 이미지 + 다중 링크 버튼) 발송

Field Name	Type	Required	Description
uuid	String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id	String	Y	상담방 아이디
type	String	Y	메시지 타입
msgid	String	Y	메시지 아이디
content	String	Y	메시지 정보
image	Object	N	이미지 정보 (데이터 없음)
auto_end	String	Y	자동 종료 여부 (Y/N)

Field Name		Type	Required	Description
uuid		String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id		String	Y	상담방 아이디
type		String	Y	메시지 타입
msgid		String	Y	메시지 아이디
content		String	Y	메시지 정보 (공백)
image		Object	Y	이미지 정보
	width	Int	Y	이미지 가로 크기
	height	Int	Y	이미지 세로 크기
	url	String	Y	이미지 URL
auto_end		String	Y	자동 종료 여부 (Y/N)

Field Name		Type	Required	Description
uuid		String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id		String	Y	상담방 아이디
type		String	Y	메시지 타입
msgid		String	Y	메시지 아이디
content		Ojbect	Y	메시지 정보
	text	String	Y	메시지 내용 (문자)
link		Ojbect	Y	다운로드 링크 버튼
	name	String	Y	링크 버튼 이름
	url	String	Y	파일 다운로드 링크
auto_end		String	Y	자동 종료 여부 (Y/N)

Field Name		Type	Required	Description
uuid		String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id		String	Y	상담방 아이디
type		String	Y	메시지 타입
msgid		String	Y	메시지 아이디
content		Ojbect	Y	메시지 정보
	text	String	Y	메시지 내용 (문자)
link		Ojbect	Y	링크 버튼
	name	String	Y	링크 버튼 이름 (공백)
	url	String	Y	링크 버튼 URL (공백)
auto_end		String	Y	자동 종료 여부 (Y/N)

Field Name			Type	Required	Description
uuid			String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id			String	Y	상담방 아이디
type			String	Y	메시지 타입
msgid			String	Y	메시지 아이디
content			Ojbect	Y	메시지 정보
	image		Object	Y	이미지 정보
		width	Int	Y	이미지 가로 크기
		height	Int	Y	이미지 세로 크기
		url	String	Y	이미지 URL
	text		String	Y	메시지 내용 (문자)
link			Ojbect	Y	링크 버튼
	name		String	N	링크 버튼 이름 (공백)
	url		String	N	링크 버튼 URL (공백)
auto_end			String	Y	자동 종료 여부 (Y/N)

Field Name		Type	Required	Description
uuid		String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id		String	Y	상담방 아이디
type		String	Y	메시지 타입
msgid		String	Y	메시지 아이디
content		Ojbect	Y	메시지 정보
	text	String	Y	메시지 내용 (문자)
link		Ojbect	Y	링크 버튼
	name	String	Y	링크 버튼 이름
	url	String	Y	링크 버튼 URL
auto_end		String	Y	자동 종료 여부 (Y/N)

Field Name		Type	Required	Description
uuid		String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id		String	Y	상담방 아이디
type		String	Y	메시지 타입
msgid		String	Y	메시지 아이디
content		Ojbect	Y	메시지 정보
	text	String	Y	메시지 내용 (문자)
link		Array(Ojbect)	Y	링크 버튼
	name	String	Y	링크 버튼 이름
	url	String	Y	링크 버튼 URL
auto_end		String	Y	자동 종료 여부 (Y/N)

Field Name			Type	Required	Description
uuid			String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id			String	Y	상담방 아이디
type			String	Y	메시지 타입
msgid			String	Y	메시지 아이디
content			Ojbect	Y	메시지 정보
	image		Object	Y	이미지 정보
		width	Int	Y	이미지 가로 크기
		height	Int	Y	이미지 세로 크기
		url	String	Y	이미지 URL
	text		String	Y	메시지 내용 (문자)
link			Ojbect	Y	링크 버튼
	name		String	Y	링크 버튼 이름
	url		String	Y	링크 버튼 URL
auto_end			String	Y	자동 종료 여부 (Y/N)

Field Name			Type	Required	Description
uuid			String	Y	사용자 식별 정보 (영문,숫자,_ 조합)
room_id			String	Y	상담방 아이디
type			String	Y	메시지 타입
msgid			String	Y	메시지 아이디
content			Ojbect	Y	메시지 정보
	image		Object	Y	이미지 정보
		width	Int	Y	이미지 가로 크기
		height	Int	Y	이미지 세로 크기
		url	String	Y	이미지 URL
	text		String	Y	메시지 내용 (문자)
link			Array(Ojbect)	Y	링크 버튼
	name		String	Y	링크 버튼 이름
	url		String	Y	링크 버튼 URL
auto_end			String	Y	자동 종료 여부 (Y/N)

Example

Success

text 발송image 발송file 발송normal (텍스트) 발송normal (텍스트 + 이미지) 발송normal (텍스트 + 단독 링크 버튼) 발송normal (텍스트 + 다중 링크 버튼) 발송normal (텍스트 + 이미지 + 단독 링크 버튼) 발송normal (텍스트 + 이미지 + 다중 링크 버튼) 발송

{
  "uuid": "test-user",
  "room_id": "ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type: "text",
  "content": "test",
  "image": {},
  "msgid": "message_id",
  "auto_end": "N"
}

{
  "uuid": "test-user",
  "room_id": "ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type: "image",
  "content": "",
  "image": {
    "width": 481,
    "height": 469,
    "url": "https://patch.happytalk.io/data/chat_data/2023_06_01/61d1263f3cbb3ab1953a66f7ed5adbd3.jpg"
  },
  "msgid": "message_id",
  "auto_end": "N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "text":"파일명 : welcome.zip 유효기한 ~ 2023-06-08 15:28 사이즈 : 59KB"
  },
  "links":{
    "name":"다운로드",
    "url":"https://patch-customer.happytalk.io/files/s3_download?v=2&token=UDQxeU94b1JHYS9Od1pyVG5ZaGhnZz09"
  },
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "text":"test"
  },
  "links":{
    "name":"",
    "url":""
  },
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "image":{
      "width":481,
      "height":469,
      "url":"https://patch.happytalk.io/data/template/1000225570/1000225570_cf2675e80a0ed9d426c159e48277c92b.jpg"
    },
    "text":"test"
  },
  "links":{
    "name":"",
    "url":""
  },
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "text":"test"
  },
  "links":{
    "name":"happyalk URL",
    "url":"https://happytalk.io"
  },
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "text":"test"
  },
  "links":[
    {
      "name":"happytalk URL",
      "url":"https://happytalk.io"
    },
    {
      "name":"ARS happytalk URL",
      "url":"https://ars.happytalk.io"
    }
  ],
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "image":{
      "width":481,
      "height":469,
      "url":"https://patch.happytalk.io/data/template/1000225570/1000225570_a7f917997b6a38d11c57d340f556f7f1.jpg"
    },
    "text":"test"
  },
  "links":{
    "name":"happytalk URL",
    "url":"https://happytalk.io"
  },
  "auto_end":"N"
}

{
  "uuid":"test-user",
  "room_id":"ZJsOV48NS2PQtxK3k69UvDhW5eoCEf",
  "type":"normal",
  "msgid":"message_id",
  "content":{
    "image":{
      "width":481,
      "height":469,
      "url":"https://patch.happytalk.io/data/templat/1000225570/1000225570_dbf402a9854beff1bfd31efdd6f8ee76.jpg"
    },
    "text":"test"
  },
  "links":[
    {
      "name":"happytalk URL",
      "url":"https://happytalk.io"
    },
    {
      "name":"ARS happytalk URL",
      "url":"https://ars.happytalk.io"
    }
  ],
  "auto_end":"N"
}

Failure

None

Data Dictionary

Request DictionaryResponse Dictionary

None

type

Field Name	Description
text	일반 텍스트
image	이미지
normal	조합된 메시지

메시지 수신

Endpoint

Description

Request (Json)

Header

Body

Example

Response (Json)

Parameter

Example

Data Dictionary