플로우

Notification > Notification Hub > API v1.0 사용 가이드 > 플로우

플로우 생성

플로우를 생성합니다.
플로우 생성 시 플로우 아이디를 응답합니다.

steps라는 필드에 플로우 단계를 정의할 수 있습니다.
steps에 정의한 순서대로 메시지 발송을 진행합니다.
수신자마다 첫 번째 단계부터 메시지 발송을 시도하며, 발송과 수신을 성공하면 다음 단계로 넘어가지 않고 완료됩니다. 실패하면 다음 단계로 넘어갑니다.

요청

POST /flow/v1.0/flows
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}

• 위 예시는 이메일, 알림톡, SMS 템플릿을 사용하는 플로우를 생성하는 예시입니다.
• 한번 사용된 메시지 채널은 다음 단계에서 사용할 수 없습니다.
• 한 단계는 여러 개의 다음 단계를 가질 수 있습니다.
• 순서 없이 동시 발송을 원하는 경우 첫 번째 단계인 steps에 모든 메시지 채널을 추가합니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "flowId" : "플로우의 아이디"
}

플로우 정의 예시

선형적인 순서를 가진 플로우

{
  "flowName": "선형적인 순서를 가진 플로우",
  "messagePurpose": "NORMAL",
  "description": "PUSH > EMAIL > SMS 순으로 발송됩니다.",
  "steps": [{
    "messageChannel": "PUSH",
    "templateId": "템플릿의 아이디",
    "nextSteps": [{
      "messageChannel": "EMAIL",
      "templateId": "템플릿의 아이디",
      "nextSteps": [{
        "messageChannel": "SMS",
        "templateId": "템플릿의 아이디",
        "nextSteps": null
      }
      ]
    }
    ]
  }
  ]
}

동시 발송 플로우

{
  "flowName": "동시 발송",
  "messagePurpose": "NORMAL",
  "description": "PUSH, EMAIL, SMS 순서 없이 동시에 발송됩니다.",
  "steps": [{
    "messageChannel": "PUSH",
    "templateId": "템플릿의 아이디",
    "nextSteps": null
  }, {
    "messageChannel": "EMAIL",
    "templateId": "템플릿의 아이디",
    "nextSteps": null
  }, {
    "messageChannel": "SMS",
    "templateId": "템플릿의 아이디",
    "nextSteps": null
  }
  ]
}

요청 예시

### 플로우 생성

POST {{endpoint}}/flow/v1.0/flows
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}

curl -X POST "${endpoint}/flow/v1.0/flows" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}'

플로우 목록 조회

플로우 목록을 조회합니다.
플로우 목록 조회 시 플로우 아이디, 플로우 이름, 플로우 설명, 플로우 단계를 응답합니다.

요청

GET /flow/v1.0/flows
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "flows" : [ {
    "flowId" : "플로우의 아이디",
    "flowName" : "플로우 이름",
    "messagePurpose" : "NORMAL",
    "description" : "플로우 설명",
    "steps" : [ {
      "messageChannel" : "PUSH",
      "template" : {
        "templateId" : "템플릿의 아이디",
        "templateName" : "템플릿 이름"
      },
      "nextSteps" : [ {
        "messageChannel" : "EMAIL",
        "template" : {
          "templateId" : "템플릿의 아이디",
          "templateName" : "템플릿 이름"
        },
        "nextSteps" : [ {
          "messageChannel" : "ALIMTALK",
          "template" : {
            "templateId" : "템플릿의 아이디",
            "templateName" : "템플릿 이름"
          },
          "nextSteps" : [ {
            "messageChannel" : "SMS",
            "template" : {
              "templateId" : "템플릿의 아이디",
              "templateName" : "템플릿 이름"
            },
            "nextSteps" : null
          } ]
        } ]
      } ]
    } ],
    "messageChannels" : [ "PUSH", "EMAIL", "ALIMTALK", "SMS" ],
    "createdDateTime" : "2021-01-01T00:00:00.000Z",
    "updatedDateTime" : "2021-01-01T00:00:00.000Z"
  } ],
  "totalCount" : 10
}

요청 예시

### 플로우 목록 조회

GET {{endpoint}}/flow/v1.0/flows
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

curl -X GET "${endpoint}/flow/v1.0/flows" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}" 

플로우 조회

플로우를 조회합니다.
플로우 조회 시 플로우 아이디, 플로우 이름, 플로우 설명, 플로우 단계를 응답합니다.

요청

GET /flow/v1.0/flows/{flowId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "flow" : {
    "flowId" : "플로우의 아이디",
    "flowName" : "플로우 이름",
    "messagePurpose" : "NORMAL",
    "description" : "플로우 설명",
    "steps" : [ {
      "messageChannel" : "PUSH",
      "template" : {
        "templateId" : "템플릿의 아이디",
        "templateName" : "템플릿 이름"
      },
      "nextSteps" : [ {
        "messageChannel" : "EMAIL",
        "template" : {
          "templateId" : "템플릿의 아이디",
          "templateName" : "템플릿 이름"
        },
        "nextSteps" : [ {
          "messageChannel" : "ALIMTALK",
          "template" : {
            "templateId" : "템플릿의 아이디",
            "templateName" : "템플릿 이름"
          },
          "nextSteps" : [ {
            "messageChannel" : "SMS",
            "template" : {
              "templateId" : "템플릿의 아이디",
              "templateName" : "템플릿 이름"
            },
            "nextSteps" : null
          } ]
        } ]
      } ]
    } ],
    "messageChannels" : [ "PUSH", "EMAIL", "ALIMTALK", "SMS" ],
    "createdDateTime" : "2021-01-01T00:00:00.000Z",
    "updatedDateTime" : "2021-01-01T00:00:00.000Z"
  }
}

요청 예시

### 플로우 조회

GET {{endpoint}}/flow/v1.0/flows/{{flowId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

curl -X GET "${endpoint}/flow/v1.0/flows/${flowId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}" 

플로우 수정

플로우를 수정합니다.

요청

PUT /flow/v1.0/flows/{flowId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "flowId" : "플로우의 아이디"
}

요청 예시

### 플로우 수정

PUT {{endpoint}}/flow/v1.0/flows/{{flowId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}

curl -X PUT "${endpoint}/flow/v1.0/flows/${flowId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "flowName" : "플로우 이름",
  "description" : "플로우 설명",
  "messagePurpose" : "NORMAL",
  "steps" : [ {
    "messageChannel" : "PUSH",
    "templateId" : "템플릿의 아이디",
    "nextSteps" : [ ]
  } ]
}'

플로우 삭제

플로우를 삭제합니다.

요청

DELETE /flow/v1.0/flows/{flowId}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

요청 예시

### 플로우 삭제

DELETE {{endpoint}}/flow/v1.0/flows/{{flowId}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

curl -X DELETE "${endpoint}/flow/v1.0/flows/${flowId}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}" 

플로우 삭제

플로우를 삭제합니다.

요청

POST /flow/v1.0/flows/do-delete
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

요청 본문

{
  "flowIds" : [ "플로우의 아이디" ]
}

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "results" : [ {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  } ]
}

요청 예시

### 플로우 삭제

POST {{endpoint}}/flow/v1.0/flows/do-delete
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

{
  "flowIds" : [ "플로우의 아이디" ]
}

curl -X POST "${endpoint}/flow/v1.0/flows/do-delete" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \ 
-d '{
  "flowIds" : [ "플로우의 아이디" ]
}'