API 가이드

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O
x-mob-b2b-privacy	개인정보 암호화(AES256) 여부 (암호화 Key 필요시 biz.cs@kakaomobility.com 으로 문의)	X

요청 경로 변수

이름	타입	설명
id	String	직원 ID

응답 본문

이름	타입	설명	null 허용	암호화 가능
id	String	직원 ID	X	X
name	String	직원명	X	X
department	String	부서명	X	X
identifier	String	사번	X	O
mobile_phone	String	휴대전화번호	X	O
status	String	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X
confirmed_at	String	직원 인증 일시 (yyyy-MM-dd HH:mm:ss)	O	X
group_ids	String[]	그룹 ID를 담은 JSON 배열	X	X

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/{id}' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "id": "A1B2C3D4",
  "name": "홍길동",
  "department": "부서명",
  "identifier": "사번",
  "mobile_phone": "01012341234",
  "status": "connected",
  "confirmed_at": "2023-01-01 00:00:00",
  "group_ids": [
    "A1B2C3D4", "A1B2C3D5"
  ]
}
JSON
복사

직원 수정

기본정보

메서드	URL
PUT	https://mob-b2b-dev.kakao.com/external/v1/members/{id}

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O
x-mob-b2b-privacy	개인정보 암호화(AES256) 여부 (암호화 Key 필요시 biz.cs@kakaomobility.com 으로 문의)	X

요청 경로 변수

이름	타입	설명
id	String	직원 ID

요청 본문

이름	타입	설명	필수	암호화 가능
mobile_phone	String	휴대전화번호 직원의 휴대전화번호가 수정되면 수정된 번호로 인증 알림톡 자동 발송 (운영환경인 경우에 한함)	O	O
group_ids	String[]	그룹 ID를 담은 JSON 배열	O	X
name	String	직원명 null일 경우 공백 값으로 수정	X	O
department	String	부서명 null일 경우 공백 값으로 수정	X	O
status	String	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X

응답 본문

이름	타입	설명	null 허용	암호화 가능
id	String	직원 ID	X	X
name	String	직원명	X	X
department	String	부서명	X	X
identifier	String	사번	X	O
mobile_phone	String	휴대전화번호	X	O
status	String	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X
confirmed_at	String	직원 인증 일시 (yyyy-MM-dd HH:mm:ss)	O	X
group_ids	String[]	그룹 ID를 담은 JSON 배열	X	X

요청 예시

curl -X 'PUT' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/{id}' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}' \
  -H 'Content-Type: application/json;charset=UTF-8' \
	-d '{
	  "mobile_phone": "01012341234",
	  "group_ids": ["A1B2C3D4", "A1B2C3D5"]
	}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "id": "A1B2C3D4",
  "name": "홍길동",
  "department": "부서명",
  "identifier": "사번",
  "mobile_phone": "01012341234",
  "status": "connected",
  "confirmed_at": "2023-01-01 00:00:00",
  "group_ids": [
    "A1B2C3D4", "A1B2C3D5"
  ]
}
JSON
복사

직원 삭제

기본정보

메서드	URL
DELETE	https://mob-b2b-dev.kakao.com/external/v1/members/{id}

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 경로 변수

이름	타입	설명
id	String	직원 ID

요청 예시

curl -X 'DELETE' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/{id}' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
JSON
복사

직원 등록

기본정보

메서드	URL
POST	https://mob-b2b-dev.kakao.com/external/v1/members

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O
x-mob-b2b-privacy	개인정보 암호화(AES256) 여부 (암호화 Key 필요시 biz.cs@kakaomobility.com 으로 문의)	X

요청 본문

이름	타입	설명	필수	암호화 가능
identifier	String	사번	O	O
mobile_phone	String	휴대전화번호 휴대전화번호로 인증 알림톡 자동 발송 (운영환경인 경우에 한함)	O	O
group_ids	String[]	그룹 ID를 담은 JSON 배열	O	X
name	String	직원명 null일 경우 공백 값으로 저장	X	O
department	String	부서명	X	O
status	refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X

응답 본문

