Nexmo
Vonage API 플랫폼인 Nexmo를 사용하면 SMS, 음성 및 채팅을 비롯한 애플리케이션 컨텍스트 내에서 통신을 추가할 수 있습니다. 여기에서 Nexmo 계정에 등록합니다. https://www.nexmo.com/
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 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) |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Microsoft |
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| API 키 | 문자열 | API 키 | 진실 |
| API 비밀 | 시큐어스트링 (보안 문자열) | API 비밀 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| ID로 애플리케이션 가져오기 |
이 작업은 ID가 지정된 단일 애플리케이션에 대한 정보를 검색하는 데 사용됩니다. |
| SMS 보내기 |
이 작업은 SMS를 보내는 데 사용됩니다. |
| 새 애플리케이션 만들기 |
이 작업은 계정에 새 애플리케이션을 만드는 데 사용됩니다. |
| 소유 번호 나열 |
이 작업은 계정과 연결된 모든 숫자를 검색합니다. |
| 애플리케이션 나열 |
계정과 연결된 모든 애플리케이션의 목록을 검색합니다. |
| 애플리케이션 삭제 |
이 작업은 계정에서 기존 애플리케이션을 삭제하는 데 사용됩니다. |
| 애플리케이션 업데이트 |
이 작업은 계정에서 기존 애플리케이션을 수정하는 데 사용됩니다. |
| 음성 파일 보내기 |
이 작업은 합성된 음성 또는 녹음된 사운드 파일을 전화 번호로 보내는 데 사용됩니다. |
| 인바운드 번호 나열 |
이 작업은 지정된 국가에 대해 avialble인 모든 인바운드 번호를 검색하는 데 사용됩니다. |
ID로 애플리케이션 가져오기
이 작업은 ID가 지정된 단일 애플리케이션에 대한 정보를 검색하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
애플리케이션 ID
|
application_id | True | string |
애플리케이션의 고유 식별자입니다. |
반환
SMS 보내기
이 작업은 SMS를 보내는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
보낸 사람 ID
|
from | True | string |
영숫자 문자열입니다. |
|
전화 번호로
|
to | True | string |
국제 형식 E.164. |
|
문자 메시지
|
text | True | string |
SMS 본문입니다. |
|
유형
|
type | string |
기본값은 텍스트입니다. |
|
|
배달 확인
|
status-report-req | number |
사용하도록 설정하려면 1로 설정합니다. |
|
|
클라이언트 참조
|
client-ref | string |
내부 보고의 경우 |
|
|
명함
|
vcard | string |
vCard 형식입니다. |
|
|
일정 이벤트
|
vcal | string |
vCal 형식입니다. |
|
|
SMS의 수명
|
ttl | number |
밀리초 단위입니다. |
|
|
콜백 URL
|
callback | url |
배달 확인 엔드포인트입니다. |
|
|
메시지 클래스
|
message-class | number |
클래스를 선택합니다. |
|
|
사용자 데이터 헤더
|
udh | string |
16진수로 인코딩된 UDH입니다. |
|
|
상위 수준 프로토콜
|
protocol-id | string |
프로토콜 ID입니다. |
|
|
본문(형식이 이진인 경우)
|
body | string |
16진수 인코딩된 이진 데이터입니다. |
|
|
제목
|
title | string |
wappush 형식인 경우 |
|
|
웹 주소
|
url | url |
웹 사이트 URL(형식이 wappush인 경우). |
|
|
가용성(형식이 wappush인 경우)
|
validity | string |
밀리초 단위입니다. |
반환
새 애플리케이션 만들기
이 작업은 계정에 새 애플리케이션을 만드는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
애플리케이션의 이름입니다. |
|
유형
|
type | True | string |
애플리케이션의 유형입니다. |
|
답변 URL
|
answer_url | True | string |
웹후크가 Nexmo Call Control 개체를 제공하는 위치입니다. |
|
이벤트 URL
|
event_url | True | string |
시작, 울림 또는 완료 |
|
Answer 메서드
|
answer_method | string |
HTTP 메서드(기본 GET). |
|
|
Event 메서드
|
event_method | string |
HTTP 메서드(기본 POST). |
반환
소유 번호 나열
이 작업은 계정과 연결된 모든 숫자를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
검색 패턴
|
Search Pattern | string |
패턴을 선택합니다. |
|
|
페이지 인덱스
|
index | number |
응답의 인덱스입니다. |
|
|
결과 수
|
size | number |
기본값은 최대 100입니다. |
|
|
패턴
|
pattern | number |
검색할 숫자 패턴입니다. |
반환
애플리케이션 나열
계정과 연결된 모든 애플리케이션의 목록을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
결과 수
|
page_size | number |
각 호출에서 반환되는 항목(기본값 10). |
|
|
페이지 인덱스
|
page_index | number |
첫 번째 페이지의 오프셋(기본값 0)입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
애플리케이션 삭제
이 작업은 계정에서 기존 애플리케이션을 삭제하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
애플리케이션 ID
|
application_id | True | string |
애플리케이션의 고유 식별자입니다. |
반환
- 몸
- common
애플리케이션 업데이트
이 작업은 계정에서 기존 애플리케이션을 수정하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
애플리케이션 ID
|
application_id | True | string |
애플리케이션의 고유 식별자입니다. |
|
이름
|
name | True | string |
애플리케이션의 이름입니다. |
|
유형
|
type | True | string |
애플리케이션의 유형입니다. |
|
답변 URL
|
answer_url | True | string |
웹후크가 Nexmo Call Control 개체를 제공하는 위치입니다. |
|
이벤트 URL
|
event_url | True | string |
시작, 울림 또는 완료 |
|
Answer 메서드
|
answer_method | string |
HTTP 메서드(기본 GET). |
|
|
Event 메서드
|
event_method | string |
HTTP 메서드(기본 POST). |
반환
음성 파일 보내기
이 작업은 합성된 음성 또는 녹음된 사운드 파일을 전화 번호로 보내는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
전화 번호로
|
to | True | string |
국제 형식 E.164. |
|
전화 번호에서
|
from | string |
음성 지원 Nexmo 번호입니다. |
|
|
Message
|
text | True | string |
음성 텍스트입니다. |
|
Language
|
lg | string |
메시지를 합성하려면 |
|
|
성별
|
voice | string |
남성 또는 여성. |
|
|
반복 횟수
|
repeat | number |
최대 10회. |
|
|
머신 검색 허용
|
machine_detection | string |
True 또는 hangup입니다. |
|
|
컴퓨터 시간 제한
|
machine_timeout | number |
400ms ~ 10000ms. |
|
|
콜백 URL
|
callback | url |
콜백의 URL입니다. |
|
|
콜백 메서드
|
callback_method | string |
GET 또는 POST. |
반환
인바운드 번호 나열
이 작업은 지정된 국가에 대해 avialble인 모든 인바운드 번호를 검색하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
국가
|
country | True | string |
ISO 3166-1 alpha-2 형식의 코드입니다. |
|
검색 패턴
|
Search Pattern | string |
패턴을 선택합니다. |
|
|
패턴
|
pattern | number |
검색할 숫자 패턴입니다. |
|
|
사용 가능한 기능
|
features | string |
SMS 또는 음성 |
|
|
결과 수
|
size | number |
기본값은 10입니다. |
|
|
페이지 인덱스
|
index | number |
응답의 인덱스입니다. |
반환
정의
smsResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메시지 수
|
message-count | string |
메시지가 분할된 부분의 수입니다. |
|
메시지 배열
|
messages | array of object |
각 메시지 부분을 포함합니다. |
|
상태
|
messages.status | string |
SMS 보내기가 처리되는 방법을 보여 드립니다. |
|
메시지 ID
|
messages.message-id | string |
제출된 SMS의 ID(8~16자)입니다. |
|
전화 번호로
|
messages.to | string |
요청이 전송된 번호입니다. |
|
클라이언트 참조
|
messages.client-ref | string |
요청에 설정한 client-ref입니다. |
|
잔여 잔액
|
messages.remaining-balance | string |
계정에서 잔액을 조정합니다. 값은 EUR입니다. |
|
메시지 가격
|
messages.message-price | string |
요청에 대해 청구되는 금액입니다. 값은 EUR입니다. |
|
네트워크
|
messages.network | string |
등록된 이동 통신 사업자에 대한 MCCMNC(Mobile Country Code Mobile Network Code)입니다. |
|
오류 텍스트
|
messages.error-text | string |
오류가 발생한 경우 어떤 일이 발생했는지 설명합니다. |
ListNumbersResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
결과 수입니다. |
|
숫자 배열
|
numbers | array of object |
모든 숫자 목록입니다. |
|
비용
|
numbers.cost | string |
숫자 비용입니다. |
|
국가
|
numbers.country | string |
ISO 3166-1 alpha-2 형식입니다. |
|
인바운드 번호
|
numbers.msisdn | string |
인바운드 가상 번호입니다. |
|
유형
|
numbers.type | string |
숫자의 형식입니다. |
ttsResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
통화 ID
|
call_id | string |
이 호출에 대한 고유한 영숫자 32자 ID입니다. |
|
전화 번호로
|
to | string |
TTS 또는 TTS 프롬프트를 보낸 사용자 수입니다. |
|
상태
|
status | string |
이 TTS 또는 TTS 프롬프트에 대한 응답 코드입니다. |
|
오류 텍스트
|
error_text | string |
오류가 발생한 경우 어떤 일이 발생했는지 설명합니다. |
applicationResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
Nexmo 애플리케이션 ID입니다. |
|
이름
|
name | string |
애플리케이션 이름. |
|
Keys
|
keys.public_key | string |
에서 jwt의 유효성을 검사하는 데 사용되는 공개 키입니다 https://en.wikipedia.org/wiki/JSON_Web_Token. |
보통의
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
응답
|
type | string |
사람이 읽을 수 있는 메시지입니다. |
|
오류 텍스트
|
error_title | string |
실패하면 오류 제목이 반환됩니다. |