Courier(독립 게시자)(미리 보기)
Courier는 개발 팀이 모든 제품 트리거 통신(전자 메일, 채팅, 앱 내, SMS, 푸시 등)을 한 곳에서 관리할 수 있는 서비스 및 웹 스튜디오입니다. Courier는 뛰어난 알림 환경을 제공하려는 개발자를 위해 빌드되었습니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | 트로이 테일러 |
| URL | https://www.hitachisolutions.com |
| 전자 메일 | ttaylor@hitachisolutions.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | 트로이 테일러 |
| 웹 사이트 | https://www.courier.com/ |
| 개인 정보 보호 정책 | https://www.courier.com/privacy/ |
| 카테고리 | 통신; 소셜 미디어 |
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 토큰('Bearer yourToken' 형식) | 시큐어스트링 (보안 문자열) | 이 API에 대한 토큰('Bearer yourToken' 형식) | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| 감사 이벤트 가져오기 |
식별자를 사용하여 특정 감사 이벤트를 검색합니다. |
| 대량 작업 가져오기 |
대량 작업에 대한 정보를 검색합니다. |
| 대량 작업 만들기 |
제공된 메시지 매개 변수에 대한 대량 작업을 만듭니다. |
| 대량 작업 실행 |
대량 작업 실행을 시작합니다. |
| 대량 작업에 사용자 추가 |
사용자 데이터를 대량 작업으로 수집합니다. |
| 대량 작업의 사용자 가져오기 |
대량 작업의 사용자를 검색합니다. |
| 대상 그룹 가져오기 |
식별자별로 지정된 대상 그룹을 반환합니다. |
| 대상 그룹 구성원 나열 |
대상 그룹의 멤버 목록을 검색합니다. |
| 대상 그룹 만들기 또는 업데이트 |
제공된 매개 변수 및 필터를 기반으로 대상 그룹을 만들거나 업데이트합니다. |
| 대상 그룹 삭제 |
지정된 받는 사람 대상 그룹을 삭제합니다. |
| 메시지 가져오기 |
메시지의 상태를 검색합니다. |
| 메시지 기록 가져오기 |
이전에 보낸 메시지의 이벤트를 검색합니다. |
| 메시지 나열 |
이전에 보낸 메시지의 상태를 검색합니다. |
| 메시지 보관 |
메시지를 보관할 것을 요청합니다. |
| 메시지 보내기 |
하나 이상의 받는 사람에게 메시지를 보냅니다. |
| 메시지의 콘텐츠 가져오기 |
이전에 보낸 메시지의 콘텐츠를 검색합니다. |
| 모든 감사 이벤트 가져오기 |
감사 이벤트 목록을 검색합니다. |
| 모든 대상 그룹 나열 |
계정과 연결된 모든 대상 그룹을 검색합니다. |
| 모든 받는 사람 목록 가져오기 |
모든 받는 사람 목록의 목록을 검색합니다. |
| 목록 가져오기 |
목록의 항목을 검색합니다. |
| 목록 복원 |
식별자를 사용하여 기존 목록을 복원합니다. |
| 목록 삭제 |
목록 식별자를 사용하여 목록을 삭제합니다. |
| 목록 업데이트 |
기존 목록을 제공된 값으로 만들거나 바꿉니다. |
| 목록에 구독자 추가 |
목록에 구독자를 추가합니다. |
| 목록에서 사용자 구독 취소 |
목록 및 받는 사람 식별자를 사용하여 목록에 대한 구독을 삭제합니다. |
| 목록의 구독 가져오기 |
목록의 구독을 검색합니다. |
| 브랜드 가져오기 |
식별자를 사용하여 특정 브랜드를 검색합니다. |
| 브랜드 나열 |
브랜드 목록을 검색합니다. |
| 브랜드 만들기 |
제공된 설정에서 새 브랜드를 만듭니다. |
| 알림 나열 |
알림 목록을 검색합니다. |
| 임시 자동화 실행 |
임시 실행에서 자동화를 호출합니다. |
| 템플릿 자동화 실행 |
자동화 템플릿에서 자동화 실행을 호출합니다. |
| 프로필 가져오기 |
지정된 받는 사람 프로필을 검색합니다. |
| 프로필 만들기 |
제공된 값을 기존 프로필과 병합하거나 아직 없는 경우 새 프로필을 만듭니다. |
| 프로필 삭제 |
지정된 받는 사람 프로필을 삭제합니다. |
| 프로필 업데이트 |
프로필의 일부를 업데이트합니다. |
감사 이벤트 가져오기
식별자를 사용하여 특정 감사 이벤트를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Audit 이벤트 ID
|
audit-event-id | True | string |
감사 이벤트 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Audit 이벤트 ID
|
auditEventId | string |
감사 이벤트 식별자입니다. |
|
아이디
|
actor.id | string |
식별자입니다. |
|
전자 메일
|
actor.email | string |
전자 메일 주소입니다. |
|
아이디
|
target.id | string |
식별자입니다. |
|
전자 메일
|
target.email | string |
전자 메일 주소입니다. |
|
출처
|
source | string |
원본입니다. |
|
시간표시
|
timestamp | string |
타임스탬프입니다. |
|
유형
|
type | string |
형식입니다. |
대량 작업 가져오기
대량 작업에 대한 정보를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
직무 ID
|
job_id | True | string |
작업 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Event
|
job.definition.event | string |
이벤트. |
|
큐
|
job.enqueued | integer |
큐에 찍힌 것입니다. |
|
실패
|
job.failures | integer |
오류입니다. |
|
수신됨
|
job.received | integer |
수신 시. |
|
상태
|
job.status | string |
상태입니다. |
대량 작업 만들기
제공된 메시지 매개 변수에 대한 대량 작업을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Event
|
event | string |
이벤트. |
|
|
브랜드
|
brand | string |
브랜드. |
|
|
Template
|
template | string |
템플릿입니다. |
|
|
브랜드 ID
|
brand_id | string |
브랜드 식별자입니다. |
|
|
메서드
|
method | string |
메서드입니다. |
|
|
채널
|
channels | array of string |
채널입니다. |
|
|
Event
|
event | string |
이벤트. |
|
|
태그들
|
tags | array of string |
태그입니다. |
|
|
추적 ID
|
trace_id | string |
추적 식별자입니다. |
|
|
캠페인
|
campaign | string |
캠페인. |
|
|
Content
|
content | string |
콘텐츠입니다. |
|
|
미디엄
|
medium | string |
매체입니다. |
|
|
출처
|
source | string |
원본입니다. |
|
|
용어
|
term | string |
용어입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
직무 ID
|
jobId | string |
작업 식별자입니다. |
대량 작업 실행
대량 작업 실행을 시작합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
직무 ID
|
job_id | True | string |
작업 식별자입니다. |
반환
- response
- object
대량 작업에 사용자 추가
사용자 데이터를 대량 작업으로 수집합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
직무 ID
|
job_id | True | string |
작업 식별자입니다. |
|
Recipient
|
recipient | string |
받는 사람입니다. |
반환
- response
- string
대량 작업의 사용자 가져오기
대량 작업의 사용자를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
직무 ID
|
job_id | True | string |
작업 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
items | array of object | |
|
Recipient
|
items.recipient | string |
받는 사람입니다. |
|
전자 메일
|
items.email | string |
전자 메일 주소입니다. |
|
로케일
|
items.locale | string |
로캘입니다. |
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
대상 그룹 가져오기
식별자별로 지정된 대상 그룹을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
대상 그룹 ID
|
audience_id | True | string |
대상 그룹 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
이름입니다. |
|
Description
|
description | string |
설명입니다. |
|
Operator
|
filter.operator | string |
연산자입니다. |
|
가치
|
filter.value | string |
값입니다. |
|
경로
|
filter.path | string |
경로입니다. |
대상 그룹 구성원 나열
대상 그룹의 멤버 목록을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
대상 그룹 ID
|
audience_id | True | string |
대상 그룹 식별자입니다. |
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
items | array of object | |
|
멤버 ID
|
items.member_id | string |
멤버 식별자입니다. |
|
에 추가됨
|
items.added_at | string |
추가 시 |
|
대상 그룹 ID
|
items.audience_id | string |
대상 그룹 식별자입니다. |
|
대상 그룹 버전
|
items.audience_version | integer |
대상 그룹 버전입니다. |
|
이유
|
items.reason | string |
그 이유입니다. |
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
대상 그룹 만들기 또는 업데이트
제공된 매개 변수 및 필터를 기반으로 대상 그룹을 만들거나 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
대상 그룹 ID
|
audience_id | True | string |
대상 그룹 식별자입니다. |
|
이름
|
name | string |
이름입니다. |
|
|
경로
|
path | string |
경로입니다. |
|
|
Operator
|
operator | string |
연산자입니다. |
|
|
가치
|
value | string |
값입니다. |
|
|
경로
|
path | string |
경로입니다. |
|
|
Operator
|
operator | string |
연산자입니다. |
|
|
가치
|
value | string |
값입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
이름입니다. |
|
Description
|
description | string |
설명입니다. |
|
Operator
|
filter.operator | string |
연산자입니다. |
|
가치
|
filter.value | string |
값입니다. |
|
경로
|
filter.path | string |
경로입니다. |
|
필터
|
filter.filters | array of object | |
|
경로
|
filter.filters.path | string |
경로입니다. |
|
Operator
|
filter.filters.operator | string |
연산자입니다. |
|
가치
|
filter.filters.value | string |
값입니다. |
대상 그룹 삭제
지정된 받는 사람 대상 그룹을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
대상 그룹 ID
|
audience_id | True | string |
대상 그룹 식별자입니다. |
반환
- response
- string
메시지 가져오기
메시지의 상태를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
메시지 ID
|
message_id | True | string |
메시지 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
상태
|
status | string |
상태입니다. |
|
큐
|
enqueued | integer |
큐에 찍힌 것입니다. |
|
전송
|
sent | integer |
보낸 사람입니다. |
|
배송 완료
|
delivered | integer |
배달된 것입니다. |
|
열립니다
|
opened | integer |
열린 경우입니다. |
|
클릭
|
clicked | integer |
클릭했습니다. |
|
Recipient
|
recipient | string |
받는 사람입니다. |
|
Event
|
event | string |
이벤트. |
|
Notification
|
notification | string |
알림입니다. |
|
오류
|
error | string |
오류입니다. |
|
이유
|
reason | string |
그 이유입니다. |
|
Providers
|
providers | array of object | |
|
전송
|
providers.sent | integer |
보낸 사람입니다. |
|
배송 완료
|
providers.delivered | integer |
배달된 것입니다. |
|
클릭
|
providers.clicked | integer |
클릭했습니다. |
|
열립니다
|
providers.opened | integer |
열린 경우입니다. |
|
오류
|
providers.error | string |
오류입니다. |
|
Provider
|
providers.provider | string |
공급자입니다. |
|
상태
|
providers.status | string |
상태입니다. |
메시지 기록 가져오기
이전에 보낸 메시지의 이벤트를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
메시지 ID
|
message_id | True | string |
메시지 식별자입니다. |
|
유형
|
type | string |
형식입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
이름
|
results.data.name | string |
이름입니다. |
|
Event
|
results.event | string |
이벤트. |
|
Recipient
|
results.recipient | string |
받는 사람입니다. |
|
TS
|
results.ts | integer |
TS입니다. |
|
유형
|
results.type | string |
형식입니다. |
|
이벤트 ID
|
results.event_id | string |
이벤트 식별자입니다. |
|
알림 ID
|
results.notification_id | string |
알림 식별자입니다. |
|
아이디
|
results.channel.id | string |
식별자입니다. |
|
아이디
|
results.integration.id | string |
식별자입니다. |
|
Provider
|
results.integration.provider | string |
공급자입니다. |
메시지 나열
이전에 보낸 메시지의 상태를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
보관 여부입니다. |
|
|
Cursor
|
cursor | string |
커서입니다. |
|
|
Event
|
event | string |
이벤트. |
|
|
List
|
list | string |
목록입니다. |
|
|
메시지 ID
|
messageId | string |
메시지 식별자입니다. |
|
|
Notification
|
notification | string |
알림입니다. |
|
|
Recipient
|
recipient | string |
받는 사람입니다. |
|
|
상태
|
status | string |
상태입니다. |
|
|
태그들
|
tags | string |
태그입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
Results
|
results | array of object | |
|
아이디
|
results.id | string |
식별자입니다. |
|
상태
|
results.status | string |
상태입니다. |
|
큐
|
results.enqueued | integer |
큐에 찍힌 것입니다. |
|
전송
|
results.sent | integer |
보낸 사람입니다. |
|
배송 완료
|
results.delivered | integer |
배달된 것입니다. |
|
열립니다
|
results.opened | integer |
열린 경우입니다. |
|
클릭
|
results.clicked | integer |
클릭했습니다. |
|
Recipient
|
results.recipient | string |
받는 사람입니다. |
|
Event
|
results.event | string |
이벤트. |
|
Notification
|
results.notification | string |
알림입니다. |
|
오류
|
results.error | string |
오류입니다. |
|
이유
|
results.reason | string |
그 이유입니다. |
메시지 보관
메시지를 보관할 것을 요청합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
요청 ID
|
request_id | True | string |
요청 식별자입니다. |
반환
- response
- string
메시지 보내기
하나 이상의 받는 사람에게 메시지를 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
멱등원
|
idempotency | True | string |
idempotency 키입니다. |
|
제목
|
title | string |
제목입니다. |
|
|
몸
|
body | string |
본문입니다. |
|
|
사용자 ID
|
user_id | string |
사용자 식별자입니다. |
|
|
목록 ID
|
list_id | string |
목록 식별자입니다. |
|
|
대상 그룹 ID
|
audience_id | string |
대상 그룹 식별자입니다. |
|
|
전자 메일
|
string |
전자 메일 주소입니다. |
||
|
전화 번호
|
phone_number | string |
전화 번호입니다. |
|
|
로케일
|
locale | string |
로캘입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
요청 ID
|
requestId | string |
요청 식별자입니다. |
메시지의 콘텐츠 가져오기
이전에 보낸 메시지의 콘텐츠를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
메시지 ID
|
message_id | True | string |
메시지 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
채널
|
results.channel | string |
채널입니다. |
|
채널 ID
|
results.channel_id | string |
채널 식별자입니다. |
|
HTML
|
results.content.html | string |
HTML입니다. |
|
주제
|
results.content.subject | string |
제목입니다. |
|
문자 메시지
|
results.content.text | string |
텍스트입니다. |
|
블록
|
results.content.blocks | array of object | |
|
유형
|
results.content.blocks.type | string |
형식입니다. |
|
문자 메시지
|
results.content.blocks.text | string |
텍스트입니다. |
모든 감사 이벤트 가져오기
감사 이벤트 목록을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
Results
|
results | array of object | |
|
Audit 이벤트 ID
|
results.auditEventId | string |
감사 이벤트 식별자입니다. |
|
아이디
|
results.actor.id | string |
식별자입니다. |
|
전자 메일
|
results.actor.email | string |
전자 메일 주소입니다. |
|
아이디
|
results.target.id | string |
식별자입니다. |
|
전자 메일
|
results.target.email | string |
전자 메일 주소입니다. |
|
출처
|
results.source | string |
원본입니다. |
|
시간표시
|
results.timestamp | string |
타임스탬프입니다. |
|
유형
|
results.type | string |
형식입니다. |
모든 대상 그룹 나열
계정과 연결된 모든 대상 그룹을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
items | array of object | |
|
아이디
|
items.id | string |
식별자입니다. |
|
이름
|
items.name | string |
이름입니다. |
|
Description
|
items.description | string |
설명입니다. |
|
Operator
|
items.filter.operator | string |
연산자입니다. |
|
가치
|
items.filter.value | string |
값입니다. |
|
경로
|
items.filter.path | string |
경로입니다. |
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
모든 받는 사람 목록 가져오기
모든 받는 사람 목록의 목록을 검색합니다.
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
Results
|
results | array of object | |
|
생성됨
|
results.created | string |
만들 때. |
|
아이디
|
results.id | string |
식별자입니다. |
|
이름
|
results.name | string |
이름입니다. |
|
Updated
|
results.updated | string |
업데이트되는 경우. |
목록 가져오기
목록의 항목을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
생성됨
|
created | string |
만들 때. |
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
이름입니다. |
|
Updated
|
updated | string |
업데이트되었습니다. |
목록 복원
식별자를 사용하여 기존 목록을 복원합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
반환
- response
- string
목록 삭제
목록 식별자를 사용하여 목록을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
반환
- response
- string
목록 업데이트
기존 목록을 제공된 값으로 만들거나 바꿉니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
|
이름
|
name | string |
이름입니다. |
반환
- response
- string
목록에 구독자 추가
목록에 구독자를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
|
받는 사람 ID
|
recipientId | string |
받는 사람 식별자입니다. |
반환
- response
- string
목록에서 사용자 구독 취소
목록 및 받는 사람 식별자를 사용하여 목록에 대한 구독을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
|
받는 사람 ID
|
recipient_id | True | string |
받는 사람 식별자입니다. |
반환
- response
- string
목록의 구독 가져오기
목록의 구독을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
목록 ID
|
list_id | True | string |
목록 식별자입니다. |
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
아이템
|
items | array of object | |
|
받는 사람 ID
|
items.recipientId | string |
받는 사람 식별자입니다. |
|
생성됨
|
items.created | string |
만들 때. |
브랜드 가져오기
식별자를 사용하여 특정 브랜드를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
브랜드 ID
|
brand_id | True | string |
브랜드 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
생성됨
|
created | integer |
만들 때. |
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
이름입니다. |
|
출판됨
|
published | integer |
게시할 때. |
|
Updated
|
updated | integer |
업데이트되었습니다. |
|
버전
|
version | string |
버전입니다. |
|
기본
|
settings.colors.primary | string |
주 복제본입니다. |
|
Secondary
|
settings.colors.secondary | string |
보조 복제본입니다. |
|
차
|
settings.colors.tertiary | string |
3차원. |
|
막대 색
|
settings.email.header.barColor | string |
막대 색입니다. |
|
HREF
|
settings.email.header.logo.href | string |
HREF입니다. |
|
이미지
|
settings.email.header.logo.image | string |
이미지입니다. |
|
마크다운
|
settings.email.footer.markdown | string |
markdown입니다. |
|
URL
|
settings.email.footer.social.facebook.url | string |
URL 주소입니다. |
|
URL
|
settings.email.footer.social.instagram.url | string |
URL 주소입니다. |
|
URL
|
settings.email.footer.social.linkedin.url | string |
URL 주소입니다. |
|
URL
|
settings.email.footer.social.medium.url | string |
URL 주소입니다. |
|
URL
|
settings.email.footer.social.twitter.url | string |
URL 주소입니다. |
|
메시지 사용 안 함 아이콘
|
settings.inapp.disableMessageIcon | boolean |
메시지 아이콘을 사용하지 않도록 설정할지 여부입니다. |
|
배치
|
settings.inapp.placement | string |
배치입니다. |
|
아이템
|
snippets.items | array of string |
항목입니다. |
브랜드 나열
브랜드 목록을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
Results
|
results | array of object | |
|
생성됨
|
results.created | integer |
만들 때. |
|
아이디
|
results.id | string |
식별자입니다. |
|
이름
|
results.name | string |
이름입니다. |
|
출판됨
|
results.published | integer |
게시할 때. |
|
Updated
|
results.updated | integer |
업데이트되는 경우. |
|
버전
|
results.version | string |
버전입니다. |
|
기본
|
results.settings.colors.primary | string |
주 복제본입니다. |
|
Secondary
|
results.settings.colors.secondary | string |
보조 복제본입니다. |
|
차
|
results.settings.colors.tertiary | string |
3차원. |
|
막대 색
|
results.settings.email.header.barColor | string |
막대 색입니다. |
|
HREF
|
results.settings.email.header.logo.href | string |
HREF입니다. |
|
이미지
|
results.settings.email.header.logo.image | string |
이미지입니다. |
|
마크다운
|
results.settings.email.footer.markdown | string |
markdown입니다. |
|
URL
|
results.settings.email.footer.social.facebook.url | string |
URL 주소입니다. |
|
URL
|
results.settings.email.footer.social.instagram.url | string |
URL 주소입니다. |
|
URL
|
results.settings.email.footer.social.linkedin.url | string |
URL 주소입니다. |
|
URL
|
results.settings.email.footer.social.medium.url | string |
URL 주소입니다. |
|
URL
|
results.settings.email.footer.social.twitter.url | string |
URL 주소입니다. |
|
메시지 사용 안 함 아이콘
|
results.settings.inapp.disableMessageIcon | boolean |
메시지 아이콘을 사용하지 않도록 설정할지 여부입니다. |
|
배치
|
results.settings.inapp.placement | string |
배치입니다. |
|
아이템
|
results.snippets.items | array of string |
항목입니다. |
브랜드 만들기
제공된 설정에서 새 브랜드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
|
이름
|
name | True | string |
이름입니다. |
|
기본
|
primary | string |
주 복제본입니다. |
|
|
Secondary
|
secondary | string |
보조 복제본입니다. |
|
|
차
|
tertiary | string |
3차원. |
|
|
막대 색
|
barColor | string |
막대 색입니다. |
|
|
HREF
|
href | string |
HREF입니다. |
|
|
이미지
|
image | string |
이미지입니다. |
|
|
마크다운
|
markdown | string |
markdown입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
메시지 사용 안 함 아이콘
|
disableMessageIcon | boolean |
메시지 아이콘을 사용하지 않도록 설정할지 여부입니다. |
|
|
배치
|
placement | string |
배치입니다. |
|
|
아이템
|
items | array of string |
항목입니다. |
반환
- response
- string
알림 나열
알림 목록을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
커서입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
커서입니다. |
|
More
|
paging.more | boolean |
더 많은 것이 있는지 여부. |
|
Results
|
results | array of object | |
|
만든 위치에서
|
results.created_at | integer |
만들 때입니다. |
|
아이디
|
results.id | string |
식별자입니다. |
|
데이터
|
results.tags.data | array of object | |
|
아이디
|
results.tags.data.id | string |
식별자입니다. |
|
이름
|
results.tags.data.name | string |
이름입니다. |
|
제목
|
results.title | string |
제목입니다. |
|
업데이트 날짜
|
results.updated_at | integer |
업데이트 시. |
임시 자동화 실행
임시 실행에서 자동화를 호출합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
취소 토큰
|
cancelation_token | string |
취소 토큰입니다. |
|
|
브랜드
|
brand | string |
브랜드. |
|
|
Template
|
template | string |
템플릿입니다. |
|
|
Recipient
|
recipient | string |
받는 사람입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
실행 ID
|
runId | string |
실행 식별자입니다. |
템플릿 자동화 실행
자동화 템플릿에서 자동화 실행을 호출합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
템플릿 아이디
|
templateId | True | string |
템플릿 식별자입니다. |
|
브랜드
|
brand | string |
브랜드. |
|
|
Template
|
template | string |
템플릿입니다. |
|
|
Recipient
|
recipient | string |
받는 사람입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
실행 ID
|
runId | string |
실행 식별자입니다. |
프로필 가져오기
지정된 받는 사람 프로필을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipient_id | True | string |
받는 사람 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
전자 메일
|
profile.email | string |
전자 메일 주소입니다. |
|
전화 번호
|
profile.phone_number | string |
전화 번호입니다. |
프로필 만들기
제공된 값을 기존 프로필과 병합하거나 아직 없는 경우 새 프로필을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipient_id | True | string |
받는 사람 식별자입니다. |
|
전자 메일
|
string |
전자 메일 주소입니다. |
||
|
전화 번호
|
phone_number | string |
전화 번호입니다. |
|
|
포맷
|
formatted | string |
서식이 지정된 주소입니다. |
|
|
거리 주소
|
street_address | string |
거리 주소입니다. |
|
|
지역
|
locality | string |
지역성입니다. |
|
|
지역
|
region | string |
지역. |
|
|
우편 번호
|
postal_code | string |
우편 번호입니다. |
|
|
국가
|
country | string |
국가입니다. |
|
|
생년월일
|
birthdate | string |
생년월일입니다. |
|
|
전자 메일 확인됨
|
email_verified | boolean |
전자 메일 확인 여부입니다. |
|
|
확인된 전화 번호
|
phone_number_verified | boolean |
전화 번호가 확인되었는지 여부입니다. |
|
|
이름 (주어진 이름)
|
given_name | string |
지정된 이름입니다. |
|
|
중간 이름(Middle Name)
|
middle_name | string |
중간 이름입니다. |
|
|
성
|
family_name | string |
가족 이름입니다. |
|
|
기본 설정 이름
|
preferred_name | string |
기본 설정 이름입니다. |
|
|
성별
|
gender | string |
성별입니다. |
|
|
로케일
|
locale | string |
로캘입니다. |
|
|
그림
|
picture | string |
그림입니다. |
|
|
프로필
|
profile | string |
프로필입니다. |
|
|
하위
|
sub | string |
하위입니다. |
|
|
업데이트 날짜
|
updated_at | string |
업데이트 시. |
|
|
웹 사이트
|
website | string |
웹 사이트입니다. |
|
|
영역 정보
|
zoneinfo | string |
영역 정보입니다. |
|
|
명명된 사용자
|
named_user | string |
명명된 사용자입니다. |
|
|
디바이스 유형
|
device_types | array of string |
디바이스 유형입니다. |
|
|
APN
|
apn | string |
APN입니다. |
|
|
대상 ARN
|
target_arn | string |
대상 ARN입니다. |
|
|
채널 ID
|
channel_id | string |
채널 식별자입니다. |
|
|
사용자 ID
|
user_id | string |
사용자 식별자입니다. |
|
|
토큰
|
token | string |
토큰입니다. |
|
|
Tokens
|
tokens | array of string |
토큰입니다. |
|
|
Facebook PS ID
|
facebookPSID | string |
Facebook PS 식별자입니다. |
|
|
Firebase 토큰
|
firebaseToken | string |
Firebase 토큰입니다. |
|
|
부터
|
from | string |
원본입니다. |
|
|
아이디
|
id | string |
식별자입니다. |
|
|
사용자 ID
|
user_id | string |
사용자 식별자입니다. |
|
|
대화 식별자
|
conversation_id | string |
대화 식별자입니다. |
|
|
임차인 ID
|
tenant_id | string |
테넌트 식별자입니다. |
|
|
서비스 URL
|
service_url | string |
서비스 URL 주소입니다. |
|
|
OneSignal 플레이어 ID
|
oneSignalPlayerID | string |
OneSignal Player 식별자입니다. |
|
|
액세스 토큰
|
access_token | string |
액세스 토큰입니다. |
|
|
채널
|
channel | string |
채널입니다. |
|
|
전자 메일
|
string |
전자 메일 주소입니다. |
||
|
사용자 ID
|
user_id | string |
사용자 식별자입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
URL
|
url | string |
URL 주소입니다. |
|
|
메서드
|
method | string |
메서드입니다. |
|
|
Mode
|
mode | string |
모드입니다. |
|
|
사용자 이름
|
username | string |
사용자 이름입니다. |
|
|
암호
|
password | string |
암호입니다. |
|
|
토큰
|
token | string |
토큰입니다. |
|
|
프로필
|
profile | string |
프로필입니다. |
반환
- response
- string
프로필 삭제
지정된 받는 사람 프로필을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipient_id | True | string |
받는 사람 식별자입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태입니다. |
프로필 업데이트
프로필의 일부를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipient_id | True | string |
받는 사람 식별자입니다. |
|
수술
|
op | string |
작업입니다. |
|
|
경로
|
path | string |
경로입니다. |
|
|
가치
|
value | string |
값입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태입니다. |
정의
문자열
기본 데이터 형식 'string'입니다.
객체
'object' 형식입니다.