OBCon Open API 2


Email 발송 (Reserved)

Request

  • Method : POST
  • Path : /services/emails
  • Parameters
이름타입위치필수설명
x-obcon-accessKeyStringHeader필수Access Key
x-authorizationStringHeader필수Bearer ${token}
toStringBody필수받는 사람
,로 구분
ccStringBody옵션참조
,로 구분
bccStringBody옵션숨은 참조
,로 구분
serviceStringBody옵션서비스 (Default. OBCon)
templateStringBody옵션이메일 템플릿
titleStringBody필수이메일 제목
htmlStringBody필수이메일 내용
timestampIntegerQuery필수타임스탬프 (13자리 숫자)
nonceStringQuery필수임의의 랜덤한 문자열
hmacStringQuery필수HMA-SHA256
  • x-authorization 값은 Token 앞에 반드시 "Bearer " 문자를 붙여 주세요.

  • 이메일 주소 구조 : 이름 <이메일> 또는 이메일

  • HMAC 생성시 fields

    • x-obcon-accessKey, to, [cc], [bcc], [service], [template], title, timestamp, nonce
    • "[ ]"로 표시된 항목은 옵션 항목으로 없는 경우, 제외 하세요.

Response

  • data
    • count : 이메일 발송 건수


SMS 발송 (Reserved)

Request

  • Method : POST
  • Path : /services/sms
  • Parameters
이름타입위치필수설명
x-obcon-accessKeyStringHeader필수Access Key
x-authorizationStringHeader필수Bearer ${token}
senderStringBody옵션보내는 사람 전화번호
receiversStringBody필수받는 사람 전화번호
,로 구분
serviceStringBody옵션서비스
messageStringBody필수메시지
timestampIntegerQuery필수타임스탬프 (13자리 숫자)
nonceStringQuery필수임의의 랜덤한 문자열
hmacStringQuery필수HMA-SHA256
  • x-authorization 값은 Token 앞에 반드시 "Bearer " 문자를 붙여 주세요.

  • 전화번호 구조 : 이름 <전화번호> 또는 전화번호

  • HMAC 생성시 fields

    • x-obcon-accessKey, [sender], receivers, [service], message, timestamp, nonce
    • "[ ]"로 표시된 항목은 옵션 항목으로 없는 경우, 제외 하세요.

Response

  • data
    • count : SMS 발송 건수

Telegram 발송

Request

  • Method : POST
  • Path : /services/telegrams
  • Parameters
이름타입위치필수설명
x-obcon-accessKeyStringHeader필수Access Key
x-authorizationStringHeader필수Bearer ${token}
typeStringBody옵션Reserved
public. 설정 정보를 사용하여 메시지 발송 (Default)
private. 사용자 정보를 사용하여 메시지 발송
receiversStringBody필수받는 사람 chat id
,로 구분
messageStringBody필수메시지
timestampIntegerQuery필수타임스탬프 (13자리 숫자)
nonceStringQuery필수임의의 랜덤한 문자열
hmacStringQuery필수HMA-SHA256
  • x-authorization 값은 Token 앞에 반드시 "Bearer " 문자를 붙여 주세요.

  • chat id 구조

    • chat id
    • 이름
    • @.~ : 이메일에 해당하는 사용자 정보에서 chat id를 가져 온다.
  • HMAC 생성시 fields

    • x-obcon-accessKey, [type], receivers, message, timestamp, nonce
    • "[ ]"로 표시된 항목은 옵션 항목으로 없는 경우, 제외 하세요.

Response

  • data

    • ok : true. 전체에게 메시지 발송 완료
  • success : 성공

    • count : 성공한 건수
    • ids : 성공한 receiver 목록
    • fail : 실패
      • count : 실패한 건수
      • ids : 실패한 receiver 목록
최종 수정일: 2022-11-29 12:33:59

이전글 :
다음글 :
상단 menu
arrow_back_ios
arrow_forward_ios