이름	타입	설명	null 허용	암호화 가능
id	String	직원 ID	X	X
name	String	직원명	X	X
department	String	부서명	O	X
identifier	String	사번	X	O
mobile_phone	String	휴대전화번호	X	O
status	String	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X
confirmed_at	String	직원 인증 일시 (yyyy-MM-dd HH:mm:ss)	O	X
group_ids	String[]	그룹 ID를 담은 JSON 배열	X	X

요청 예시

curl -X 'POST' \
  'https://mob-b2b-dev.kakao.com/external/v1/members' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
  -H 'Content-Type: application/json;charset=UTF-8' \
  -d '{
  "identifier": "사번",
  "mobile_phone": "01012341234",
  "name": "홍길동",
  "department": "부서명",
  "group_ids": [
    "A1B2C3D4"
    ]
  }'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "id": "A1B2C3D4",
  "name": "홍길동",
  "department": "부서명",
  "identifier": "사번",
  "mobile_phone": "01012341234",
  "status": "created",
  "confirmed_at": null,
  "group_ids": [
    "A1B2C3D4"
  ]
}
JSON
복사

인증 알림톡 발송

기본정보

직원이 알림톡 미수신시 인증 알림톡 발송 API를 통해 인증 알림톡을 재발송할 수 있습니다. 운영환경에서만 알림톡이 발송됩니다.

메서드	URL
POST	https://mob-b2b-dev.kakao.com/external/v1/members/{id}/send/tms

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 경로 변수

이름	타입	설명
id	String	직원 ID

요청 예시

curl -X 'POST' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/{id}/send_tms' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
JSON
복사

직원 상태를 휴직으로 변경

기본정보

인증 완료 상태인 직원에 한해서 휴직 상태로 변경합니다.

메서드	URL
POST	https://mob-b2b-dev.kakao.com/external/v1/members/block

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 본문

이름	타입	설명	필수
members	String	휴직으로 변경할 직원 ID 목록 “,"(쉼표)로 구분	O

응답 본문

이름	타입	설명	null 허용
-	MembersBlockingResult[]	휴직 상태로 변경 결과를 담은 JSON 배열	X

MembersBlockingResult

이름	타입	설명	null 허용
id	String	직원 ID	X
status_code	Integer	응답 상태 코드 (0: 성공)	X
status_msg	String	응답 상태 메시지	X

요청 예시

curl -X 'POST' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/block' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -d '{
    "members": "A1B2C3D4,A1B2C3D5"
  }'
Bash
복사

응답 예시

HTTP/1.1 200 OK
[
  {
    "id": "A1B2C3D4",
    "status_code": 0,
    "status_msg": "성공"
  },
  {
    "id": "A1B2C3D5",
    "status_code": 0,
    "status_msg": "성공"
  }
]
JSON
복사

직원의 휴직 상태 해제

기본정보

메서드	URL
POST	https://mob-b2b-dev.kakao.com/external/v1/members/unblock

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 본문

이름	타입	설명	필수
members	String	휴직을 해제할 직원 ID 목록 “,"(쉼표)로 구분	O

응답 본문

이름	타입	설명	null 허용
-	MembersUnblockingResult[]	휴직 상태 해제 결과를 담은 JSON 배열	X

MembersUnblockingResult

이름	타입	설명	null 허용
id	String	직원 ID	X
status_code	Integer	응답 상태 코드 (0: 성공)	X
status_msg	String	응답 상태 메시지	X

요청 예시

curl -X 'POST' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/unblock' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -d '{
    "members": "A1B2C3D4,A1B2C3D5"
  }'
Bash
복사

응답 예시

HTTP/1.1 200 OK
[
  {
    "id": "A1B2C3D4",
    "status_code": 0,
    "status_msg": "성공"
  },
  {
    "id": "A1B2C3D5",
    "status_code": 0,
    "status_msg": "성공"
  }
]
JSON
복사

인증 완료 직원 목록 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v1/members/connected

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O
x-mob-b2b-privacy	개인정보 암호화(AES256) 여부 (암호화 Key 필요시 biz.cs@kakaomobility.com 으로 문의)	X

