1-2. 수신 대상자 정보 발송

발송 방법 및 전송/수신 파라미터 정의

앞서 메시지 정보를 보내고 해당 메시지에 대한 IDX를 얻었다면, 보내야 할 대상자들을 100개 한 묶음으로 메시지 IDX와 함께 API서버로 SSL Protocol을 이용하여 파라미터들을 API Server에 전달합니다.

API Server로 전달해야 할 파라미터들은 아래 표를 참조해 주세요.

HTTPS Headers

파라미터명	필수 여부	설명
Content-Type	필수	application/json
authorization	필수	Bearer {token} 토큰 발급 API에서 발급받은 JWT 토큰 값

HTTPS Parameters

[표 1.5] 다수 발송 메시지 HTTPS, Parameters

파라미터명	필수 여부	Data Type	설명
msgIdx	필수	text(18)	메시지를 셋팅하고 돌려받은 메시지 idx 값
msgData	필수	list	발송용 메시지 JSON Array
msgData.msgKey	필수	text	구분용 키
msgData.recipient	필수	text(20)	수신자 번호
msgData.elementSet	선택	object	치환문구 JSON 문자 제목, 본문 내 존재하는 치환 변수 및 암호화가 필요한 값을 지정

문자 제목, 본문 내에 '#{변수명}' 형태의 치환 변수가 존재할 경우, 치환변수 JSON 파라미터 내에 {"치환변수명": "실제 치환 값"} 형태로 입력되어야 합니다.

• 메시지 기본 정보에 등록된 치환 변수가 elementSet에 포함되지 않는 경우 수신자 목록에서 제외

• ex) {"#{이름}": "홍길동"}

Request JSON Sample

{
  "msgIdx": "12345678910",
  "msgData": [
    {
      "msgKey": "mms_key_001",
      "recipient": "01012345678",
      "elementSet": {
        "#{이름}": "홍길동"
      }
    },
    {
      "msgKey": "mms_key_002",
      "recipient": "01087654321",
      "elementSet": {
        "#{이름}": "김철수"
      }
    }
  ]
}

Response JSON

API 서버에서 전달 받은 파라미터 처리 후 결과를 JSON 형태로 제공합니다. 만일 발송 대상이 남아 있다면, 해당 결과 수신 후 남은 대상자에 따라 몇 회에 걸쳐 수신 대상자 목록을 발송합니다. (한 번에 최대 100건 단위)

성공

{
  "code": "200",
  "message": "대상자 등록이 처리되었습니다. 대상자를 계속 등록하실 수도, 메시지 등록을 완료하실 수도 있습니다.",
  "data": {
    "processCode": "20002",
    "msgIdx": "12345678910"
  }
}

일부 실패 데이터 포함

{
  "code": "200",
  "message": "대상자 등록이 처리되었습니다.",
  "data": {
    "processCode": "20002",
    "msgIdx": "12345678910",
    "failList": [
      {
        "code": "C3006",
        "desc": "유효하지 않은 recipient",
        "msgKey": "mms_key_002"
      }
    ]
  }
}

[표 1.6] 발송 JSON 결과

값	설명
code	결과 코드
message	결과 메시지
data.msgIdx	메시지 번호
data.processCode	메시지 처리 단계 코드
data.failList	실패 데이터 리스트 (실패 데이터 있을 경우) ex) {"code": "C3014", "desc": "유효하지 않은 msgKey", "msgKey": ""}

[표 1.7] 발송 JSON 결과의 실패 데이터 리스트 처리 결과 코드

코드	내용	비고
C200	정상처리 됨
C3006	유효하지 않은 recipient
C3014	유효하지 않은 msgKey
C3024	유효하지 않은 치환변수