메시지 목록 조회

GET

https://api.claw-ops.com/v1/accounts/:accountId/messages

GET

/v1/accounts/:accountId/messages

$ curl -G https://api.claw-ops.com/v1/accounts/AC1a2b3c4d/messages \
>      -H "Authorization: Bearer <token>" \
>      -d limit=100 \
>      -d number=07052358010 \
>      -d page=0 \
>      -d pageSize=20 \
>      -d page_size=50 \
>      -d status=sent \
>      -d type=sms

1 {
2   "data": [
3     {
4       "messageId": "MGabcdef1234567890",
5       "status": "queued",
6       "type": "sms",
7       "subject": "string",
8       "to": "01012345678",
9       "from": "07052358010",
10       "body": "안녕하세요",
11       "numMedia": 0,
12       "mediaUrl": [],
13       "direction": "outbound",
14       "accountId": "AC1a2b3c4d",
15       "dateCreated": "2024-01-15T09:30:00Z",
16       "dateUpdated": "2024-01-15T09:30:00Z"
17     }
18   ],
19   "meta": {
20     "page": 1,
21     "pageSize": 1,
22     "total": 1
23   }
24 }

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

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

계정 ID

Query parameters

typeenumOptional

메시지 유형 필터

Allowed values:

statusenumOptional

상태 필터

Allowed values:

numberstringOptional

발신 또는 수신 번호 필터. 하이픈 유무를 모두 매칭합니다.

pageSizeintegerOptional<=100Defaults to 20

페이지당 항목 수

page_sizeintegerOptional<=100Deprecated

pageSize 의 별칭(하위호환). 신규 연동은 pageSize 를 사용하세요.

limitintegerOptional<=100Deprecated

pageSize 의 별칭(하위호환). 신규 연동은 pageSize 를 사용하세요.

pageintegerOptionalDefaults to 0

페이지 번호

Response

메시지 목록

datalist of objectsOptional

metaobjectOptional

Errors

401

Unauthorized Error