푸시 알림 REST API
토큰 등록
유저의 토큰을 저장, 기존에 등록되지 않은 유저라면 새로 생성, 등록된 유저라면 토큰이 추가됩니다
Authorizations:
Authorization
Request Body schema: application/json;charset=UTF-8
| user_id required | string 사용자 ID |
| push_type required | string [ 0 .. 10 ] characters 토큰의 push type(ANDROID, IOS) |
| push_token required | string\S+ 구글에서 발급 받은 push key |
Responses
Request samples
- Payload
Content type
application/json;charset=UTF-8
{- "user_id": "user1",
- "push_type": "ANDROID",
- "push_token": "eYyyyyyyy"
}Response samples
- 201
- 400
- 422
Content type
application/json;charset=UTF-8
201푸시 알림 전송
유저 정보를 바탕으로 푸시 알림을 보냄
Authorizations:
Authorization
Request Body schema: application/json;charset=UTF-8
| recipient_ids required | Array of strings 수신할 사용자 ID |
| push_type required | string 토큰의 push type(ANDROID | IOS) |
| title required | string 제목 |
| body required | string 제목 |
object 데이터 |
Responses
Request samples
- Payload
Content type
application/json;charset=UTF-8
{- "recipient_ids": [
- "user1",
- "user2"
], - "push_type": "ANDROID",
- "title": "푸시 제목입니다.",
- "body": "푸시 내용입니다.",
- "data": {
- "body": "===test data==="
}
}Response samples
- 202
- 400
- 422
Content type
application/json;charset=UTF-8
{- "transactions": [
- {
- "recipient_id": "string",
- "transaction_id": "string",
- "transaction_type": "string",
- "status": "string"
}
]
}Response samples
- 200
- 204
- 400
Content type
application/json;charset=UTF-8
{- "request_id": "010c01887c18226c-24e00a60-1f81-44e8-b6c2-c7c3024a7ed2-000000",
- "transaction_at": "2023-06-02T12:32:16+09:00[Asia/Seoul]",
- "recipient_id": "sichoi@maxst.com",
- "transaction_id": "b27fbcd2-8859-4ce8-bc29-175042ec039a",
- "status": "SUCCESS"
}