Notification Messages Operations - Send

リファレンス

サービス:: Communication

API バージョン:: 2024-08-30

Business からユーザーに通知メッセージを送信します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	通信リソース (例: https://my-resource.communication.azure.com
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	型	説明
Repeatability-Request-ID	string	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。
Repeatability-First-Sent	string date-time	要求が最初に作成された日時を指定します。
x-ms-client-request-id	string uuid	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

要求本文は、次のいずれかの可能性があります。

名前	説明
AudioNotificationContent	オーディオ通知を送信する要求。
DocumentNotificationContent	ドキュメント通知を送信する要求。
ImageNotificationContent	イメージ通知を送信する要求。
MediaNotificationContent	@deprecated イメージ通知を送信する要求。
TemplateNotificationContent	テンプレート通知を送信する要求。
TextNotificationContent	テキスト通知を送信する要求。
VideoNotificationContent	ビデオ通知を送信する要求。

AudioNotificationContent

オーディオ通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: audio	通知の種類を記述する型識別子。
mediaUri	True	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

DocumentNotificationContent

ドキュメント通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: document	通知の種類を記述する型識別子。
mediaUri	True	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。
caption		string	省略可能なテキストコンテンツ。
fileName		string	ファイルの省略可能な名前。

ImageNotificationContent

イメージ通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: image	通知の種類を記述する型識別子。
mediaUri	True	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。
caption		string	省略可能なテキストコンテンツ。

MediaNotificationContent

@deprecated イメージ通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: image_v0	通知の種類を記述する型識別子。
mediaUri	True	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。
content		string	省略可能なテキストコンテンツ。

TemplateNotificationContent

テンプレート通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: template	通知の種類を記述する型識別子。
template	True	MessageTemplate	テンプレートの作成に使用するテンプレートオブジェクト。
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

TextNotificationContent

テキスト通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
content	True	string	メッセージの内容。
kind	True	string: text	通知の種類を記述する型識別子。
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

VideoNotificationContent

ビデオ通知を送信する要求。

名前	必須	型	説明
channelRegistrationId	True	string	ビジネス識別子のチャネル登録 ID。
kind	True	string: video	通知の種類を記述する型識別子。
mediaUri	True	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	True	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。
caption		string	省略可能なテキストコンテンツ。

応答

名前	型	説明
202 Accepted	SendMessageResult	要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー Repeatability-Result: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

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
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://communication.azure.com/.default

Authorization

型: apiKey
/: 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

要求のサンプル

HTTP

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"
}

応答のサンプル

状態コード:: 202

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

Sends a notification message - document

要求のサンプル

HTTP

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"
}

応答のサンプル

状態コード:: 202

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

Sends a notification message - image

要求のサンプル

HTTP

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!"
}

応答のサンプル

状態コード:: 202

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

Sends a notification message - Template

要求のサンプル

HTTP

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"
    }
  }
}

応答のサンプル

状態コード:: 202

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

Sends a notification message - text

要求のサンプル

HTTP

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"
}

応答のサンプル

状態コード:: 202

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

Sends a notification message - video

要求のサンプル

HTTP

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!"
}

応答のサンプル

状態コード:: 202

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

定義

名前	説明
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	1 つのメッセージを送信したメッセージの受信。
MessageTemplate	テンプレートの作成に使用するテンプレートオブジェクト。
MessageTemplateBindingsKind	メッセージテンプレートの型。
MessageTemplateDocument	メッセージテンプレートのドキュメント値情報。
MessageTemplateImage	メッセージテンプレートの画像値情報。
MessageTemplateLocation	メッセージテンプレートの場所の値情報。
MessageTemplateQuickAction	メッセージテンプレートのクイックアクション値情報。
MessageTemplateText	メッセージテンプレートのテキスト値情報。
MessageTemplateValueKind	テンプレートパラメーターの型。
MessageTemplateVideo	メッセージテンプレートのビデオ値情報。
SendMessageResult	メッセージ送信操作の結果。
TemplateNotificationContent	テンプレート通知を送信する要求。
TextNotificationContent	テキスト通知を送信する要求。
VideoNotificationContent	ビデオ通知を送信する要求。
WhatsAppMessageButtonSubType	WhatsApp ボタンのサブタイプ。
WhatsAppMessageTemplateBindings	WhatsApp のテンプレートバインド
WhatsAppMessageTemplateBindingsButton	WhatsApp のテンプレートバインドコンポーネントボタン
WhatsAppMessageTemplateBindingsComponent	WhatsApp のテンプレートバインドコンポーネント