요청 쿼리 파라미터

이름	타입	설명	필수	기본값
start_date	String	조회 시작일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
end_date	String	조회 종료일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
page	Integer	페이지 번호	X	1
per	Integer	한 페이지에 가져올 직원 최대 수 (최대: 100)	X	20

응답 본문

이름	타입	설명	null 허용	암호화 가능
count	Integer	인증 완료 직원 전체 개수	X	X
members	ConnectedMember[]	인증 완료 직원을 담은 JOSN 배열	X	X

ConnectedMember

이름	타입	설명	null 허용	암호화 가능
id	String	직원 ID	X	X
name	String	직원명	X	X
department	String	부서명	O	X
identifier	String	사번	X	O
mobile_phone	String	휴대전화번호	X	O
status	String	직원 상태 created (미인증): 직원으로 등록되어 있으나 직원이 T앱에서 인증을 완료하지 않아, 카카오 T 비즈니스 이용이 불가한 상태 connected (인증 완료): T앱에서 직원의 인증이 완료되어 카카오 T 비즈니스 이용이 가능한 상태 refused (인증 거부): 직원이 T앱에서 스스로 인증을 거부하여 T 비즈니스 이용 불가한 상태 blocked (휴직): 직원의 카카오 T 비즈니스 이용이 제한된 상태	X	X
confirmed_at	String	직원 인증 일시 (yyyy-MM-dd HH:mm:ss)	X	X
group_ids	String[]	그룹 ID를 담은 JSON 배열	X	X

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/members/connected?start_date=2023-01-01&end_date=2023-01-31&page=1&per=2' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "count": 10,
  "members" : [
		{
		  "id": "A1B2C3D4",
		  "name": "홍길동1",
		  "department": "부서명",
		  "identifier": "사번1",
		  "mobile_phone": "01012341234",
		  "status": "connected",
		  "confirmed_at": "2023-01-01 00:00:00",
		  "group_ids": [
		    "A1B2C3D4", "A1B2C3D5"
		  ]
    },
		{
		  "id": "A1B2C3D5",
		  "name": "홍길동2",
		  "department": "부서명",
		  "identifier": "사번2",
		  "mobile_phone": "01012341235",
		  "status": "connected",
		  "confirmed_at": "2023-01-01 00:00:00",
		  "group_ids": [
		    "A1B2C3D4", "A1B2C3D5"
		  ]
    }
  ]
}
JSON
복사

그룹 API

그룹 목록 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v1/groups

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

응답 본문

이름	타입	설명	null 허용
-	Group[]	휴직 상태 해제 결과를 담은 JSON 배열	X

Group

이름	타입	설명	null 허용
id	String	그룹 ID	X
name	String	그룹명	X
status	String	그룹 상태 enabled (활성화) disabled (비활성화) deactivated (삭제)	X
description	String	그룹 설명	X

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/groups' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
[
  {
    "id": "A1B2C3D4",
    "name": "그룹1",
    "status": "enabled",
    "description": "자동으로 생성된 기본그룹 입니다."
  },
  {
    "id": "A1B2C3D5",
    "name": "그룹2",
    "status": "disabled",
    "description": ""
  }
]
JSON
복사

그룹 이용사유 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v1/groups/use_reason_type

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 쿼리 파라미터

이름	타입	설명	필수
group_ext_id	String	그룹 ID	O

응답 본문

이름	타입	설명	null 허용
reason_type	String	이용사유 유형 text (입력형) selection (선택형) selection_plus (선택형 + 입력형) selection_text (선택형 → 입력형)	X
reason_type_txt	String	이용사유 유형(한글)	X
description1	String	이용사유 설명 1	X
options1	String	선택 옵션 1	X
description2	String	이용사유 설명 2	X
options2	String	선택 옵션 2	X
is_required	Boolean	이용사유 입력 필수 여부	X

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/groups/use_reason_type?group_ext_id=A1B2C3D4' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "reason_type": "text",
  "reason_type_txt": "입력형",
  "description1": "",
  "options1": "",
  "description2": "",
  "options2": "",
  "is_required": false
}
JSON
복사

