- OBCon Open API 2
- Email 발송 (Reserved)
- SMS 발송 (Reserved)
- Telegram 발송
OBCon Open API 2
Email 발송 (Reserved)
Request
Method : POST
Path : /services/emails
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| x-obcon-accessKey | String | Header | 필수 | Access Key |
| x-authorization | String | Header | 필수 | Bearer ${token} |
| to | String | Body | 필수 | 받는 사람 ,로 구분 |
| cc | String | Body | 옵션 | 참조 ,로 구분 |
| bcc | String | Body | 옵션 | 숨은 참조 ,로 구분 |
| service | String | Body | 옵션 | 서비스 (Default. OBCon) |
| template | String | Body | 옵션 | 이메일 템플릿 |
| title | String | Body | 필수 | 이메일 제목 |
| html | String | Body | 필수 | 이메일 내용 |
| timestamp | Integer | Query | 필수 | 타임스탬프 (13자리 숫자) |
| nonce | String | Query | 필수 | 임의의 랜덤한 문자열 |
| hmac | String | Query | 필수 | 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-accessKey | String | Header | 필수 | Access Key |
| x-authorization | String | Header | 필수 | Bearer ${token} |
| sender | String | Body | 옵션 | 보내는 사람 전화번호 |
| receivers | String | Body | 필수 | 받는 사람 전화번호 ,로 구분 |
| service | String | Body | 옵션 | 서비스 |
| message | String | Body | 필수 | 메시지 |
| timestamp | Integer | Query | 필수 | 타임스탬프 (13자리 숫자) |
| nonce | String | Query | 필수 | 임의의 랜덤한 문자열 |
| hmac | String | Query | 필수 | 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-accessKey | String | Header | 필수 | Access Key |
| x-authorization | String | Header | 필수 | Bearer ${token} |
| type | String | Body | 옵션 | Reserved public. 설정 정보를 사용하여 메시지 발송 (Default) private. 사용자 정보를 사용하여 메시지 발송 |
| receivers | String | Body | 필수 | 받는 사람 chat id ,로 구분 |
| message | String | Body | 필수 | 메시지 |
| timestamp | Integer | Query | 필수 | 타임스탬프 (13자리 숫자) |
| nonce | String | Query | 필수 | 임의의 랜덤한 문자열 |
| hmac | String | Query | 필수 | 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 목록