AudioNotificationContent

オーディオ通知を送信する要求。

名前	型	説明
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
kind	string: audio	通知の種類を記述する型識別子。
mediaUri	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

Azure.Core.Foundations.Error

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前	型	説明
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.

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

CommunicationMessageKind

メッセージの種類。

名前	型	説明
audio	string	オーディオメッセージの種類。
document	string	ドキュメントメッセージの種類。
image	string	イメージメッセージの種類。
image_v0	string	イメージメッセージの種類。非推奨となる `MediaNotificationContent` のレガシイメージの種類
template	string	テンプレートメッセージの種類。
text	string	テキストメッセージの種類。
video	string	ビデオメッセージの種類。

DocumentNotificationContent

ドキュメント通知を送信する要求。

名前	型	説明
caption	string	省略可能なテキストコンテンツ。
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
fileName	string	ファイルの省略可能な名前。
kind	string: document	通知の種類を記述する型識別子。
mediaUri	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

ImageNotificationContent

イメージ通知を送信する要求。

名前	型	説明
caption	string	省略可能なテキストコンテンツ。
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
kind	string: image	通知の種類を記述する型識別子。
mediaUri	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

MediaNotificationContent

@deprecated イメージ通知を送信する要求。

名前	型	説明
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
content	string	省略可能なテキストコンテンツ。
kind	string: image_v0	通知の種類を記述する型識別子。
mediaUri	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

MessageReceipt

1 つのメッセージを送信したメッセージの受信。

名前	型	説明
messageId	string	メッセージ ID。
to	string	受信者のネイティブ外部プラットフォームユーザー識別子。

MessageTemplate

テンプレートの作成に使用するテンプレートオブジェクト。