결제 API

결제 승인 내역 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v1/members/payment_approvals

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 쿼리 파라미터

이름	타입	설명	필수	기본값
start_date	String	조회 시작일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
end_date	String	조회 종료일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
page	Integer	페이지 번호	X	1
per	Integer	한 페이지에 가져올 결제 승인 내역 최대 수 (최대: 100)	X	20

응답 본문

이름	타입	설명	null 허용
count	Integer	결제 승인 내역 전체 개수	X
payment_approvals	PaymentApproval[]	결제 승인 내역을 담은 JOSN 배열	X

PaymentApproval

이름	타입	설명	null 허용
id	Long	결제 승인 ID	X
payment_item_id	Long	결제 아이템 ID	X
amount	Integer	금액	X
pay_type	String	결제 타입 PAYMENT (결제) CANCEL (취소)	X
approval_no	String	카드사 승인 번호	O
org_date_time	String	카드사 승인 일시 (yyyy-MM-dd HH:mm:ss)	O
card_number	String	카드 번호	O

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/payment_approvals?start_date=2023-01-01&end_date=2023-01-31&page=1&per=2' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "count": 10,
  "payment_approvals" : [
    {
      "id": 1000,
      "payment_item_id": 2000,
      "amount": 8100,
      "pay_type": "PAYMENT",
      "approval_no": "999999998",
      "org_date_time": "2023-01-01 00:00:00",
      "card_number": "000001"
    },
    {
      "id": 1001,
      "payment_item_id": 2001,
      "amount": 5000,
      "pay_type": "PAYMENT",
      "approval_no": "999999999",
      "org_date_time": "2023-01-01 00:00:00",
      "card_number": "000001"
    }
  ]
}
JSON
복사

이용 내역 API

기업 이용 내역 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v2/orders

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 쿼리 파라미터

이름	타입	설명	필수	기본값
start_date	String	조회 시작일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
end_date	String	조회 종료일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
page	Integer	페이지 번호	X	1
per	Integer	한 페이지에 가져올 이용 내역 최대 수 (최대: 100)	X	20
search_by_payment_at	Boolean	조회 기준 (false: 이용일시, true: 결제일시)	X	false
vertical_code	String	버티컬 종류 TAXI (택시) DRIVER (대리) LOGISTICS (퀵∙배송) CONSIGNMENT (탁송) DOBO (도보 배송) KORAIL (기차) NAVI (내비) COMMUTEBUS (통근 셔틀) BLACK (블랙)	X	-
member_identifier	String	직원 사번	X	-

응답 본문

이름	타입	설명	null 허용
count	Integer	이용 내역 전체 개수	X
orders	Order[]	이용 내역을 담은 JOSN 배열	X

Order

이름	타입	설명	null 허용
id	String	이용 내역 ID	X
service_fare	Integer	이용 요금	X
toll	Integer	통행료	X
platform_fee	Integer	플랫폼 수수료	X
group_id	String	그룹 ID	X
group_name	String	그룹명	X
vertical_code	String	버티컬 종류 TAXI (택시) DRIVER (대리) LOGISTICS (퀵∙배송) CONSIGNMENT (탁송) DOBO (도보 배송) KORAIL (기차) NAVI (내비) COMMUTEBUS (통근 셔틀) BLACK (블랙)	X
vertical_product_code	String	버티컬 상품 종류	X
vertical_product_name	String	버티컬 상품명	X
dropoff_location_gap	Integer	목적지-도착지 거리	X
taxi_kind	String	택시 종류 medium (중형) large (대형) deluxe (모범) luxury (고급) compact (경형) small (소형) unknown (택시가 아님)	X
payment_items	PaymentItem	결제 정보를 담은 JSON 배열	X
use_code	String	이용 사유	O
call_time	String	호출 일시 (yyyy-MM-dd HH:mm:ss)	O
departure_time	String	출발 일시 (yyyy-MM-dd HH:mm:ss)	O
arrival_time	String	도착 일시 (yyyy-MM-dd HH:mm:ss)	O
departure_point	String	탑승 위치	O
arrival_point	String	도착 위치	O
member_id	String	이용 직원 ID	O
member_name	String	이용 직원명	O
member_identifier	String	이용 직원 사번	O
member_department	String	이용 직원 부서명	O
car_model	String	자동차 모델명	O
car_number	String	자동차 등록번호	O
taxi_company_name	String	운수회사명	O
total_distance	Integer	총 주행 거리(m)	O

