ClawOps Docs
API Reference

메시지 목록 조회

GET
/v1/accounts/{accountId}/messages

계정의 메시지 발송/수신 이력을 페이지네이션으로 조회합니다.

Authorization

BearerAuth
AuthorizationBearer <token>

API Key를 Bearer 토큰으로 전달

In: header

Path Parameters

accountId*string

계정 ID

Query Parameters

type?string

메시지 유형 필터

Value in"sms" | "lms" | "mms"
status?string

상태 필터

Value in"queued" | "sent" | "failed" | "received"
pageSize?integer

페이지당 항목 수

Default20
Rangevalue <= 100
page?integer

페이지 번호

Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/accounts/AC1a2b3c4d/messages?type=sms&status=completed&pageSize=20&page=0"
{
  "data": [
    {
      "messageId": "MGabcdef1234567890",
      "status": "queued",
      "type": "sms",
      "subject": "string",
      "to": "01012345678",
      "from": "07052358010",
      "body": "안녕하세요",
      "numMedia": 0,
      "mediaUrl": [],
      "direction": "outbound",
      "accountId": "AC1a2b3c4d",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "pageSize": 0,
    "total": 0
  }
}
{
  "error": "string",
  "code": "INVALID_PHONE_NUMBER"
}