名前	型	説明
bindings	MessageTemplateBindings: WhatsAppMessageTemplateBindings	テンプレート固有の場所に値をリンクするバインディングオブジェクト
language	string	テンプレートの言語 (ISO 639 形式) は、2 文字の言語コードの後にオプションの 2 文字の国コード (例: 'en' や 'en_US' で構成されます。
name	string	テンプレートの名前。
values	MessageTemplateValue[]: MessageTemplateDocument[] MessageTemplateImage[] MessageTemplateLocation[] MessageTemplateQuickAction[] MessageTemplateText[] MessageTemplateVideo[]	テンプレート値。

MessageTemplateBindingsKind

メッセージテンプレートの型。

名前	型	説明
whatsApp	string	WhatsApp テンプレートの種類。

MessageTemplateDocument

メッセージテンプレートのドキュメント値情報。

名前	型	説明
caption	string	メディアオブジェクトの [省略可能] キャプション。
fileName	string	メディアファイルの [省略可能] ファイル名。
kind	string: document	テンプレートパラメーター型を記述する型識別子。
name	string	テンプレートバインド参照名
url	string	メディアの (パブリック) URL。

MessageTemplateImage

メッセージテンプレートの画像値情報。

名前	型	説明
caption	string	メディアオブジェクトの [省略可能] キャプション。
fileName	string	メディアファイルの [省略可能] ファイル名。
kind	string: image	テンプレートパラメーター型を記述する型識別子。
name	string	テンプレートバインド参照名
url	string	メディアの (パブリック) URL。

MessageTemplateLocation

メッセージテンプレートの場所の値情報。

名前	型	説明
address	string	場所の [省略可能] アドレス。
kind	string: location	テンプレートパラメーター型を記述する型識別子。
latitude	number	場所の緯度。
locationName	string	場所の [省略可能] 名。
longitude	number	場所の経度。
name	string	テンプレートバインド参照名

MessageTemplateQuickAction

メッセージテンプレートのクイックアクション値情報。

名前	型	説明
kind	string: quickAction	テンプレートパラメーター型を記述する型識別子。
name	string	テンプレートバインド参照名
payload	string	[省略可能] クイックアクションペイロード
text	string	[省略可能] クイックアクションテキスト

MessageTemplateText

メッセージテンプレートのテキスト値情報。

名前	型	説明
kind	string: text	テンプレートパラメーター型を記述する型識別子。
name	string	テンプレートバインド参照名
text	string	テキスト値。

MessageTemplateValueKind

テンプレートパラメーターの型。

名前	型	説明
document	string	ドキュメントテンプレートのパラメーター型。
image	string	イメージテンプレートのパラメーター型。
location	string	場所テンプレートのパラメーター型。
quickAction	string	クイックアクションテンプレートのパラメーターの種類。
text	string	テキストテンプレートのパラメーター型。
video	string	ビデオテンプレートのパラメーターの種類。

MessageTemplateVideo

メッセージテンプレートのビデオ値情報。

名前	型	説明
caption	string	メディアオブジェクトの [省略可能] キャプション。
fileName	string	メディアファイルの [省略可能] ファイル名。
kind	string: video	テンプレートパラメーター型を記述する型識別子。
name	string	テンプレートバインド参照名
url	string	メディアの (パブリック) URL。

SendMessageResult

メッセージ送信操作の結果。

名前	型	説明
receipts	MessageReceipt[]	メッセージ送信操作の受信確認。

TemplateNotificationContent

テンプレート通知を送信する要求。

名前	型	説明
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
kind	string: template	通知の種類を記述する型識別子。
template	MessageTemplate	テンプレートの作成に使用するテンプレートオブジェクト。
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

TextNotificationContent

テキスト通知を送信する要求。

名前	型	説明
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
content	string	メッセージの内容。
kind	string: text	通知の種類を記述する型識別子。
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

VideoNotificationContent

ビデオ通知を送信する要求。

名前	型	説明
caption	string	省略可能なテキストコンテンツ。
channelRegistrationId	string	ビジネス識別子のチャネル登録 ID。
kind	string: video	通知の種類を記述する型識別子。
mediaUri	string	ファイルのメディア URL。種類がサポートされているメディアの種類の 1 つである場合に必要です (例: image
to	string[]	受信者のネイティブ外部プラットフォームユーザー識別子。

WhatsAppMessageButtonSubType

WhatsApp ボタンのサブタイプ。

名前	型	説明
quickReply	string	WhatsApp ボタンのサブタイプは、クイック応答です。
url	string	WhatsApp ボタンのサブタイプは URL です。

WhatsAppMessageTemplateBindings

WhatsApp のテンプレートバインド

名前	型	説明
body	WhatsAppMessageTemplateBindingsComponent[]	本文テンプレートのバインド
buttons	WhatsAppMessageTemplateBindingsButton[]	ボタンテンプレートのバインド
footer	WhatsAppMessageTemplateBindingsComponent[]	フッターテンプレートのバインド
header	WhatsAppMessageTemplateBindingsComponent[]	ヘッダーテンプレートのバインド
kind	string: whatsApp	テンプレートバインド型を記述する型識別子。

WhatsAppMessageTemplateBindingsButton

WhatsApp のテンプレートバインドコンポーネントボタン

名前	型	説明
refValue	string	テンプレート値内の参照先アイテムの名前。
subType	WhatsAppMessageButtonSubType	WhatsApp ボタンのサブタイプ

WhatsAppMessageTemplateBindingsComponent

WhatsApp のテンプレートバインドコンポーネント

名前	型	説明
refValue	string	テンプレート値内の参照先アイテムの名前。

次の方法で共有

Notification Messages Operations - Send

URI パラメーター

要求ヘッダー

要求本文

AudioNotificationContent

DocumentNotificationContent

ImageNotificationContent

MediaNotificationContent

TemplateNotificationContent

TextNotificationContent

VideoNotificationContent

応答

セキュリティ

AadOauth2Auth

スコープ

Authorization

例

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

要求のサンプル

応答のサンプル

定義

AudioNotificationContent

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CommunicationMessageKind

DocumentNotificationContent

ImageNotificationContent

MediaNotificationContent

MessageReceipt

MessageTemplate

MessageTemplateBindingsKind

MessageTemplateDocument

MessageTemplateImage

MessageTemplateLocation

MessageTemplateQuickAction

MessageTemplateText

MessageTemplateValueKind

MessageTemplateVideo

SendMessageResult

TemplateNotificationContent

TextNotificationContent

VideoNotificationContent

WhatsAppMessageButtonSubType

WhatsAppMessageTemplateBindings

WhatsAppMessageTemplateBindingsButton

WhatsAppMessageTemplateBindingsComponent

その他のリソース