PaymentItem

이름	타입	설명	null 허용
id	Long	결제 ID	X
status	String	결제 상태 init (결제 요청) paid (결제 승인) unpaid (결제 실패/미수) payment_cancelled (결제 취소) overpaid (초과 결제)	X
item_type	String	결제 유형 fare (운행 요금) platform_fee (플랫폼 사용료) cancel_fee (취소 수수료) business_call_charge (플러스 이용료) noshow_fee (노쇼 수수료) call_fee (호출/예약 이용료) etc_fee (기타비용(실비))	X
amount	Integer	결제 금액	X
approval_no	String	카드사 승인 번호	O
org_date_time	String	카드사 승인 일시 (yyyy-MM-dd HH:mm:ss)	O
card_number	String	카드 번호	O

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v2/orders?start_date=2023-01-01&end_date=2023-01-31&page=1&per=1' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "count": 10,
  "orders": [
    {
      "id": "A1B2C3D4",
      "service_fare": 8100,
      "toll": 0,
      "platform_fee": 0,
      "use_code": "",
      "call_time": "2023-01-01 15:31:13",
      "departure_time": "2023-01-01 15:31:13",
      "arrival_time": "2023-01-01 15:31:26",
      "departure_point": "경기 수지구 용인시 신수로 767",
      "arrival_point": "경기 성남시 분당구 판교역로 지하 160",
      "member_id": "EGRJ8LPB",
      "member_name": null,
      "member_identifier": "사번",
      "member_department": null,
      "group_id": "A1B2C3D5",
      "group_name": "기본그룹",
      "car_model": null,
      "car_number": null,
      "taxi_company_name": null,
      "taxi_kind": "unknown",
      "vertical_code": "logistics",
      "vertical_product_code": "quick_economy",
      "vertical_product_name": "퀵 이코노미",
      "total_distance": null,
      "dropoff_location_gap": 0,
      "payment_items": [
        {
          "id": 9999,
          "status": "payment_cancelled",
          "item_type": "fare",
          "amount": 8100,
          "approval_no": "999919999",
          "org_date_time": "2023-01-01 15:31:25",
          "card_number": "000001"
        }
      ]
    }
  ]
}
JSON
복사

기업의 파트너 이용 내역 조회

기본정보

메서드	URL
GET	https://mob-b2b-dev.kakao.com/external/v1/orders/partner

요청 헤더

이름	설명	필수
Authorization	Authorization: Token {API 인증 토큰} Token 문자열은 반드시 {API 인증 토큰} 앞에 붙어야 하며, Token 문자열과 {API 인증 토큰} 사이에는 공백이 있어야 합니다. (API 인증 토큰이란?)	O
x-mob-b2b-corp-id	API 인증 토큰 생성에 사용한 기업 ID (카카오 T 비즈니스 관리시스템 > 설정 > 계정정보 > T 비즈 ID)	O
x-mob-b2b-nonce	API 인증 토큰 생성에 사용한 난수	O
x-mob-b2b-timestamp	API 인증 토큰을 생성한 유닉스 시간(초)	O

요청 쿼리 파라미터

이름	타입	설명	필수	기본값
start_date	String	조회 시작일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
end_date	String	조회 종료일 (yyyy-MM-dd) 시작일과 종료일 범위는 최대 한 달	O	-
page	Integer	페이지 번호	X	1
per	Integer	한 페이지에 가져올 이용 내역 최대 수 (최대: 100)	X	20

응답 본문

이름	타입	설명	null 허용
count	Integer	이용 내역 전체 개수	X
orders	PartnerOrder[]	이용 내역을 담은 JOSN 배열	X

