Notification Messages - Send Message

서비스:
Communication
API 버전:
2023-08-24-preview 
POST {endpoint}/messages/notifications/:send?api-version=2023-08-24-preview

URI 매개 변수

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

string (url)

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

string

호출할 API의 버전입니다.

요청 본문

Name 필수 형식 Description
channelRegistrationId True

string

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

string[]

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

CommunicationMessageType

메시지의 유형입니다. 텍스트, 이미지, 템플릿을 지원합니다.
content

string

메시지 콘텐츠입니다.
mediaUri

string

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

MessageTemplate

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

응답

Name 형식 Description
202 Accepted

SendMessageResult

허용
Other Status Codes

CommunicationErrorResponse

통신 오류 응답

예제

Send a notification message

샘플 요청

POST https://my-resource.communication.azure.com/messages/notifications/:send?api-version=2023-08-24-preview

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

샘플 응답

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

정의

Name Description
CommunicationMessageType

메시지의 유형입니다. 텍스트, 이미지, 템플릿을 지원합니다.
MessageReceipt

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

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

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

WhatsApp에 대한 템플릿 바인딩
MessageTemplateBindingsWhatsAppButton

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

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

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

클래스는 템플릿의 매개 변수를 설명합니다.
MessageTemplateValueKind

템플릿 값 종류입니다.
MessageTemplateValueMedia

메시지 템플릿의 미디어 값 정보입니다. 이미지, 문서 또는 비디오일 수 있습니다.
MessageTemplateValueQuickAction

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

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

WhatsApp에 단추 하위 형식
SendMessageResult

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

보낼 메시지의 세부 정보입니다.

CommunicationMessageType

열거형

메시지의 유형입니다. 텍스트, 이미지, 템플릿을 지원합니다.

값 Description
text
image
template

MessageReceipt

Object

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

Name 형식 Description
messageId

string

메시지 ID입니다.
to

string

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

MessageTemplate

Object

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

Name 형식 Description
bindings

MessageTemplateBindings

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

string

템플릿에 대해 지원되는 언어에 대한 코드입니다.
name

string

템플릿의 이름입니다.
values

<string,  MessageTemplateValue>

템플릿 값입니다.

MessageTemplateBindings

Object

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

Name 형식 Description
whatsApp

MessageTemplateBindingsWhatsApp

WhatsApp에 대한 템플릿 바인딩

MessageTemplateBindingsWhatsApp

Object

WhatsApp에 대한 템플릿 바인딩

Name 형식 Description
body

MessageTemplateBindingsWhatsAppComponent[]

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

MessageTemplateBindingsWhatsAppButton[]

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

MessageTemplateBindingsWhatsAppComponent[]

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

MessageTemplateBindingsWhatsAppComponent[]

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

MessageTemplateBindingsWhatsAppButton

Object

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

Name 형식 Description
refValue

string

Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values 사전의 값에 대한 참조입니다.
subType

MessageTemplateValueWhatsAppSubType

WhatsApp에 단추 하위 형식

MessageTemplateBindingsWhatsAppComponent

Object

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

Name 형식 Description
refValue

string

Microsoft.Azure.Communication.CrossPlatformMessages.Contract.Model.Notifications.V1.Requests.MessageTemplate.Values 사전의 값에 대한 참조입니다.

MessageTemplateParameterLocation

Object

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

Name 형식 Description
address

string

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

number (double)

위치의 위도입니다.
longitude

number (double)

위치의 경도입니다.
name

string

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

MessageTemplateValue

Object

클래스는 템플릿의 매개 변수를 설명합니다.

Name 형식 Description
document

MessageTemplateValueMedia

메시지 템플릿의 미디어 값 정보입니다. 이미지, 문서 또는 비디오일 수 있습니다.
image

MessageTemplateValueMedia

메시지 템플릿의 미디어 값 정보입니다. 이미지, 문서 또는 비디오일 수 있습니다.
kind

MessageTemplateValueKind

템플릿 값 종류입니다.
location

MessageTemplateParameterLocation

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

MessageTemplateValueQuickAction

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

MessageTemplateValueText

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

MessageTemplateValueMedia

메시지 템플릿의 미디어 값 정보입니다. 이미지, 문서 또는 비디오일 수 있습니다.

MessageTemplateValueKind

열거형

템플릿 값 종류입니다.

값 Description
text
image
document
video
location
quick_action

MessageTemplateValueMedia

Object

메시지 템플릿의 미디어 값 정보입니다. 이미지, 문서 또는 비디오일 수 있습니다.

Name 형식 Description
caption

string

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

string

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

string (uri)

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

MessageTemplateValueQuickAction

Object

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

Name 형식 Description
payload

string

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

string

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

MessageTemplateValueText

Object

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

Name 형식 Description
text

string

텍스트 값입니다.

MessageTemplateValueWhatsAppSubType

열거형

WhatsApp에 단추 하위 형식

값 Description
quickReply
url

SendMessageResult

Object

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

Name 형식 Description
receipts

MessageReceipt[]

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

SendNotificationRequest

Object

보낼 메시지의 세부 정보입니다.

Name 형식 Description
channelRegistrationId

string

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

string

메시지 콘텐츠입니다.
mediaUri

string

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

MessageTemplate

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

string[]

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

CommunicationMessageType

메시지의 유형입니다. 텍스트, 이미지, 템플릿을 지원합니다.