| API Key |
### **요청 헤더**
| 이름 | 설명 | 필수 |
| --------- | ----------------------- | -- |
| x-api-key | x-api-key: ${x-api-key} | O |
### **요청 경로 변수**
| 이름 | 설명 | 필수 |
| ---------- | --------------- | -- |
| dispatchId | API 발송 요청에 대한 키 | O |
### **응답**
하나의 회원 ID에 여러 디바이스가 있는 경우 회원의 모든 디바이스에 발송하기 때문에 회원 ID가 중복일 수 있습니다.
| 이름 | 타입 | 설명 |
| ---------- | ---------------- | --------------- |
| dispatchId | String | API 발송 요청에 대한 키 |
| results | PushApiResult\[] | 발송 건 각각의 결과 리스트 |
**PushApiResult**
| 이름 | 타입 | 설명 |
| ---------- | ------ | ------------------------------------------------------------------- |
| memberId | String | 회원 ID (회원번호) |
| deviceType | String | 디바이스 타입
- ANDROID : 안드로이드
- IOS : iOS
|
| pushToken | String | 푸시 토큰 |
| status | String | 발송 결과
- SENDING : 발송 중
- SUCCEED : 성공
- FAILED : 실패
|
### **예제**
**응답(성공)**
```
{
"httpStatus": {
"code": "200",
"reasonPhrase": "OK"
},
"processCode": "0",
"processValue": {
"dispatchId" : "9ba020b4ef0a40b4872b3d8de1f2322f",
"results" : [
{
"memberId" : "groobee1",
"deviceType" : "IOS",
"pushToken" : "ccmxg2-fQY6nA5vlmkXQ9w:APA91bHM3dtNcwWLiCfXe2NIu8689Z0PRBMUsICwu-hQAS9ut0m6TGjtbyXsFRl6oDLFWq37MH03m46mrQY_sGcm3JOiyo8kR8Hgny_22q1ku2I_k1yNDYo-PXc1gE9OsdP8XEctbbP5",
"status" : "SUCCEED"
},
{
"memberId" : "groobee1",
"deviceType" : "ANDROID",
"pushToken" : "fEVPUBO3ToeEPOpsnN2yi8:APA91bERcry4jdQOVt9yVqTm8k-vL1_C_Bv0j5_cDlJCibOd1y-MdYGgfQC7Me0PgbzABCEDMWOcGs47rrpGiagug4ujxaoltX0fcoLdHCKHhtoKpomepzRfEPh8qB0o9G5loHH3NeId",
"status" : "FAILED"
},
{
"memberId" : "groobee2",
"deviceType" : "ANDROID",
"pushToken" : "dCwXIsfJRHymW6SWL6GscT:APA91bFaaPr8wdvKZ0jtxXGCpaG-k-lZAzuiAd_ntdXOWwqWl_xhrPFv2k_p_f12vivKq43LAVN9eDZBvPr5VRhrgKhxzo9_Dg_zzvxByIxVF0-Ove0v-rWnk8k5y-2q0hH_CEW8i_oG",
"status" : "SENDING"
},
{
"memberId" : "groobee3",
"deviceType" : "IOS",
"pushToken" : "dky9RrH0G0iLgkaOy5bC3L:APA91bGks_dHQpP9kkS7cwSCweX_0g7RQrzWLS9kkTXEnEesKWPTFeStpXO1VSRVgrP5m-0FB5gimj2Ot3tFwUmEa1n-YjIOIqcY50d2Mj4IgiC0nMhy0FAW_nw0kq8eaBi4N1ZKaHiH",
"status" : "SUCCEED"
},
...
]
}
}
```
**응답(실패)**
{% hint style="danger" %}
API 트리거는 별도 과금되는 서비스입니다.\
과금하지 않았을 시 에러를 리턴합니다.
{% endhint %}
```
{
"httpStatus": {
"code": "401",
"reasonPhrase": "Unauthorized"
},
"processCode": "1402",
"processValue": "해당 서비스는 과금이 필요합니다."
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.groobee.ai/developer-guide/api-guide/push-api-trigger.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.