개요
다우오피스 알림(m-push, WEB&Messenger 알림, e-mail 알림) 연동을 위한 <알림 발송 API>입니다. 알림 수신자는 다우오피스의 사원번호(employeeNumber) 기준으로 연동됩니다. 조직 정보 조회 연동을 선행하거나, 사원번호를 등록하여 활용해야 합니다.
Request URL
https://api.daouoffice.com/public/v1/noti
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Request Parameters
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| clientId | String | Y | Y | 고객사 식별/인증을 위한 서비스 인증ID / Client ID ※ <인증키 발급 API>를 통해 전달받은 값 |
| clientSecret | String | Y | Y | 고객사 식별/인증을 위한 서비스 보안KEY / Secret Key ※ <인증키 발급 API>를 통해 전달받은 값 |
| productName | String | N | N | 업무시스템 제품명(제휴시스템 사용할 경우 입력) |
| productVersion | String | N | N | 업무시스템 제품버전(제휴시스템 사용할 경우 입력) |
| clientCompanyName | String | N | N | 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력) |
| sender | String | Y | N | 송신하는 다우오피스 계정 사번(employeeNumber) |
| receivers | Array <String> |
Y | N | 수신하는 다우오피스 계정 사번(employeeNumber)n명 지정 가능 |
| message | String | Y | N | 푸시 메시지 ① ※ 웹, 모바일 알림을 보낼 때 필수 값 |
| mailTitle | String | N | N | 메일 알림 제목 ※ 메일 알림을 보낼 때 필수 값 / 값이 없으면 message로 대체하여 전송 |
| mailMessage | String | N | N | 메일 알림 본문 내용 ※ 메일 알림을 보낼 때 필수 값 / 값이 없으면 message로 대체하여 전송 |
| linkUrl | String | Y | N | 푸시 메시지, 알림 메일을 클릭 시 이동하는 url. ※ 알림 연동 설정 화면에서 기본 값을 설정할 수 있으면, 값이 없다면 기본 값으로 대체됨 ※ 모든 url은 http 혹은 https로 시작 |
① OpenAPI를 사용하여 알림 발송 시, 메시지 접두어로 [OpenAPI] 텍스트가 포함된 알림으로 발송됩니다. 시스템 알림 구분하기 위한 값으로 접두어 [OpenAPI] 문구 변경/삭제 불가합니다.
※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.
Request Example
POST /public/v1/noti HTTP/1.1
api.daouoffice.com
Content-Type: application/json
{
"clientId": "f255cbe0b4a9d12f",
"clientSecret": "bafdd7b4cff6fabdc417b8a6b0e4fff6",
"productName" : "제휴서비스/제품 명",
"productVersion" : "제휴서비스/제품 버전",
"clientCompanyName" : "제휴서비스/제품 식별번호",
"sender":"U1001",
"receivers":["U2034","U2345","U2456","U2456"],
"mailTitle":"업무가 도착하였습니다.",
"mailMessage":"업무가 도착하였습니다.",
"message":"중요한 업무가 도착했습니다. 빠른 처리 부탁드립니다.",
"linkUrl":"https://daouoffice.com/app/board"
}
Response Parameters
| 변수 (Parameter) |
타입 (Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| code | String | Y | N | API 호출결과 코드 |
| message | String | Y | N | API 호출결과 메시지 |
| messageDetail | String | N | N | API 호출결과 메시지 상세내용 (실패한 경우만 리턴함) |
| data | Object | Y | N | API 호출결과 상세내용 JSON Object 배열 |
- data
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| validReceivers | Object | Y | N | API 호출결과 상세내용 JSON Object 배열 |
| invalidReceivers | Object | Y | N | API 호출결과 상세내용 JSON Object 배열 |
- validReceivers
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| Key | String | Y | N | 성공한 다우오피스 계정 사번(employeeNumber) |
| Value | String | Y | N | 성공 텍스트 반환 ("성공") |
- invalidReceivers
| 변수 (Parameter) |
타입(Type) | 필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| Key | String | N | N | 실패한 다우오피스 계정 사번(employeeNumber) |
| Value | String | N | N | 실패 텍스트 반환 (ex. “존재하지 않는 계정입니다.", “중지된 계정입니다.”) |
Response Example
Content-Type: application/json;charset=UTF-8
{
"code": "200",
"message": "OK",
"data": {
"validReceivers": { "U2034": "성공", "U2345": "성공"},
"invalidReceivers": { "U2456": "존재하지 않는 계정입니다.", "U2457": "중지된 계정입니다." }
}
}
Return Code
| 구분 | 코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
| 성공 (Success) |
200 | 성공 | OK |
| 실패 (Error) |
901 | 유효하지 않은 Client ID | 'XXXX'는 유효하지 않은 연동ID(clientId) 입니다. |
| 902 | 유효하지 않은 Client Secret | 연동 ID 'XXXX'의 패스워드가 일치하지 않습니다. | |
| 918 | 알림 연동 송신자(sender) 데이터가 누락되었습니다. | 알림 연동 송신자(sender) 값은 필수값입니다. | |
| 919 | 알림 연동 수신자(receivers) 데이터가 누락되었습니다. | 알림 연동 수신자(receivers) 값은 필수값입니다. | |
| 920 | 알림 연동 수신자(receivers)의 최대 인원 수 초과 | 알림 연동 수신자(receivers)의 최대 인원 수는 {}명입니다. | |
| 921 | 알림 연동 알림메세지(message) 데이터가 누락되었습니다. | 알림 연동 알림메세지(message) 값은 필수값입니다. | |
| 922 | 알림 연동 메일메세지(message, mailTitle, mailMessage) 데이터가 누락되었습니다. | 알림 연동 메일메세지(message, mailTitle, mailMessage) 값은 필수값입니다. | |
| 923 | 알림 연동 linkUrl은 http:// 혹은 https://를 포함 해야합니다. | 알림 연동 linkUrl은 http:// 혹은 https://를 포함해야합니다. | |
| 924 | 알림 연동 한달 최대 사용량 초과 | 알림 연동 한달 최대 사용량 {}건을 넘었습니다. | |
| 925 | 알림 연동 하루 최대 사용량 초과 | 알림 연동 하루 최대 사용량 {}건을 넘었습니다. |
제약 사항
| 구분 | 누적 호출 제한 횟수 | 비고 |
|---|---|---|
| 월간 | 1,500회 | - |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |