문자 발송 API

이 페이지에서는 문자 발송에 대한 Open API 스펙을 명시합니다.

사전 작업

토큰 발급

서버에서 발송API를 요청하기 전, 먼저 프로젝트에 유효한 토큰을 발급받아 주세요.

인증 토큰 발급 방법

채널 설정

• 메시지 발송을 위해서는 발신번호를 사전 등록해야 합니다

• 콘솔 경로 :

  • 발신 프로필 등록 : [마켓탭 콘솔 > 채널 관리 > 문자 메시지 설정 ]

    

문자 메시지 발송 API

Method: POST

Content-Type: application/json

[
  {
    "sender_profile_id": "g75znkc",
    "campaign_id": "test_campaign_id",
    "sub_channel_type": "LMS",
    "user_id": "user_124",
    "phone_number": "01000000000",
    "message": {
      "title": "회원가입",
      "content": "안녕하세요, 고객님!\n회원가입 진심으로 축하드립니다.\n\n{{vcq2hgl9}}",
      "opt_out_message": "(무료거부: 수신거부 080-000-0000)"
    },
    "tracking_options": [
      {
        "id": "vcq2hgl9",
        "redirectUrl": "https://naver.com/"
      }
    ],
    "is_ad_message": true
  },
  {
    "sender_profile_id": "g75znkc",
    "campaign_id": "test_campaign_id",
    "sub_channel_type": "MMS",
    "user_id": "user_124",
    "phone_number": "01000000000",
    "message": {
      "title": "회원가입",
      "content": "안녕하세요, 고객님!\n회원가입 진심으로 축하드립니다.",
      "image_url": "https://mud-kage.kakao.com/dn/45Tx8/btsNSHSFCtG/z2kEOEkGdoV6POAUQdPQsd/img_l.jpg"
    },
    "tracking_options": [],
    "is_ad_message": false
  }
]

Payload 필드 설명

필드명	설명	필수 여부
sender_profile_id	문자 메시지 발신 프로필 ID	required
sub_channel_type	문자 메시지 하위 채널 타입 ( SMS, LMS, MMS ) 메시지 하위 채널 타입은 실제 발송할 메시지의 내용 및 길이에 따라 자동으로 변경될 수 있습니다. 기본적으로 SMS 타입으로 설정하여 발송하더라도, message.content의 길이가 90 byte를 초과하는 경우 자동으로 LMS 타입으로 변경되어 발송됩니다. 메시지에 제목을 입력한 경우에는 메시지 길이에 관계없이 LMS 타입으로 발송되며, 최대 2000byte까지 지원됩니다. 메시지에 이미지를 입력한 경우는 MMS 타입으로 발송됩니다.
campaign_id	메세지 발송 결과를 캠페인 ID 단위로 확인하고 싶을때 사용하실수 있습니다.
user_id	메세지 발송 결과를 확인할 유저 ID	required
phone_number	발송 대상 전화 번호 ( ex 01012345678 )	required
message	실제 발송할 메시지 내용 title: 문자 메시지 제목 content: 문자 메시지 본문 image_url: 문자 메시지 이미지 URL 문자 메시지 이미지 업로드 API를 통해 이미지를 업로드한 후 반환된 URL을 입력해주세요. opt_out_message: 수신거부 문구	required
tracking_options	추적 URL 옵션. 해당 옵션을 추가하는 경우 url 랜딩을 추적해서 성과를 측정할 수 있습니다. 메시지 본문(content)에서 단축 URL로 설정 할 부분을 {{ 랜덤 문자열 }} 형식으로 지정합니다. 이후,tracking_options에 해당 랜덤 문자열과 매핑 될 실제 URL을 추가합니다.
is_ad_message	광고성 메시지 여부. true 일 경우 광고성 메시지, false 일 경우 정보성 메시지로 판단합니다. 기본값은 false 입니다. true (광고성 메시지인 경우) 광고성 야간 발송 정책이 적용됩니다 (오후 8시 30분 ~ 오전 8시 발송 제한). 본문 맨 앞 (광고) 문구가 자동 삽입됩니다. message.opt_out_message (수신거부 문구) 필드 값이 본문 하단에 삽입되고, null 인 경우 삽입하지 않습니다. false (정보성 메시지인 경우) 본문 앞 (광고) 문구가 삽입되지 않습니다. message.opt_out_message (수신거부 문구) 필드 값이 존재하더라도 삽입되지 않습니다.

주의사항 및 기타 안내

• 발송 API는 실시간으로 처리되며, 요청당 최대 100개의 전화번호로 발송이 가능합니다.

• 수신 번호가 유효하지 않거나 템플릿이 승인되지 않은 경우 실패 응답이 반환됩니다.

• 묶음 발송인 경우 병렬처리가 아닌 순차적 발송으로 단건 발송에 비해 응답 속도가 느릴수 있는점 참고 부탁드립니다.

• 트래픽 집중 시간대에는 발송이 지연될 수 있습니다.

Open API 스펙

Send a text message

post

Sends a simple text message to a specified phone number.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

project_idstringRequired

프로젝트 ID

Example: o8nn3s3

Bodyobject[]

application/json

phone_numberstringRequiredExample: 01012341234

sub_channel_typestring · enumOptionalPossible values:

sender_profile_idstringRequiredExample: sender_profile_id

campaign_idstringOptional

user_idstringRequired

is_ad_messagebooleanOptional

광고 메시지 여부. true인 경우 본문 앞에 (광고)가 추가되고, 야간 시간대(20:50~08:00) 발송이 제한됩니다.

Default: false

Responses

200

The request has been accepted for processing.

application/json

codeintegerOptionalExample: 200000

messagestringOptionalExample: Success

400

Invalid request parameters.

application/json

401

Unauthorized request.

application/json

500

Internal server error

application/json

post

/api/v1/sender/text-message

HTTPcURLJavaScriptPython

POST /api/v1/sender/text-message?project_id=text HTTP/1.1
Host: crm.marketap.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 770

[
  {
    "sender_profile_id": "n95B4PQ",
    "campaign_id": "sender_campaign_id",
    "sub_channel_type": "SMS",
    "user_id": "user_124",
    "phone_number": "01072053615",
    "message": {
      "opt_out_message": "(무료거부: 수신거부 080-000-0000)",
      "content": "테스트 문자 메시지 발송입니다.\n\n{{vcq2hgl9}}"
    },
    "is_ad_message": true,
    "tracking_options": [
      {
        "id": "vcq2hgl9",
        "redirect_url": "https://naver.com/"
      }
    ]
  },
  {
    "sender_profile_id": "n95B4PQ",
    "campaign_id": "sender_campaign_id",
    "sub_channel_type": "SMS",
    "user_id": "user_123",
    "phone_number": "01072053615",
    "message": {
      "opt_out_message": "(무료거부: 수신거부 080-000-0000)",
      "content": "테스트 문자 메시지 발송입니다.\n\n{{vcq2hgl9}}"
    },
    "is_ad_message": false,
    "tracking_options": [
      {
        "id": "vcq2hgl9",
        "redirect_url": "https://naver.com/"
      }
    ]
  }
]

{
  "code": 200000,
  "message": "Success",
  "data": [
    {
      "message_id": "text",
      "user_id": "text",
      "phone_number": "text",
      "status": 1,
      "message": "text"
    }
  ]
}