다음을 통해 공유


Notification Messages Operations - Send

비즈니스에서 사용자에게 알림 메시지를 보냅니다.

POST {endpoint}/messages/notifications:send?api-version=2024-08-30

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
path True

string

uri

통신 리소스(예: https://my-resource.communication.azure.com

api-version
query True

string

이 작업에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
Repeatability-Request-ID

string

요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

Repeatability-First-Sent

string

date-time

요청이 처음 만들어진 날짜와 시간을 지정합니다.

x-ms-client-request-id

string

uuid

요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

Name Description
AudioNotificationContent

오디오 알림을 보내는 요청입니다.

DocumentNotificationContent

문서 알림을 보내는 요청입니다.

ImageNotificationContent

이미지 알림을 보내는 요청입니다.

MediaNotificationContent

@deprecated 이미지 알림을 보내는 요청입니다.

TemplateNotificationContent

템플릿 알림을 보내는 요청입니다.

TextNotificationContent

텍스트 알림을 보내는 요청입니다.

VideoNotificationContent

비디오 알림을 보내는 요청입니다.

AudioNotificationContent

오디오 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

audio

알림 유형을 설명하는 형식 판별자입니다.

mediaUri True

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

DocumentNotificationContent

문서 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

document

알림 유형을 설명하는 형식 판별자입니다.

mediaUri True

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

caption

string

선택적 텍스트 콘텐츠입니다.

fileName

string

파일의 선택적 이름입니다.

ImageNotificationContent

이미지 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

image

알림 유형을 설명하는 형식 판별자입니다.

mediaUri True

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

caption

string

선택적 텍스트 콘텐츠입니다.

MediaNotificationContent

@deprecated 이미지 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

image_v0

알림 유형을 설명하는 형식 판별자입니다.

mediaUri True

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

content

string

선택적 텍스트 콘텐츠입니다.

TemplateNotificationContent

템플릿 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

template

알림 유형을 설명하는 형식 판별자입니다.

template True

MessageTemplate

템플릿을 만드는 데 사용되는 템플릿 개체입니다.

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

TextNotificationContent

텍스트 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

content True

string

메시지 콘텐츠입니다.

kind True string:

text

알림 유형을 설명하는 형식 판별자입니다.

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

VideoNotificationContent

비디오 알림을 보내는 요청입니다.

Name 필수 형식 Description
channelRegistrationId True

string

비즈니스 식별자의 채널 등록 ID입니다.

kind True string:

video

알림 유형을 설명하는 형식 판별자입니다.

mediaUri True

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to True

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

caption

string

선택적 텍스트 콘텐츠입니다.

응답

Name 형식 Description
202 Accepted

SendMessageResult

처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

헤더

  • Repeatability-Result: string
  • x-ms-client-request-id: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

AadOauth2Auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

Name Description
https://communication.azure.com/.default

Authorization

형식: apiKey
In(다음 안에): header

예제

Sends a notification message - audio
Sends a notification message - document
Sends a notification message - image
Sends a notification message - Template
Sends a notification message - text
Sends a notification message - video

Sends a notification message - audio

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "audio",
  "mediaUri": "https://example.com/audio.mp3"
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - document

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "document",
  "mediaUri": "https://example.com/document.pdf",
  "caption": "check out this document!",
  "fileName": "fileName.pdf"
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - image

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "image",
  "mediaUri": "https://example.com/image.jpg",
  "caption": "check out this image!"
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - Template

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "template",
  "template": {
    "name": "example",
    "language": "en",
    "values": [
      {
        "name": "userName",
        "kind": "text",
        "text": "John Doe"
      },
      {
        "name": "orderNumber",
        "kind": "text",
        "text": "12345"
      }
    ],
    "bindings": {
      "body": [
        {
          "refValue": "userName"
        },
        {
          "refValue": "orderNumber"
        }
      ],
      "kind": "whatsApp"
    }
  }
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - text

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "text",
  "content": "Text message through CPM"
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

Sends a notification message - video

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications:send?api-version=2024-08-30

{
  "channelRegistrationId": "0f0eb78e-a576-1dfc-b414-0f0756de3338",
  "to": [
    "14250000000"
  ],
  "kind": "video",
  "mediaUri": "https://example.com/video.mp4",
  "caption": "check out this video!"
}

샘플 응답

{
  "receipts": [
    {
      "messageId": "320fc2a1-4c4b-4387-9c1a-bd38b57795de",
      "to": "14250000000"
    }
  ]
}

정의

Name Description
AudioNotificationContent

오디오 알림을 보내는 요청입니다.

Azure.Core.Foundations.Error

오류 개체입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

CommunicationMessageKind

메시지의 유형입니다.

DocumentNotificationContent

문서 알림을 보내는 요청입니다.

ImageNotificationContent

이미지 알림을 보내는 요청입니다.

MediaNotificationContent

@deprecated 이미지 알림을 보내는 요청입니다.

MessageReceipt

하나의 메시지를 보내는 것을 수신합니다.

MessageTemplate

템플릿을 만드는 데 사용되는 템플릿 개체입니다.

MessageTemplateBindingsKind

메시지 템플릿의 형식입니다.

MessageTemplateDocument

메시지 템플릿의 문서 값 정보입니다.

MessageTemplateImage

메시지 템플릿의 이미지 값 정보입니다.

MessageTemplateLocation

메시지 템플릿의 위치 값 정보입니다.

MessageTemplateQuickAction

메시지 템플릿의 빠른 작업 값 정보입니다.

MessageTemplateText

메시지 템플릿의 텍스트 값 정보입니다.

MessageTemplateValueKind

템플릿 매개 변수의 형식입니다.

MessageTemplateVideo

메시지 템플릿의 비디오 값 정보입니다.

SendMessageResult

메시지 보내기 작업의 결과입니다.

TemplateNotificationContent

템플릿 알림을 보내는 요청입니다.

TextNotificationContent

텍스트 알림을 보내는 요청입니다.

VideoNotificationContent

비디오 알림을 보내는 요청입니다.

WhatsAppMessageButtonSubType

WhatsApp에 단추 하위 형식입니다.

WhatsAppMessageTemplateBindings

WhatsApp에 대한 템플릿 바인딩

WhatsAppMessageTemplateBindingsButton

WhatsApp에 대한 템플릿 바인딩 구성 요소 단추

WhatsAppMessageTemplateBindingsComponent

WhatsApp에 대한 템플릿 바인딩 구성 요소

AudioNotificationContent

오디오 알림을 보내는 요청입니다.

Name 형식 Description
channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

kind string:

audio

알림 유형을 설명하는 형식 판별자입니다.

mediaUri

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

Azure.Core.Foundations.Error

오류 개체입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.

details

Azure.Core.Foundations.Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.

innererror

Azure.Core.Foundations.InnerError

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

message

string

사람이 읽을 수 있는 오류 표현입니다.

target

string

오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name 형식 Description
error

Azure.Core.Foundations.Error

오류 개체입니다.

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.

innererror

Azure.Core.Foundations.InnerError

내부 오류입니다.

CommunicationMessageKind

메시지의 유형입니다.

Name 형식 Description
audio

string

오디오 메시지 유형입니다.

document

string

문서 메시지 유형입니다.

image

string

이미지 메시지 유형입니다.

image_v0

string

이미지 메시지 유형입니다. 더 이상 사용되지 않는 MediaNotificationContent 대한 레거시 이미지 유형

template

string

템플릿 메시지 유형입니다.

text

string

문자 메시지 유형입니다.

video

string

비디오 메시지 유형입니다.

DocumentNotificationContent

문서 알림을 보내는 요청입니다.

Name 형식 Description
caption

string

선택적 텍스트 콘텐츠입니다.

channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

fileName

string

파일의 선택적 이름입니다.

kind string:

document

알림 유형을 설명하는 형식 판별자입니다.

mediaUri

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

ImageNotificationContent

이미지 알림을 보내는 요청입니다.

Name 형식 Description
caption

string

선택적 텍스트 콘텐츠입니다.

channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

kind string:

image

알림 유형을 설명하는 형식 판별자입니다.

mediaUri

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

MediaNotificationContent

@deprecated 이미지 알림을 보내는 요청입니다.

Name 형식 Description
channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

content

string

선택적 텍스트 콘텐츠입니다.

kind string:

image_v0

알림 유형을 설명하는 형식 판별자입니다.

mediaUri

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

MessageReceipt

하나의 메시지를 보내는 것을 수신합니다.

Name 형식 Description
messageId

string

메시지 ID입니다.

to

string

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

MessageTemplate

템플릿을 만드는 데 사용되는 템플릿 개체입니다.

Name 형식 Description
bindings MessageTemplateBindings:

WhatsAppMessageTemplateBindings

템플릿 특정 위치에 값을 연결할 바인딩 개체입니다.

language

string

ISO 639 형식의 템플릿 언어는 두 글자 언어 코드와 선택적 2자 국가 코드(예: 'en' 또는 'en_US')로 구성됩니다.

name

string

템플릿의 이름입니다.

values MessageTemplateValue[]:

템플릿 값입니다.

MessageTemplateBindingsKind

메시지 템플릿의 형식입니다.

Name 형식 Description
whatsApp

string

WhatsApp 템플릿 형식입니다.

MessageTemplateDocument

메시지 템플릿의 문서 값 정보입니다.

Name 형식 Description
caption

string

미디어 개체의 [선택 사항] 캡션입니다.

fileName

string

미디어 파일의 [선택 사항] 파일 이름입니다.

kind string:

document

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

name

string

템플릿 바인딩 참조 이름

url

string

미디어의 (공개) URL입니다.

MessageTemplateImage

메시지 템플릿의 이미지 값 정보입니다.

Name 형식 Description
caption

string

미디어 개체의 [선택 사항] 캡션입니다.

fileName

string

미디어 파일의 [선택 사항] 파일 이름입니다.

kind string:

image

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

name

string

템플릿 바인딩 참조 이름

url

string

미디어의 (공개) URL입니다.

MessageTemplateLocation

메시지 템플릿의 위치 값 정보입니다.

Name 형식 Description
address

string

위치의 [선택 사항] 주소입니다.

kind string:

location

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

latitude

number

위치의 위도입니다.

locationName

string

위치의 [선택 사항] 이름입니다.

longitude

number

위치의 경도입니다.

name

string

템플릿 바인딩 참조 이름

MessageTemplateQuickAction

메시지 템플릿의 빠른 작업 값 정보입니다.

Name 형식 Description
kind string:

quickAction

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

name

string

템플릿 바인딩 참조 이름

payload

string

[선택 사항] 빠른 작업 페이로드

text

string

[선택 사항] 빠른 작업 텍스트

MessageTemplateText

메시지 템플릿의 텍스트 값 정보입니다.

Name 형식 Description
kind string:

text

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

name

string

템플릿 바인딩 참조 이름

text

string

텍스트 값입니다.

MessageTemplateValueKind

템플릿 매개 변수의 형식입니다.

Name 형식 Description
document

string

문서 템플릿 매개 변수 형식입니다.

image

string

이미지 템플릿 매개 변수 형식입니다.

location

string

위치 템플릿 매개 변수 형식입니다.

quickAction

string

빠른 작업 템플릿 매개 변수 형식입니다.

text

string

텍스트 템플릿 매개 변수 형식입니다.

video

string

비디오 템플릿 매개 변수 형식입니다.

MessageTemplateVideo

메시지 템플릿의 비디오 값 정보입니다.

Name 형식 Description
caption

string

미디어 개체의 [선택 사항] 캡션입니다.

fileName

string

미디어 파일의 [선택 사항] 파일 이름입니다.

kind string:

video

템플릿 매개 변수 형식을 설명하는 형식 판별자입니다.

name

string

템플릿 바인딩 참조 이름

url

string

미디어의 (공개) URL입니다.

SendMessageResult

메시지 보내기 작업의 결과입니다.

Name 형식 Description
receipts

MessageReceipt[]

메시지 보내기 작업의 영수증입니다.

TemplateNotificationContent

템플릿 알림을 보내는 요청입니다.

Name 형식 Description
channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

kind string:

template

알림 유형을 설명하는 형식 판별자입니다.

template

MessageTemplate

템플릿을 만드는 데 사용되는 템플릿 개체입니다.

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

TextNotificationContent

텍스트 알림을 보내는 요청입니다.

Name 형식 Description
channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

content

string

메시지 콘텐츠입니다.

kind string:

text

알림 유형을 설명하는 형식 판별자입니다.

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

VideoNotificationContent

비디오 알림을 보내는 요청입니다.

Name 형식 Description
caption

string

선택적 텍스트 콘텐츠입니다.

channelRegistrationId

string

비즈니스 식별자의 채널 등록 ID입니다.

kind string:

video

알림 유형을 설명하는 형식 판별자입니다.

mediaUri

string

파일의 미디어 URL입니다. 형식이 지원되는 미디어 형식 중 하나인 경우 필수(예: 이미지)

to

string[]

받는 사람의 네이티브 외부 플랫폼 사용자 식별자입니다.

WhatsAppMessageButtonSubType

WhatsApp에 단추 하위 형식입니다.

Name 형식 Description
quickReply

string

WhatsApp에 단추 하위 유형은 빠른 회신입니다.

url

string

WhatsApp에 단추 하위 유형은 URL입니다.

WhatsAppMessageTemplateBindings

WhatsApp에 대한 템플릿 바인딩

Name 형식 Description
body

WhatsAppMessageTemplateBindingsComponent[]

본문 템플릿 바인딩

buttons

WhatsAppMessageTemplateBindingsButton[]

단추 템플릿 바인딩

footer

WhatsAppMessageTemplateBindingsComponent[]

바닥글 템플릿 바인딩

header

WhatsAppMessageTemplateBindingsComponent[]

헤더 템플릿 바인딩

kind string:

whatsApp

템플릿 바인딩 형식을 설명하는 형식 판별자입니다.

WhatsAppMessageTemplateBindingsButton

WhatsApp에 대한 템플릿 바인딩 구성 요소 단추

Name 형식 Description
refValue

string

템플릿 값에서 참조된 항목의 이름입니다.

subType

WhatsAppMessageButtonSubType

WhatsApp에 단추 하위 형식

WhatsAppMessageTemplateBindingsComponent

WhatsApp에 대한 템플릿 바인딩 구성 요소

Name 형식 Description
refValue

string

템플릿 값에서 참조된 항목의 이름입니다.