PartnerOrder

이름	타입	설명	null 허용
id	String	이용 내역 ID	X
corporation_name	String	기업명	X
registration_id	String	사업자번호	X
service_fare	Integer	이용 요금	X
toll	Integer	통행료	X
platform_fee	Integer	플랫폼 수수료	X
group_id	String	그룹 ID	X
group_name	String	그룹명	X
vertical_code	String	버티컬 종류 TAXI (택시) DRIVER (대리) LOGISTICS (퀵∙배송) CONSIGNMENT (탁송) DOBO (도보 배송) KORAIL (기차) NAVI (내비) COMMUTEBUS (통근 셔틀) BLACK (블랙)	X
member_id	String	이용 직원 ID	X
member_identifier	String	이용 직원 사번	O
member_name	String	이용 직원명	X
member_mobile	String	이용 직원 휴대전화번호	X
taxi_kind	String	택시 종류 medium (중형) large (대형) deluxe (모범) luxury (고급) compact (경형) small (소형) unknown (택시가 아님)	X
payment_items	PaymentItem	결제 정보를 담은 JSON 배열	X
use_code	String	이용 사유	O
departure_time	String	출발 일시 (yyyy-MM-dd HH:mm:ss)	O
arrival_time	String	도착 일시 (yyyy-MM-dd HH:mm:ss)	O
departure_point	String	탑승 위치	O
arrival_point	String	도착 위치	O
total_distance	Integer	총 주행 거리(m)	O

PaymentItem

이름	타입	설명	null 허용
id	Long	결제 ID	X
status	String	결제 상태 init (결제 요청) paid (결제 승인) unpaid (결제 실패/미수) payment_cancelled (결제 취소) overpaid (초과 결제)	X
item_type	String	결제 유형 fare (운행 요금) platform_fee (플랫폼 사용료) cancel_fee (취소 수수료) business_call_charge (플러스 이용료) noshow_fee (노쇼 수수료) call_fee (호출/예약 이용료) etc_fee (기타비용(실비))	X
amount	Integer	결제 금액	X
approval_no	String	카드사 승인 번호	O
org_date_time	String	카드사 승인 일시 (yyyy-MM-dd HH:mm:ss)	O

요청 예시

curl -X 'GET' \
  'https://mob-b2b-dev.kakao.com/external/v1/orders/partner?start_date=2023-01-01&end_date=2023-01-31&page=1&per=1' \
  -H 'accept: application/json;charset=UTF-8' \
  -H 'Authorization: Token {API 인증 토큰}' \
  -H 'x-mob-b2b-corp-id: {API 인증 토큰 생성에 사용한 기업 ID}' \
  -H 'x-mob-b2b-nonce: {API 인증 토큰 생성에 사용한 난수}' \
  -H 'x-mob-b2b-timestamp: {API 인증 토큰을 생성한 유닉스 시간(초)}'
Bash
복사

응답 예시

HTTP/1.1 200 OK
{
  "count": 10,
  "orders": [
    {
      "id": "A1B2C3D4",
      "corporation_name": "A고객사",
      "registration_id": "1111111119",
      "service_fare": 8100,
      "toll": 0,
      "platform_fee": 0,
      "use_code": "",
      "departure_time": "2023-01-01 15:31:13",
      "arrival_time": "2023-01-01 15:31:26",
      "departure_point": "경기 수지구 용인시 신수로 767",
      "arrival_point": "경기 성남시 분당구 판교역로 지하 160",
      "member_id": "EGRJ8LPB",
      "member_identifier": "사번",
      "member_name": null,
      "member_mobile": "01012341234",
      "group_id": "A1B2C3D5",
      "group_name": "기본그룹",
      "taxi_kind": "unknown",
      "vertical_code": "logistics",
      "total_distance": null,
      "payment_items": [
        {
          "id": 9999,
          "status": "payment_cancelled",
          "item_type": "fare",
          "amount": 8100,
          "approval_no": "999919999",
          "org_date_time": "2023-01-01 15:31:25",
        }
      ]
    }
  ]
}
JSON
복사