Kakao

카카오 메시지 발송 상세 조회

Changed on

카카오톡 메시지 발송 그룹의 상세 정보를 조회합니다. 발송 상태, 성공/실패 건수, 포인트 사용 내역 등을 확인할 수 있습니다.

get/v2/messages/kakao/groups/{groupId}

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/messages/kakao/groups/{groupId}
  • Auth
    HTTP basic

Path parameters

groupIdstring required

조회할 메시지 그룹의 ID입니다. 메시지 발송 시 반환받은 UUID 형식의 그룹 ID를 사용하세요.

Response

메시지 그룹 상세 조회 요청의 처리 결과입니다. 그룹의 발송 상태와 통계 정보가 포함됩니다.

codenumber required

HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다.

messagestring required

API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다.

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "userId": 12345,
    "profileId": "profile_abc123",
    "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111",
    "message": "안녕하세요 고객님, 주문이 완료되었습니다.",
    "messageType": "AT",
    "requestDomain": "api.example.com",
    "senderNumber": "01011112222",
    "reservedStatus": "COMPLETED",
    "groupStatus": "COMPLETED",
    "countRequest": 1000,
    "messageCount": 950,
    "succeededCount": 900,
    "failedCount": 30,
    "canceledCount": 20,
    "fallbackCount": 25,
    "unitCost": 15,
    "usedPoints": 1650,
    "refundPoints": 450,
    "vatPoint": 150,
    "totalPoint": 1650,
    "refundPoint": 450,
    "fallback": {
      "type": "LMS",
      "senderNumber": "01011112222",
      "message": "주문이 완료되었습니다. 자세한 내용은 앱을 확인해주세요.",
      "title": "주문 완료 알림",
      "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76222"
    },
    "isUseApi": true,
    "createdAt": "2024-01-15T09:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Changes

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id getGroupInfo removed and replaced with GroupController_getGroup

    • info

      the endpoint scheme security basic was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value 200 was removed for the status

    • info

      the response's property default value 성공 was removed for the status