메시지 조회

Last updated 2 months ago

get
getMessageList

https://rest.coolsms.co.kr
/messages/v4/list
Request
Response
Headers
Authorization
required
string
쿨에스엠에스 인증 정보
Query Parameters
criteria
optional
string
메시지 검색 조건에 사용되는 key 의 값 입니다. (e.g messageId, statusCode) 자세한 사용 방법은 하단의 설명을 참고해주세요.
cond
optional
string
메시지 검색 조건에 사용되는 연산자 입니다. 자세한 사용 방법은 하단의 설명을 참고해주세요.
value
optional
string
검색 값 입니다. 자세한 사용 방법은 하단의 설명을 참고해주세요.
offset
optional
number
데이터 조회 시작점
limit
optional
number
조회할 데이터 수
200: OK
{
offset: 0,
limit: 20,
messageList: {
M4V20180307110044DTYYJBBYLPQZIB1: {
_id: 'M4V20180307110044DTYYJBBYLPQZIB1',
kakaoOptions: [Object],
type: null,
country: '82',
subject: null,
imageId: null,
dateProcessed: null,
dateReported: null,
dateReceived: null,
statusCode: 'TEST1000',
networkCode: null,
log: [],
replacement: false,
autoTypeDetect: true,
messageId: 'M4V20180307110044DTYYJBBYLPQZIB1',
groupId: 'G4V20180307105937H3PTASXMNJG2JIO',
accountId: '12925149',
text: 'text',
from: '01000000000',
to: '01000000000',
customFields: { },
dateCreated: '2018-10-08T03:13:07.256Z',
dateUpdated: '2018-10-08T03:13:07.256Z',
reason: null,
networkName: 'ETC'
}
},
hasNext: 0
}
400: Bad Request
{
errorCode: "ValidationError",
errorMessage: 상황마다 다른 메시지가 출력됩니다.
}
403: Forbidden
{
errorCode: "Forbidden",
errorMessage: "잘못된 접근입니다."
}

Body parameter 설명

criteria

criteria 의 값은 "key1,key2,key3" 과 같이 ,(콤마) 로 구분되며 cond, value 와 함께 사용됩니다.

  • messageId - 메시지 아이디 입니다.

  • groupId - 그룹 아이디 입니다.

  • to - 수신 번호 입니다.

  • from - 발신 번호 입니다.

  • type - 문자 메시지의 타입 입니다. (SMS, LMS, MMS, ATA, CTA)

  • dateCreated - 그룹 생성일 입니다.

  • dateUpdated - 그룹 정보를 변경한 마지막 시각 입니다.

  • replacement - 대체 발송 여부 입니다. (true, false)

  • statusCode - 문자 메시지의 상태 코드 입니다.

cond

criteria 와 같이 "cond1,cond2" 와 같이 ,(콤마)로 구분되며, criteria,value 와 함께 사용됩니다.

  • eq - 같음 (=)

  • ne - 같지 않음 (!=)

  • gt - 보다 큼 (>)

  • gte - 보다 크거나 같음 (>=)

  • lt - 보다 작음 (<)

  • lte - 보다 작거나 같음 (<=)

value

criteria , cond 값에 대응하는 value 입니다.

criteria="messageId,statusCode"

cond="eq,eq"

일 경우 groupId 에 대응하는 value 값을 찾고 status 에 대응하는 값을 찾는 조건 입니다.

e.g - value="메시지아이디,2000"

예제 코드

[JavaScript] get_group_message.js

[Python] get_group_message.js

[Java] get_group_message.java

[PHP] get_group_message.php

[Ruby] get_group_message.rb