메시지 전송

    메시지 Bot이 특정 사용자에게 메시지를 전송할 수 있다.

    accountId에 계정 정보를 입력하여 메시지를 전송한다. 계정 정보는 이메일 형태 또는 그룹명 형태로 되어 있다.

    클라이언트 버전 2.6부터는 Carousel과 Image Carousel을, 버전 3.0부터는 Flexible Template을 사용하여 사용자에게 보다 다양한 정보를 보낼 수 있다. 또한 메시지 공통 속성으로 각 타입에 빠른 답장(quick reply)을 추가하여 사용자에게 추가 정보를 전달할 수 있다.

    각 템플릿 또는 빠른 답장 버튼을 이용하여 postback 메시지를 callback으로 서버에서 수신할 수 있다. postback 형식은 메시지 수신 - Callback 형태를 참고한다.

    주의

    • 사용자 수에 따라 API 사용 횟수에 제한이 있다.
      • 사용자 100명 이하: 일 최대 20,000회
      • 사용자 100명 초과: 일 최대 20,000회 + 초과 사용자 1명당 100회
      • 사용 횟수는 GMT +9 기준 0시에 초기화된다.
      • 사용 횟수 80%, 90%, 100% 소진 시 관리자에게 서비스 알림 메시지를 전송한다.

    각 템플릿과 빠른 답장의 구조는 다음과 같다.

    [그림 1 button template]

    [그림 2 list template]

    [그림 3 Carousel template]

    [그림 4 Image carousel template]

    [그림 5 Flexible template]

    [그림 6 quick reply]

    API 종류

    서버 API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Path Parameters - 공통

    파라미터 필수 여부 설명
    botNo Y 메시지 전송 시 사용할 메시지 Bot 번호

    Request - 공통

    파라미터 타입 필수 여부 설명
    accountId string N 메시지를 보낼 사용자의 계정
    channelId, accountId 중 하나만 지정해야 하며, 필수다.
    channelId string N 메시지를 보낼 대화방 ID
    channelId, accountId 중 하나만 지정해야 하며, 필수다.
    content object Y 메시지 내용
    ○ type "text": "메시지 전송(Text)"의 Request Content 참고
    ○ type "image": "메시지 전송(Image)"의 Request Content 참고
    ○ type "link": "메시지 전송(Link)"의 Request Content 참고
    ○ type "sticker": "메시지 전송(Sticker)"의 Request Content 참고
    ○ type "buttonTemplate": "메시지 전송(Button Template)"의 Request Content 참고
    ○ type "listTemplate": "메시지 전송(List Template)"의 Request Content 참고
    ○ type "carousel": "메시지 전송(Carousel)"의 Request Content 참고(new)
    ○ type "image carousel": "메시지 전송(Image Carousel)"의 Request Content 참고(new)
    ○ type "file": "메시지 전송(File)"의 Request Content 참고(new)
    ○ type "flex": "메시지 전송(Flexible Template > API)"의 Request Content 참고(new)