Documentation Powered by ReDoc

Noefect Push API (1.0.0)

Download OpenAPI specification:Download

Authentication

Oauth2

Security Scheme Type OAuth2
password OAuth Flow
Token URL: http://account-dev.neofect.com/oauth/token
Scopes:
  • all -

    요청한 자원에 대한 모든 권한.

UserToken

userid, fcm token 매핑

Authorizations:
Oauth2 (all)
Request Body schema: application/json
service_name
required
string
user_id
required
number
token
required
string

Responses

Request samples

Content type
application/json
{
  • "service_name": "string",
  • "user_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

fcm

firebase cloud message를 통해 notification push 전송

Authorizations:
Oauth2 (all)
path Parameters
service_name
required
string
Example: connect

서비스명(therapist, connect, home, clinic)

Request Body schema: application/json

notification 전달, title, content를 명시적으로 전달. notification은 앱이 특별한 처리 없이 noti가 화면에 뜸

user_ids
Array of numbers
type
required
string
title
required
string
body
required
string

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ],
  • "type": "string",
  • "title": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

firebase cloud message를 통해 data push 전송

Authorizations:
Oauth2 (all)
path Parameters
service_name
required
string
Example: connect

서비스명(therapist, connect, home, clinic)

Request Body schema: application/json

data 전달, 앱은 백단에서 push data를 처리후 클라이언트에게 노출

user_ids
Array of numbers
type
string
data
required
object

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ],
  • "type": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

history

읽지 않은 메세지 갯수 조회

Authorizations:
Oauth2 (all)

Responses

Response samples

Content type
application/json
{
  • "unread_count": 0
}

푸시 이력 조회

Authorizations:
Oauth2 (all)
query Parameters
service_name
required
string
Example: service_name=connect

서비스명(therapist, connect, home, clinic)

page
required
integer <int32>
Example: page=1

페이지 번호

size
required
integer <int32>
Example: size=10

페이지당 줄 수

Responses

Response samples

Content type
application/json
{
  • "page_info": {
    },
  • "contents": [
    ]
}

is_read 필드 업데이트

Authorizations:
Oauth2 (all)
path Parameters
historyId
required
string
Example: 94977e19-0c24-46eb-81c9-7d525a874b07

history id

Request Body schema: application/json
is_read
required
boolean

Responses

Request samples

Content type
application/json
{
  • "is_read": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

요청자의 모든 메세지 이력 읽음으로 처리

Authorizations:
Oauth2 (all)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}